@griffin-app/griffin-cli 1.0.3 → 1.0.5

package/README.md

@@ -35,18 +35,12 @@ This creates `.griffin/state.json` which tracks:
 
 Override project ID with `--project <name>`.
 
-### 2. Configure Targets
-
-Add targets to your local environment:
-
-```bash
-griffin local config add-target --env local --key api --url http://localhost:3000
-```
+### 2. View Environments
 
 View configured environments:
 
 ```bash
-griffin local config list
+griffin env list
 ```
 
 ### 3. Create Test Plans
@@ -56,10 +50,10 @@ Create test files in `__griffin__/` directories. These files export test plans t
 ### 4. Run Tests Locally
 
 ```bash
-griffin local run --env local
+griffin local run local
 ```
 
-Executes tests locally against configured targets.
+Executes tests locally using variables from `variables.yaml` for the specified environment.
 
 ### 5. Connect to Hub (Optional)
 
@@ -71,32 +65,35 @@ griffin hub connect --url https://hub.example.com --token <token>
 
 ```bash
 griffin hub plan
+griffin hub plan production
 ```
 
-Shows what will be created, updated, or deleted on the hub.
+Shows what will be created, updated, or deleted on the hub for the specified environment.
 
 ### 7. Apply to Hub
 
 ```bash
 griffin hub apply
+griffin hub apply production
 ```
 
-Syncs plans to the hub.
+Syncs plans to the hub for the specified environment.
 
 ### 8. Trigger Hub Run
 
 ```bash
-griffin hub run --plan <name> --env production
+griffin hub run production --plan <name>
 ```
 
-Triggers a plan execution on the hub.
+Triggers a plan execution on the hub in the specified environment.
 
 ## Commands
 
-Commands are organized into three groups:
+Commands are organized into four groups:
 
 - **Top-level**: Project initialization and utilities
-- **local**: Local test execution and configuration
+- **env**: Environment management
+- **local**: Local test execution
 - **hub**: Hub operations (plan sync, remote execution)
 
 ### Top-Level Commands
@@ -136,99 +133,82 @@ Generate a cryptographically secure API key for authentication.
 griffin generate-key
 ```
 
-### Local Commands
-
-#### `griffin local run`
-
-Run tests locally against configured targets.
-
-**Options:**
-
-- `--env <name>` - Environment to run against (uses default if not specified)
+### Environment Commands
 
-**Example:**
-
-```bash
-griffin local run
-griffin local run --env staging
-```
+#### `griffin env list`
 
-#### `griffin local config list`
-
-List all local environments and their targets.
+List all available environments.
 
 **Example:**
 
 ```bash
-griffin local config list
+griffin env list
 ```
 
-#### `griffin local config add-target`
+Shows all configured environments with an asterisk (\*) marking the default environment.
 
-Add a target to a local environment.
+### Local Commands
 
-**Options:**
+#### `griffin local run [env]`
 
-- `--env <name>` - Environment name (required)
-- `--key <key>` - Target key (required)
-- `--url <url>` - Target URL (required)
+Run tests locally against an environment. Environment can be specified as a positional argument, or uses the default environment if omitted.
 
 **Example:**
 
 ```bash
-griffin local config add-target --env local --key api --url http://localhost:3000
-griffin local config add-target --env staging --key billing --url http://localhost:3001
+griffin local run
+griffin local run staging
 ```
 
-#### `griffin local config remove-target`
+Variables are loaded from `variables.yaml` for the specified environment.
 
-Remove a target from a local environment.
+### Hub Commands
+
+#### `griffin hub connect`
+
+Configure hub connection settings. When a token is provided, it is stored in the user-level credentials file (`~/.griffin/credentials.json`) for secure, cross-project authentication.
 
 **Options:**
 
-- `--env <name>` - Environment name (required)
-- `--key <key>` - Target key (required)
+- `--url <url>` - Hub URL (required)
+- `--token <token>` - API authentication token (optional)
 
 **Example:**
 
 ```bash
-griffin local config remove-target --env local --key api
+griffin hub connect --url https://hub.example.com --token abc123
 ```
 
-#### `griffin local config set-default-env`
+#### `griffin hub login`
 
-Set the default environment for local runs.
-
-**Options:**
-
-- `--env <name>` - Environment name (required)
+Authenticate with the hub using device authorization flow. The received token is stored in the user-level credentials file (`~/.griffin/credentials.json`) for secure access across all projects.
 
 **Example:**
 
 ```bash
