@griffin-app/griffin-cli 1.0.6 → 1.0.7

package/README.md

@@ -6,9 +6,9 @@ Command-line interface for managing API monitoring tests as code.
 
 Griffin CLI enables monitoring-as-code with support for both local test execution and hub-based orchestration. It provides a declarative workflow:
 
-1. Write test plans in TypeScript/JavaScript
+1. Write test monitors in TypeScript/JavaScript
 2. Run tests locally against configured targets
-3. Preview changes with `griffin hub plan`
+3. Preview changes with `griffin hub monitor`
 4. Apply changes to hub with `griffin hub apply`
 5. Monitor execution with `griffin hub runs`
 
@@ -30,7 +30,7 @@ This creates `.griffin/state.json` which tracks:
 
 - Project ID (auto-detected from package.json or directory name)
 - Environment configurations with their targets
-- Synced plan state
+- Synced monitor state
 - Hub connection settings (optional)
 
 Override project ID with `--project <name>`.
@@ -43,9 +43,9 @@ View configured environments:
 griffin env list
 ```
 
-### 3. Create Test Plans
+### 3. Create Test Monitors
 
-Create test files in `__griffin__/` directories. These files export test plans that can be run locally or synced to the hub.
+Create test files in `__griffin__/` directories. These files export test monitors that can be run locally or synced to the hub.
 
 ### 4. Run Tests Locally
 
@@ -64,8 +64,8 @@ griffin hub connect --url https://hub.example.com --token <token>
 ### 6. Preview Hub Changes
 
 ```bash
-griffin hub plan
-griffin hub plan production
+griffin hub monitor
+griffin hub monitor production
 ```
 
 Shows what will be created, updated, or deleted on the hub for the specified environment.
@@ -77,15 +77,15 @@ griffin hub apply
 griffin hub apply production
 ```
 
-Syncs plans to the hub for the specified environment.
+Syncs monitors to the hub for the specified environment.
 
 ### 8. Trigger Hub Run
 
 ```bash
-griffin hub run production --plan <name>
+griffin hub run production --monitor <name>
 ```
 
-Triggers a plan execution on the hub in the specified environment.
+Triggers a monitor execution on the hub in the specified environment.
 
 ## Commands
 
@@ -94,7 +94,7 @@ Commands are organized into four groups:
 - **Top-level**: Project initialization and utilities
 - **env**: Environment management
 - **local**: Local test execution
-- **hub**: Hub operations (plan sync, remote execution)
+- **hub**: Hub operations (monitor sync, remote execution)
 
 ### Top-Level Commands
 
@@ -115,7 +115,7 @@ griffin init --project my-service
 
 #### `griffin validate`
 
-Validate test plan files without syncing.
+Validate test monitor files without syncing.
 
 **Example:**
 
@@ -222,17 +222,17 @@ Show recent runs from the hub.
 
 **Options:**
 
-- `--plan <name>` - Filter by plan name
+- `--monitor <name>` - Filter by monitor name
 - `--limit <number>` - Number of runs to show (default: 10)
 
 **Example:**
 
 ```bash
 griffin hub runs
-griffin hub runs --plan health-check --limit 5
+griffin hub runs --monitor health-check --limit 5
 ```
 
-#### `griffin hub plan [env]`
+#### `griffin hub monitor [env]`
 
 Show what changes would be applied to the hub. Environment can be specified as a positional argument, or uses the default environment if omitted.
 
@@ -243,9 +243,9 @@ Show what changes would be applied to the hub. Environment can be specified as a
 **Example:**
 
 ```bash
-griffin hub plan
-griffin hub plan production
-griffin hub plan staging --json
+griffin hub monitor
+griffin hub monitor production
+griffin hub monitor staging --json
 ```
 
 **Exit codes:**
@@ -262,7 +262,7 @@ Apply changes to the hub. Environment can be specified as a positional argument,
 
 - `--auto-approve` - Skip confirmation prompt
 - `--dry-run` - Show what would be done without making changes
-- `--prune` - Delete plans on hub that don't exist locally
+- `--prune` - Delete monitors on hub that don't exist locally
 
 **Example:**
 
@@ -275,20 +275,20 @@ griffin hub apply production --prune
 
 #### `griffin hub run <env>`
 
