Skip to main content

griffin init

Initialize Griffin in the current directory. Creates a griffin.json config file.
griffin init
griffin init --project my-api
OptionDescription
--project <name>Project ID (defaults to package.json name or directory name)

griffin validate

Check monitor files for errors without running them.
griffin validate

griffin status

Show the current project, hub connection, and environment configuration.
griffin status

griffin test

Run monitors locally against their configured endpoints. Useful for validating tests during development.
griffin test              # Default environment
griffin test production   # Specific environment
ArgumentDescription
[env]Environment name (optional, defaults to default)

griffin plan

Preview what changes would be applied to the hub. Shows which monitors will be created, updated, or remain unchanged.
griffin plan              # Default environment
griffin plan production   # Specific environment
griffin plan --json       # JSON output
OptionDescription
--jsonOutput in JSON format
Exits with code 2 if there are pending changes (useful for CI/CD).

griffin apply

Push monitor changes to the hub.
griffin apply
griffin apply production
griffin apply --auto-approve
griffin apply production --prune
OptionDescription
--auto-approveSkip the confirmation prompt
--dry-runShow what would be done without making changes
--pruneDelete monitors on the hub that don’t exist locally

griffin run

Trigger a specific monitor to run immediately.
griffin run --monitor health-check
griffin run production --monitor health-check --wait
OptionDescription
--monitor <name>Monitor name to run (required)
--waitWait for the run to complete and show results
--forceRun even if the local monitor differs from the hub

griffin runs

List recent monitor runs.
griffin runs
griffin runs production
griffin runs --monitor health-check --limit 20
OptionDescription
--monitor <name>Filter by monitor name
--limit <n>Number of runs to show (default: 10)

griffin metrics

Show monitor metrics summary.
griffin metrics
griffin metrics production
griffin metrics --period 7d --json
OptionDescription
--period <period>Time window: 1h, 6h, 24h, 7d, 30d (default: 24h)
--jsonOutput as JSON