-griffin local config set-default-env --env local
+griffin hub login
 ```
 
-### Hub Commands
+After running this command, you'll be provided with a URL to complete authentication in your browser. Once authenticated, the token will be automatically saved.
 
-#### `griffin hub connect`
+#### `griffin hub logout`
 
-Configure hub connection settings.
+Remove stored credentials for the currently configured hub or all hubs.
 
 **Options:**
 
-- `--url <url>` - Hub URL (required)
-- `--token <token>` - API authentication token
+- `--all` - Remove credentials for all hubs
 
 **Example:**
 
 ```bash
-griffin hub connect --url https://hub.example.com --token abc123
+griffin hub logout
+griffin hub logout --all
 ```
 
 #### `griffin hub status`
 
-Show hub connection status.
+Show hub connection status, including whether credentials are configured.
 
 **Example:**
 
@@ -252,20 +232,20 @@ griffin hub runs
 griffin hub runs --plan health-check --limit 5
 ```
 
-#### `griffin hub plan`
+#### `griffin hub plan [env]`
 
-Show what changes would be applied to the hub.
+Show what changes would be applied to the hub. Environment can be specified as a positional argument, or uses the default environment if omitted.
 
 **Options:**
 
-- `--env <name>` - Environment to plan for (uses default if not specified)
 - `--json` - Output in JSON format
 
 **Example:**
 
 ```bash
 griffin hub plan
-griffin hub plan --env production --json
+griffin hub plan production
+griffin hub plan staging --json
 ```
 
 **Exit codes:**
@@ -274,88 +254,41 @@ griffin hub plan --env production --json
 - `1` - Error
 - `2` - Changes pending
 
-#### `griffin hub apply`
+#### `griffin hub apply [env]`
 
-Apply changes to the hub.
+Apply changes to the hub. Environment can be specified as a positional argument, or uses the default environment if omitted.
 
 **Options:**
 
-- `--env <name>` - Environment to apply to (uses default if not specified)
 - `--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
 
 **Example:**
 
 ```bash
 griffin hub apply
-griffin hub apply --env production --auto-approve
-griffin hub apply --dry-run
+griffin hub apply production --auto-approve
+griffin hub apply staging --dry-run
+griffin hub apply production --prune
 ```
 
-#### `griffin hub run`
+#### `griffin hub run <env>`
 
-Trigger a plan run on the hub.
+Trigger a plan run on the hub in the specified environment.
 
 **Options:**
 
 - `--plan <name>` - Plan name to run (required)
-- `--env <name>` - Target environment (required)
 - `--wait` - Wait for run to complete
+- `--force` - Run even if local plan differs from hub
 
 **Example:**
 
 ```bash