-Trigger a plan run on the hub in the specified environment.
+Trigger a monitor run on the hub in the specified environment.
 
 **Options:**
 
-- `--plan <name>` - Plan name to run (required)
+- `--monitor <name>` - Monitor name to run (required)
 - `--wait` - Wait for run to complete
-- `--force` - Run even if local plan differs from hub
+- `--force` - Run even if local monitor differs from hub
 
 **Example:**
 
 ```bash
-griffin hub run production --plan health-check
-griffin hub run staging --plan health-check --wait
-griffin hub run production --plan api-check --force
+griffin hub run production --monitor health-check
+griffin hub run staging --monitor health-check --wait
+griffin hub run production --monitor api-check --force
 ```
 
 ## Configuration
@@ -375,22 +375,22 @@ griffin local run staging
 griffin hub apply production
 ```
 
-## Test Plan Discovery
+## Test Monitor Discovery
 
-By default, Griffin discovers test plans from files in `__griffin__/` directories matching `**/__griffin__/*.{ts,js}`.
+By default, Griffin discovers test monitors from files in `__griffin__/` directories matching `**/__griffin__/*.{ts,js}`.
 
-Test files should be TypeScript or JavaScript files that export test plan objects.
+Test files should be TypeScript or JavaScript files that export test monitor objects.
 
 ## Diff Rules
 
 Griffin computes changes using:
 
-- **CREATE**: Plan exists locally but not in state
-- **UPDATE**: Plan exists in both, but hash differs
-- **DELETE**: Plan exists in state but not locally
-- **NOOP**: Plan exists in both with same hash
+- **CREATE**: Monitor exists locally but not in state
+- **UPDATE**: Monitor exists in both, but hash differs
+- **DELETE**: Monitor exists in state but not locally
+- **NOOP**: Monitor exists in both with same hash
 
-Change detection uses a SHA-256 hash of the normalized plan payload.
+Change detection uses a SHA-256 hash of the normalized monitor payload.
 
 ## Hub API Compatibility
 
@@ -398,11 +398,11 @@ Griffin CLI is compatible with Griffin Hub API v1.
 
 Required endpoints:
 
-- `POST /plan` - Create/update plan
-- `GET /plan` - List plans
+- `POST /monitor` - Create/update monitor
+- `GET /monitor` - List monitors
 - `GET /runs` - List runs
 - `GET /runs/:id` - Get run details
-- `POST /runs/trigger/:planId` - Trigger run
+- `POST /runs/trigger/:monitorId` - Trigger run
 
 ## Development
 
@@ -432,7 +432,7 @@ griffin-cli/
 │   │   │   ├── connect.ts
 │   │   │   ├── status.ts
 │   │   │   ├── runs.ts
-│   │   │   ├── plan.ts
+│   │   │   ├── monitor.ts
 │   │   │   ├── apply.ts
 │   │   │   └── run.ts
 │   │   ├── env.ts          # Environment commands
@@ -443,7 +443,7 @@ griffin-cli/
 │   │   ├── sdk.ts         # Hub SDK client
 │   │   ├── apply.ts       # Apply engine
 │   │   ├── diff.ts        # Diff computation
-│   │   ├── discovery.ts   # Plan discovery
+│   │   ├── discovery.ts   # Monitor discovery
 │   │   ├── state.ts       # State management
 │   │   ├── variables.ts   # Variable resolution
 │   │   └── project.ts     # Project detection

package/dist/cli.js

@@ -10,7 +10,7 @@ import { executeRunLocal } from "./commands/local/run.js";
 import { executeConnect } from "./commands/hub/connect.js";
 import { executeStatus } from "./commands/hub/status.js";
 import { executeRuns } from "./commands/hub/runs.js";
-import { executePlan } from "./commands/hub/plan.js";
+import { executeMonitor } from "./commands/hub/monitor.js";
 import { executeApply } from "./commands/hub/apply.js";
 import { executeRun } from "./commands/hub/run.js";
 import { executeLogin } from "./commands/hub/login.js";
@@ -30,7 +30,7 @@ program
 });
 program
     .command("validate")
-    .description("Validate test plan files without syncing")
+    .description("Validate test monitor files without syncing")
     .action(async () => {
     await executeValidate();
 });
@@ -51,7 +51,7 @@ env
 // Local command group
 const local = program.command("local").description("Local test execution");
 local
-    .command("run [env]")
+    .command("run <env>")
     .description("Run tests locally against an environment")
     .action(async (env, options) => {
     await executeRunLocal({ env });
@@ -75,7 +75,7 @@ hub
 hub
     .command("runs")
     .description("Show recent runs from the hub")
-    .option("--plan <name>", "Filter by plan name")
+    .option("--monitor <name>", "Filter by monitor name")
     .option("--limit <number>", "Number of runs to show", "10")
     .action(async (options) => {
     await executeRuns({
@@ -84,27 +84,27 @@ hub
     });
 });
 hub
-    .command("plan [env]")
+    .command("monitor <env>")
     .description("Show what changes would be applied")
     .option("--json", "Output in JSON format")
     .action(async (env, options) => {
-    await executePlan({ ...options, env });
+    await executeMonitor({ ...options, env });
 });
 hub
-    .command("apply [env]")
+    .command("apply <env>")
     .description("Apply changes to the hub")
     .option("--auto-approve", "Skip confirmation prompt")
     .option("--dry-run", "Show what would be done without making changes")
-    .option("--prune", "Delete plans on hub that don't exist locally")
+    .option("--prune", "Delete monitors on hub that don't exist locally")
     .action(async (env, options) => {
     await executeApply({ ...options, env });
 });
 hub
     .command("run <env>")
-    .description("Trigger a plan run on the hub")
-    .requiredOption("--plan <name>", "Plan name to run")
+    .description("Trigger a monitor run on the hub")
+    .requiredOption("--monitor <name>", "Monitor name to run")
     .option("--wait", "Wait for run to complete")
-    .option("--force", "Run even if local plan differs from hub")
+    .option("--force", "Run even if local monitor differs from hub")
     .action(async (env, options) => {
     await executeRun({ ...options, env });
 });

package/dist/commands/apply.js

@@ -1,5 +1,5 @@
 import { loadState, resolveEnvironment } from "../core/state.js";
-import { discoverPlans, formatDiscoveryErrors } from "../core/discovery.js";
+import { discoverMonitors, formatDiscoveryErrors } from "../core/discovery.js";
 import { computeDiff, formatDiff } from "../core/diff.js";
 import { applyDiff, formatApplyResult } from "../core/apply.js";
 import { createSdkClients } from "../core/sdk.js";
@@ -26,23 +26,23 @@ export async function executeApply(options) {
             baseUrl: state.runner.baseUrl,
             apiToken: state.runner.apiToken || undefined,
         });
-        // Discover local plans
+        // Discover local monitors
         const discoveryPattern = state.discovery?.pattern || "**/__griffin__/*.{ts,js}";
         const discoveryIgnore = state.discovery?.ignore || [
             "node_modules/**",
             "dist/**",
         ];
-        const { plans, errors } = await discoverPlans(discoveryPattern, discoveryIgnore);
+        const { monitors, errors } = await discoverMonitors(discoveryPattern, discoveryIgnore);
         if (errors.length > 0) {
             console.error(formatDiscoveryErrors(errors));
             process.exit(1);
         }
-        // Fetch remote plans for this project
+        // Fetch remote monitors for this project
         const response = await planApi.planGet(state.projectId);
-        const remotePlans = response.data.data.map((p) => p);
+        const remoteMonitors = response.data.data.map((p) => p);
         // Compute diff for this environment
-        const diff = computeDiff(plans.map((p) => p.plan), state, remotePlans, envName);
-        // Show plan
+        const diff = computeDiff(monitors.map((p) => p.monitor), state, remoteMonitors, envName);
+        // Show monitor
         console.log(formatDiff(diff));
         console.log("");
         // Check if there are changes

package/dist/commands/deploy.js

@@ -17,7 +17,7 @@ export async function executeDeploy() {
     }
     // TODO: Implement deployment logic
     // - Read each test file
-    // - Execute it to get JSON plan
+    // - Execute it to get JSON monitor
     // - Send to runner API
     // - Handle responses
     console.log("Deployed.");

package/dist/commands/hub/apply.d.ts

@@ -1,7 +1,7 @@
 export interface ApplyOptions {
     autoApprove?: boolean;
     dryRun?: boolean;
-    env?: string;
+    env: string;
     prune?: boolean;
 }
 /**

package/dist/commands/hub/apply.js

@@ -1,12 +1,12 @@
 import { loadState, resolveEnvironment } from "../../core/state.js";
-import { discoverPlans, formatDiscoveryErrors } from "../../core/discovery.js";
+import { discoverMonitors, formatDiscoveryErrors } from "../../core/discovery.js";
 import { computeDiff, formatDiff } from "../../core/diff.js";
 import { applyDiff, formatApplyResult } from "../../core/apply.js";
 import { createSdkWithCredentials } from "../../core/sdk.js";
 import { terminal } from "../../utils/terminal.js";
 import { withSDKErrorHandling } from "../../utils/sdk-error.js";
 import { loadVariables } from "../../core/variables.js";
-import { resolvePlan } from "../../resolve.js";
+import { resolveMonitor } from "../../resolve.js";
 /**
  * Apply changes to the hub
  */
