Installation
Requirements
- Node.js 20+
- pnpm, npm, or yarn
Install
pnpm install @freshguard/freshguard-core
Or with npm:
npm install @freshguard/freshguard-core
Verify
import { checkFreshness, PostgresConnector } from '@freshguard/freshguard-core';
console.log('FreshGuard Core installed successfully');
What's included
The package exports:
| Category | Exports |
|---|---|
| Monitoring | checkFreshness, checkVolumeAnomaly, checkSchemaChanges |
| Connectors | PostgresConnector, DuckDBConnector, BigQueryConnector, SnowflakeConnector, MySQLConnector, RedshiftConnector, MSSQLConnector, AzureSQLConnector, SynapseConnector |
| Metadata | createMetadataStorage, DuckDBMetadataStorage, PostgreSQLMetadataStorage |
| Errors | SecurityError, ConnectionError, TimeoutError, QueryError, ConfigurationError, MonitoringError |
| Types | MonitoringRule, CheckResult, DataSource, FreshGuardConfig, and more |
CLI
The package includes a freshguard CLI binary:
pnpm exec freshguard --help