-griffin hub run --plan health-check --env production
-griffin hub run --plan health-check --env staging --wait
-```
-
-#### `griffin hub config list`
-
-List all hub target configurations.
-
-**Options:**
-
-- `--org <id>` - Filter by organization ID
-- `--env <name>` - Filter by environment name
-
-**Example:**
-
-```bash
-griffin hub config list
-griffin hub config list --org acme --env production
-```
-
-#### `griffin hub config add-target`
-
-Add a target to hub configuration.
-
-**Options:**
-
-- `--org <id>` - Organization ID (required)
-- `--env <name>` - Environment name (required)
-- `--key <key>` - Target key (required)
-- `--url <url>` - Target URL (required)
-
-**Example:**
-
-```bash
-griffin hub config add-target --org acme --env production --key api --url https://api.example.com
-```
-
-#### `griffin hub config remove-target`
-
-Remove a target from hub configuration.
-
-**Options:**
-
-- `--org <id>` - Organization ID (required)
-- `--env <name>` - Environment name (required)
-- `--key <key>` - Target key (required)
-
-**Example:**
-
-```bash
-griffin hub config remove-target --org acme --env production --key api
+griffin hub run production --plan health-check
+griffin hub run staging --plan health-check --wait
+griffin hub run production --plan api-check --force
 ```
 
 ## Configuration
@@ -366,59 +299,80 @@ griffin hub config remove-target --org acme --env production --key api
 
 ### State File
 
-Griffin stores configuration in `.griffin/state.json`:
+Griffin stores project configuration in `.griffin/state.json`:
 
 ```json
 {
-  "stateVersion": 3,
+  "stateVersion": 1,
   "projectId": "my-project",
   "environments": {
-    "local": {
-      "targets": {
-        "api": "http://localhost:3000",
-        "billing": "http://localhost:3001"
-      }
-    }
+    "local": {}
   },
   "defaultEnvironment": "local",
-  "runner": {
+  "hub": {
     "baseUrl": "https://hub.example.com",
-    "apiToken": "..."
+    "clientId": "..."
   },
   "discovery": {
     "pattern": "**/__griffin__/*.{ts,js}",
     "ignore": ["node_modules/**", "dist/**"]
-  },
-  "plans": {
-    "local": []
   }
 }
 ```
 
-**Important:** Add `.griffin/` to `.gitignore` as it contains local state and potentially sensitive tokens.
+**Important:** Add `.griffin/` to `.gitignore` as it contains local project state.
 
-## Environments and Targets
+### Credentials File
 
-Griffin uses environments to organize target configurations. Each environment contains multiple named targets (key-value pairs of target keys to URLs).
+Griffin stores user-level authentication credentials in `~/.griffin/credentials.json`:
 
-**Local environments:**
+```json
+{
+  "version": 1,
+  "hubs": {
+    "https://hub.example.com": {
+      "token": "...",
+      "updatedAt": "2024-01-24T12:00:00.000Z"
+    }
+  }
+}
+```
+
+This file is automatically created and managed by the CLI when you use `griffin hub login` or `griffin hub connect --token <token>`. Credentials are stored per-hub URL and are available across all projects on your system.
+
+**Security:** The credentials file is created with restricted permissions (0600) to ensure only the owner can read/write.
+
+## Environments and Variables
 
-- Defined in `.griffin/state.json`
-- Used for local test execution
-- Managed via `griffin local config` commands
+Griffin uses environments to organize test configurations. Each environment maps to a section in `variables.yaml` which contains environment-specific variable values.
+
+**Example `variables.yaml`:**
+
+```yaml
+environments:
+  local:
+    api_host: "localhost:3000"
+    api_key: "local-test-key"
+  staging:
+    api_host: "staging.example.com"
+    api_key: "staging-key"
+  production:
+    api_host: "api.example.com"
+    api_key: "prod-key"
+```
 
 **Example workflow:**
 
 ```bash
-# Create local environment with targets
-griffin local config add-target --env local --key api --url http://localhost:3000
-griffin local config add-target --env local --key billing --url http://localhost:3001
+# List available environments
+griffin env list
 
-# Set default environment
-griffin local config set-default-env --env local
+# Run tests against different environments
+griffin local run local
+griffin local run staging
 
-# Run tests using default environment
-griffin local run
+# Sync to hub for specific environment
+griffin hub apply production
 ```
 
 ## Test Plan Discovery
@@ -448,10 +402,7 @@ Required endpoints:
 - `GET /plan` - List plans
 - `GET /runs` - List runs
 - `GET /runs/:id` - Get run details
-- `POST /runs/trigger/:id` - Trigger run
-- `GET /config` - List configurations
-- `PUT /config/:org/:env/targets/:key` - Set target
-- `DELETE /config/:org/:env/targets/:key` - Delete target
+- `POST /runs/trigger/:planId` - Trigger run
 
 ## Development
 
@@ -476,16 +427,15 @@ griffin-cli/
 ├── src/
 │   ├── commands/           # Command implementations
 │   │   ├── local/          # Local execution commands
-│   │   │   ├── run.ts
-│   │   │   └── config.ts
+│   │   │   └── run.ts
 │   │   ├── hub/            # Hub operation commands
 │   │   │   ├── connect.ts
 │   │   │   ├── status.ts
 │   │   │   ├── runs.ts
 │   │   │   ├── plan.ts
 │   │   │   ├── apply.ts
-│   │   │   ├── run.ts
-│   │   │   └── config.ts
+│   │   │   └── run.ts
+│   │   ├── env.ts          # Environment commands
 │   │   ├── init.ts
 │   │   ├── validate.ts
 │   │   └── generate-key.ts
@@ -495,9 +445,9 @@ griffin-cli/
 │   │   ├── diff.ts        # Diff computation
 │   │   ├── discovery.ts   # Plan discovery
 │   │   ├── state.ts       # State management
+│   │   ├── variables.ts   # Variable resolution
 │   │   └── project.ts     # Project detection
 │   ├── schemas/           # Type definitions
-│   │   ├── payload.ts     # Plan payload schemas
 │   │   └── state.ts       # State file schemas
 │   ├── cli.ts             # CLI entry point
 │   └── index.ts           # Public API exports

package/dist/cli.js

@@ -3,6 +3,7 @@ import { Command } from "commander";
 import { executeInit } from "./commands/init.js";
 import { executeValidate } from "./commands/validate.js";
 import { executeGenerateKey } from "./commands/generate-key.js";
+import { executeEnvList } from "./commands/env.js";
 // Local commands
 import { executeRunLocal } from "./commands/local/run.js";
 // Hub commands
@@ -12,6 +13,8 @@ import { executeRuns } from "./commands/hub/runs.js";
 import { executePlan } from "./commands/hub/plan.js";
 import { executeApply } from "./commands/hub/apply.js";
 import { executeRun } from "./commands/hub/run.js";
+import { executeLogin } from "./commands/hub/login.js";
+import { executeLogout } from "./commands/hub/logout.js";
 const program = new Command();
 program
     .name("griffin")
@@ -37,14 +40,21 @@ program
     .action(async () => {
     await executeGenerateKey();
 });
+// Environment command group
+const env = program.command("env").description("Manage environments");
+env
+    .command("list")
+    .description("List all available environments")
+    .action(async () => {
+    await executeEnvList();
+});
 // Local command group
 const local = program.command("local").description("Local test execution");
 local
-    .command("run")
+    .command("run [env]")
     .description("Run tests locally against an environment")
-    .option("--env <name>", "Environment to run against (uses default if not specified)")
-    .action(async (options) => {
-    await executeRunLocal(options);
+    .action(async (env, options) => {
+    await executeRunLocal({ env });
 });
 // Hub command group
 const hub = program.command("hub").description("Griffin Hub operations");
@@ -74,32 +84,41 @@ hub
     });
 });
 hub
-    .command("plan")
+    .command("plan [env]")
     .description("Show what changes would be applied")
-    .option("--env <name>", "Environment to plan for (uses default if not specified)")
     .option("--json", "Output in JSON format")
-    .action(async (options) => {
-    await executePlan(options);
+    .action(async (env, options) => {
+    await executePlan({ ...options, env });
 });
 hub
-    .command("apply")
+    .command("apply [env]")
     .description("Apply changes to the hub")
-    .option("--env <name>", "Environment to apply to (uses default if not specified)")
     .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")
-    .action(async (options) => {
-    await executeApply(options);
+    .action(async (env, options) => {
+    await executeApply({ ...options, env });
 });
 hub
-    .command("run")
+    .command("run <env>")
     .description("Trigger a plan run on the hub")
     .requiredOption("--plan <name>", "Plan name to run")
-    .requiredOption("--env <name>", "Target environment")
     .option("--wait", "Wait for run to complete")
     .option("--force", "Run even if local plan differs from hub")
+    .action(async (env, options) => {
+    await executeRun({ ...options, env });
+});
+hub
+    .command("login")
+    .description("Login to the hub")
+    .action(async () => {
+    await executeLogin();
+});
+hub
+    .command("logout")
+    .description("Remove stored credentials")
     .action(async (options) => {
-    await executeRun(options);
+    await executeLogout(options);
 });
 // Parse arguments
 program.parse();

package/dist/commands/env.d.ts

@@ -1,25 +1,4 @@
-export interface EnvAddOptions {
-    baseUrl: string;
-}
-export interface EnvRemoveOptions {
-    name: string;
-}
-export interface EnvDefaultOptions {
-    name: string;
-}
 /**
- * List all environments
+ * List all available environments
  */
 export declare function executeEnvList(): Promise<void>;
-/**
- * Add or update an environment
- */
-export declare function executeEnvAdd(name: string, options: EnvAddOptions): Promise<void>;
-/**
- * Remove an environment
- */
-export declare function executeEnvRemove(name: string): Promise<void>;
-/**
- * Set default environment
- */
-export declare function executeEnvDefault(name: string): Promise<void>;