@@ -27,38 +27,38 @@ export async function executeApply(options) {
         terminal.blank();
         // Create SDK clients with credentials
         const sdk = await createSdkWithCredentials(state.hub.baseUrl);
-        // Discover local plans
+        // Discover local monitors
         const discoveryPattern = state.discovery?.pattern || "**/__griffin__/*.{ts,js}";
         const discoveryIgnore = state.discovery?.ignore || [
             "node_modules/**",
             "dist/**",
         ];
-        const spinner = terminal.spinner("Discovering local plans...").start();
-        const { plans, errors } = await discoverPlans(discoveryPattern, discoveryIgnore);
+        const spinner = terminal.spinner("Discovering local monitors...").start();
+        const { monitors, errors } = await discoverMonitors(discoveryPattern, discoveryIgnore);
         if (errors.length > 0) {
             spinner.fail("Discovery failed");
             terminal.error(formatDiscoveryErrors(errors));
             terminal.exit(1);
         }
-        spinner.succeed(`Found ${plans.length} local plan(s)`);
-        // Fetch remote plans for this project + environment
-        const fetchSpinner = terminal.spinner("Fetching remote plans...").start();
-        const response = await withSDKErrorHandling(() => sdk.getPlan({
+        spinner.succeed(`Found ${monitors.length} local monitor(s)`);
+        // Fetch remote monitors for this project + environment
+        const fetchSpinner = terminal.spinner("Fetching remote monitors...").start();
+        const response = await withSDKErrorHandling(() => sdk.getMonitor({
             query: {
                 projectId: state.projectId,
                 environment: envName,
             },
-        }), "Failed to fetch remote plans");
-        const remotePlans = response?.data?.data;
-        fetchSpinner.succeed(`Found ${remotePlans.length} remote plan(s)`);
-        // Load variables and resolve local plans before computing diff
+        }), "Failed to fetch remote monitors");
+        const remoteMonitors = response?.data?.data;
+        fetchSpinner.succeed(`Found ${remoteMonitors.length} remote monitor(s)`);
+        // Load variables and resolve local monitors before computing diff
         const variables = await loadVariables(envName);
-        const resolvedPlans = plans.map((p) => resolvePlan(p.plan, state.projectId, envName, variables));
+        const resolvedMonitors = monitors.map((p) => resolveMonitor(p.monitor, state.projectId, envName, variables));
         // Compute diff (include deletions if --prune)
-        const diff = computeDiff(resolvedPlans, remotePlans, {
+        const diff = computeDiff(resolvedMonitors, remoteMonitors, {
             includeDeletions: options.prune || false,
         });
-        // Show plan
+        // Show monitor
         terminal.blank();
         terminal.log(formatDiff(diff));
         terminal.blank();
@@ -70,7 +70,7 @@ export async function executeApply(options) {
         }
         // Show deletions warning if --prune
         if (options.prune && diff.summary.deletes > 0) {
-            terminal.warn(`--prune will DELETE ${diff.summary.deletes} plan(s) from the hub`);
+            terminal.warn(`--prune will DELETE ${diff.summary.deletes} monitor(s) from the hub`);
             terminal.blank();
         }
         // Ask for confirmation unless auto-approved

package/dist/commands/hub/login.js

@@ -12,10 +12,7 @@ const hubBaseUrl = "http://localhost:3000";
 const oauthGrant = "urn:ietf:params:oauth:grant-type:device_code";
 const authClient = createAuthClient({
     baseURL: baseURL,
-    plugins: [
-        deviceAuthorizationClient(),
-        jwtClient(),
-    ],
+    plugins: [deviceAuthorizationClient(), jwtClient()],
 });
 async function pollForToken(clientId, deviceCode, interval) {
     const { data, error } = await authClient.device.token({
@@ -48,8 +45,7 @@ export async function executeLogin() {
         state = await loadState();
         clientId = state.hub?.clientId;
     }
-    catch (error) {
-    }
+    catch (error) { }
     if (!clientId) {
         clientId = randomBytes(16).toString("hex");
     }

package/dist/commands/hub/monitor.d.ts

@@ -0,0 +1,8 @@
+export interface MonitorOptions {
+    json?: boolean;
+    env: string;
+}
+/**
+ * Show what changes would be applied
+ */
+export declare function executeMonitor(options: MonitorOptions): Promise<void>;

package/dist/commands/hub/monitor.js

@@ -0,0 +1,75 @@
+import { loadState, resolveEnvironment } from "../../core/state.js";
+import { discoverMonitors, formatDiscoveryErrors } from "../../core/discovery.js";
+import { createSdkWithCredentials } from "../../core/sdk.js";
+import { computeDiff, formatDiff, formatDiffJson } from "../../core/diff.js";
+import { terminal } from "../../utils/terminal.js";
+import { withSDKErrorHandling } from "../../utils/sdk-error.js";
+import { loadVariables } from "../../core/variables.js";
+import { resolveMonitor } from "../../resolve.js";
+/**
+ * Show what changes would be applied
+ */
+export async function executeMonitor(options) {
+    try {
+        // Load state
+        const state = await loadState();
+        // Resolve environment
+        const envName = await resolveEnvironment(options.env);
+        if (!state.hub?.baseUrl) {
+            terminal.error("Hub connection not configured.");
+            terminal.dim("Connect with:");
+            terminal.dim("  griffin hub connect --url <url> --token <token>");
+            terminal.exit(1);
+        }
+        // Discover local monitors
+        const discoveryPattern = state.discovery?.pattern || "**/__griffin__/*.{ts,js}";
+        const discoveryIgnore = state.discovery?.ignore || [
+            "node_modules/**",
+            "dist/**",
+        ];
+        const spinner = terminal.spinner("Discovering local monitors...").start();
+        const { monitors, errors } = await discoverMonitors(discoveryPattern, discoveryIgnore);
+        if (errors.length > 0) {
+            spinner.fail("Discovery failed");
+            terminal.error(formatDiscoveryErrors(errors));
+            terminal.exit(1);
+        }
+        spinner.succeed(`Found ${monitors.length} local monitor(s)`);
+        // Create SDK clients with credentials
+        const sdk = await createSdkWithCredentials(state.hub.baseUrl);
+        // Fetch remote monitors for this project + environment
+        const fetchSpinner = terminal.spinner("Fetching remote monitors...").start();
+        const response = await withSDKErrorHandling(() => sdk.getMonitor({
+            query: {
+                projectId: state.projectId,
+                environment: envName,
+            },
+        }), "Failed to fetch remote monitors");
+        const remoteMonitors = response?.data?.data;
+        fetchSpinner.succeed(`Found ${remoteMonitors.length} remote monitor(s)`);
+        // Load variables and resolve local monitors before computing diff
+        const variables = await loadVariables(envName);
+        const resolvedMonitors = monitors.map((p) => resolveMonitor(p.monitor, state.projectId, envName, variables));
+        // Compute diff (no deletions shown by default)
+        const diff = computeDiff(resolvedMonitors, remoteMonitors, {
+            includeDeletions: false,
+        });
+        terminal.blank();
+        // Output
+        if (options.json) {
+            terminal.log(formatDiffJson(diff));
+        }
+        else {
+            terminal.log(formatDiff(diff));
+        }
+        // Exit with error code if there are changes
+        if (diff.summary.creates + diff.summary.updates + diff.summary.deletes >
+            0) {
+            terminal.exit(2); // Exit code 2 indicates changes pending
+        }
+    }
+    catch (error) {
+        terminal.error(error.message);
+        terminal.exit(1);
+    }
+}

package/dist/commands/hub/plan.d.ts

@@ -1,8 +1,8 @@
-export interface PlanOptions {
+export interface MonitorOptions {
     json?: boolean;
     env?: string;
 }
 /**
  * Show what changes would be applied
  */
-export declare function executePlan(options: PlanOptions): Promise<void>;
+export declare function executeMonitor(options: MonitorOptions): Promise<void>;

package/dist/commands/hub/plan.js

@@ -1,15 +1,15 @@
 import { loadState, resolveEnvironment } from "../../core/state.js";
-import { discoverPlans, formatDiscoveryErrors } from "../../core/discovery.js";
+import { discoverMonitors, formatDiscoveryErrors } from "../../core/discovery.js";
 import { createSdkWithCredentials } from "../../core/sdk.js";
 import { computeDiff, formatDiff, formatDiffJson } from "../../core/diff.js";
 import { terminal } from "../../utils/terminal.js";
 import { withSDKErrorHandling } from "../../utils/sdk-error.js";
 import { loadVariables } from "../../core/variables.js";
-import { resolvePlan } from "../../resolve.js";
+import { resolveMonitor } from "../../resolve.js";
 /**
  * Show what changes would be applied
  */
-export async function executePlan(options) {
+export async function executeMonitor(options) {
     try {
         // Load state
         const state = await loadState();
@@ -21,37 +21,37 @@ export async function executePlan(options) {
             terminal.dim("  griffin hub connect --url <url> --token <token>");
             terminal.exit(1);
         }
-        // Discover local plans
+        // Discover local monitors
         const discoveryPattern = state.discovery?.pattern || "**/__griffin__/*.{ts,js}";
         const discoveryIgnore = state.discovery?.ignore || [
             "node_modules/**",
             "dist/**",
         ];
-        const spinner = terminal.spinner("Discovering local plans...").start();
-        const { plans, errors } = await discoverPlans(discoveryPattern, discoveryIgnore);
+        const spinner = terminal.spinner("Discovering local monitors...").start();
+        const { monitors, errors } = await discoverMonitors(discoveryPattern, discoveryIgnore);
         if (errors.length > 0) {
             spinner.fail("Discovery failed");
             terminal.error(formatDiscoveryErrors(errors));
             terminal.exit(1);
         }
-        spinner.succeed(`Found ${plans.length} local plan(s)`);
+        spinner.succeed(`Found ${monitors.length} local monitor(s)`);
         // Create SDK clients with credentials
         const sdk = await createSdkWithCredentials(state.hub.baseUrl);
-        // Fetch remote plans for this project + environment
-        const fetchSpinner = terminal.spinner("Fetching remote plans...").start();
-        const response = await withSDKErrorHandling(() => sdk.getPlan({
+        // Fetch remote monitors for this project + environment
+        const fetchSpinner = terminal.spinner("Fetching remote monitors...").start();
+        const response = await withSDKErrorHandling(() => sdk.getMonitor({
             query: {
                 projectId: state.projectId,
                 environment: envName,
             },
-        }), "Failed to fetch remote plans");
-        const remotePlans = response?.data?.data;
-        fetchSpinner.succeed(`Found ${remotePlans.length} remote plan(s)`);
-        // Load variables and resolve local plans before computing diff
+        }), "Failed to fetch remote monitors");
+        const remoteMonitors = response?.data?.data;
+        fetchSpinner.succeed(`Found ${remoteMonitors.length} remote monitor(s)`);
+        // Load variables and resolve local monitors before computing diff
         const variables = await loadVariables(envName);
-        const resolvedPlans = plans.map((p) => resolvePlan(p.plan, state.projectId, envName, variables));
+        const resolvedMonitors = monitors.map((p) => resolveMonitor(p.monitor, state.projectId, envName, variables));
         // Compute diff (no deletions shown by default)
-        const diff = computeDiff(resolvedPlans, remotePlans, {
+        const diff = computeDiff(resolvedMonitors, remoteMonitors, {
             includeDeletions: false,
         });
         terminal.blank();

package/dist/commands/hub/run.d.ts

@@ -1,10 +1,10 @@
 export interface RunOptions {
-    plan: string;
+    monitor: string;
     env: string;
     wait?: boolean;
     force?: boolean;
 }
 /**
- * Trigger a plan run on the hub
+ * Trigger a monitor run on the hub
  */
 export declare function executeRun(options: RunOptions): Promise<void>;