@crewx/cli 0.8.4-rc.0 → 0.8.4-rc.1

package/README.md

@@ -1,33 +1,33 @@
-# CrewX CLI
-
-> Build AI agent teams from your terminal.
-
-[![npm version](https://img.shields.io/npm/v/@crewx/cli.svg)](https://www.npmjs.com/package/@crewx/cli)
-[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
-
-## Installation
-
-```bash
-npm install -g @crewx/cli
-```
-
-## Quick Start
-
-```bash
-crewx q "@assistant hello"
-crewx x "@coder implement feature X"
-crewx agent list
-```
-
-Run `crewx --help` for the full list.
-
-## What is CrewX?
-
-CrewX lets you define AI agents in a single `crewx.yaml` and call them from the terminal.
-
-This repository contains the **CrewX CLI** — a thin wrapper over the [`@crewx/sdk`](https://www.npmjs.com/package/@crewx/sdk) runtime (distributed via npm).
-
-## License
-
-CLI source: [Apache-2.0](LICENSE).
-`@crewx/sdk` runtime: proprietary on npm.
+# CrewX CLI
+
+> Build AI agent teams from your terminal.
+
+[![npm version](https://img.shields.io/npm/v/@crewx/cli.svg)](https://www.npmjs.com/package/@crewx/cli)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+## Installation
+
+```bash
+npm install -g @crewx/cli
+```
+
+## Quick Start
+
+```bash
+crewx q "@assistant hello"
+crewx x "@coder implement feature X"
+crewx agent list
+```
+
+Run `crewx --help` for the full list.
+
+## What is CrewX?
+
+CrewX lets you define AI agents in a single `crewx.yaml` and call them from the terminal.
+
+This repository contains the **CrewX CLI** — a thin wrapper over the [`@crewx/sdk`](https://www.npmjs.com/package/@crewx/sdk) runtime (distributed via npm).
+
+## License
+
+CLI source: [Apache-2.0](LICENSE).
+`@crewx/sdk` runtime: proprietary on npm.

package/bin/crewx

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-require('../dist/main.js');
+#!/usr/bin/env node
+require('../dist/main.js');

package/dist/commands/agent.js

@@ -219,28 +219,28 @@ function loadAgentSkills() {
     }
 }
 function printAgentHelp() {
-    console.log(`
-CrewX Agent Management
-
-Usage:
-  crewx agent             # List configured agents (default)
-  crewx agent ls          # List configured agents
-  crewx agent list        # Alias for ls
-  crewx agent prompt <id> # Inspect rendered agent prompt
-
-Filter Options (for agent ls):
-  --role <value>      Filter by agent role (comma-separated for multiple: PM,Dev)
-  --team <value>      Filter by agent team (comma-separated for multiple)
-  --provider <value>  Filter by provider (comma-separated, partial match: claude)
-
-Examples:
-  crewx agent
-  crewx agent ls
-  crewx agent ls --role=PM
-  crewx agent ls --team="CrewX Core 개발팀"
-  crewx agent ls --provider=claude
-  crewx agent ls --role=PM --provider=claude
-  crewx agent ls --role=PM,general
-  CREWX_CONFIG=./crewx.yaml crewx agent list
+    console.log(`
+CrewX Agent Management
+
+Usage:
+  crewx agent             # List configured agents (default)
+  crewx agent ls          # List configured agents
+  crewx agent list        # Alias for ls
+  crewx agent prompt <id> # Inspect rendered agent prompt
+
+Filter Options (for agent ls):
+  --role <value>      Filter by agent role (comma-separated for multiple: PM,Dev)
+  --team <value>      Filter by agent team (comma-separated for multiple)
+  --provider <value>  Filter by provider (comma-separated, partial match: claude)
+
+Examples:
+  crewx agent
+  crewx agent ls
+  crewx agent ls --role=PM
+  crewx agent ls --team="CrewX Core 개발팀"
+  crewx agent ls --provider=claude
+  crewx agent ls --role=PM --provider=claude
+  crewx agent ls --role=PM,general
+  CREWX_CONFIG=./crewx.yaml crewx agent list
 `.trim());
 }

package/dist/commands/init.js

@@ -64,28 +64,28 @@ function indentBlock(text, spaces) {
 }
 function generateDefaultYaml(agents) {
     const agentBlocks = agents
-        .map((a) => `  - id: "${a.id}"
-    name: "${a.name}"
-    role: "${a.role}"
-    team: "${a.team}"
-    provider: "${a.provider}"
-    working_directory: "${a.working_directory}"
-    description: "${a.description}"
-    inline:
-      model: "${a.inline.model}"
-      system_prompt: |
+        .map((a) => `  - id: "${a.id}"
+    name: "${a.name}"
+    role: "${a.role}"
+    team: "${a.team}"
+    provider: "${a.provider}"
+    working_directory: "${a.working_directory}"
+    description: "${a.description}"
+    inline:
+      model: "${a.inline.model}"
+      system_prompt: |
 ${indentBlock(a.inline.system_prompt, 8)}`)
         .join('\n\n');
-    return `# CrewX Agents Configuration
-# Generated by 'crewx init'
-
-agents:
-${agentBlocks}
-
-# Usage examples:
-#   crewx query "@planner analyze this codebase"
-#   crewx execute "@developer implement the feature described above"
-#   crewx agent ls
+    return `# CrewX Agents Configuration
+# Generated by 'crewx init'
+
+agents:
+${agentBlocks}
+
+# Usage examples:
+#   crewx query "@planner analyze this codebase"
+#   crewx execute "@developer implement the feature described above"
+#   crewx agent ls
 `;
 }
 /**

package/dist/commands/task-db.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Shared SQLite helper for ps/kill/result CLI commands.
+ * Reads from (or writes to) the global ~/.crewx/crewx.db
+ * populated by SqliteTracingPlugin.
+ */
+import BetterSqlite3 from 'better-sqlite3';
+export type TaskStatus = 'running' | 'success' | 'failed';
+export interface TaskRow {
+    id: string;
+    agent_id: string;
+    prompt: string;
+    mode: string;
+    status: TaskStatus;
+    pid: number | null;
+    started_at: string;
+    completed_at: string | null;
+    result: string | null;
+    error: string | null;
+    duration_ms: number | null;
+}
+export declare function getDbPath(dbRoot?: string): string;
+export declare function openDb(readonly?: boolean, dbRoot?: string): InstanceType<typeof BetterSqlite3> | null;
+/** Return all tasks with status='running'. */
+export declare function getRunningTasks(dbRoot?: string): TaskRow[];
+/** Return all tasks ordered by started_at desc. */
+export declare function getAllTasks(dbRoot?: string): TaskRow[];
+/** Return a single task by id, or undefined if not found. */
+export declare function getTask(id: string, dbRoot?: string): TaskRow | undefined;
+/** Send SIGTERM to the task's pid and mark it failed. Returns ok/message. */
+export declare function killTask(id: string, dbRoot?: string): {
+    ok: boolean;
+    message: string;
+};

package/dist/commands/task-db.js

@@ -0,0 +1,107 @@
+"use strict";
+/**
+ * Shared SQLite helper for ps/kill/result CLI commands.
+ * Reads from (or writes to) the global ~/.crewx/crewx.db
+ * populated by SqliteTracingPlugin.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDbPath = getDbPath;
+exports.openDb = openDb;
+exports.getRunningTasks = getRunningTasks;
+exports.getAllTasks = getAllTasks;
+exports.getTask = getTask;
+exports.killTask = killTask;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const os_1 = require("os");
+const better_sqlite3_1 = __importDefault(require("better-sqlite3"));
+function getDbPath(dbRoot) {
+    return (0, path_1.join)(dbRoot ?? (0, os_1.homedir)(), '.crewx', 'crewx.db');
+}
+function openDb(readonly = true, dbRoot) {
+    const dbPath = getDbPath(dbRoot);
+    if (!(0, fs_1.existsSync)(dbPath))
+        return null;
+    return new better_sqlite3_1.default(dbPath, { readonly });
+}
+/** Return all tasks with status='running'. */
+function getRunningTasks(dbRoot) {
+    const db = openDb(true, dbRoot);
+    if (!db)
+        return [];
+    try {
+        return db.prepare(`SELECT id, agent_id, prompt, mode, status, pid, started_at, completed_at,
+              result, error, duration_ms
+       FROM tasks WHERE status = 'running' ORDER BY started_at DESC`).all();
+    }
+    finally {
+        db.close();
+    }
+}
+/** Return all tasks ordered by started_at desc. */
+function getAllTasks(dbRoot) {
+    const db = openDb(true, dbRoot);
+    if (!db)
+        return [];
+    try {
+        return db.prepare(`SELECT id, agent_id, prompt, mode, status, pid, started_at, completed_at,
+              result, error, duration_ms
+       FROM tasks ORDER BY started_at DESC`).all();
+    }
+    finally {
+        db.close();
+    }
+}
+/** Return a single task by id, or undefined if not found. */
+function getTask(id, dbRoot) {
+    const db = openDb(true, dbRoot);
+    if (!db)
+        return undefined;
+    try {
+        return db.prepare(`SELECT id, agent_id, prompt, mode, status, pid, started_at, completed_at,
+              result, error, duration_ms
+       FROM tasks WHERE id = ?`).get(id);
+    }
+    finally {
+        db.close();
+    }
+}
+/** Send SIGTERM to the task's pid and mark it failed. Returns ok/message. */
+function killTask(id, dbRoot) {
+    const db = openDb(false, dbRoot);
+    if (!db)
+        return { ok: false, message: `crewx.db not found — no running tasks.` };
+    try {
+        const task = db.prepare(`SELECT id, status, pid FROM tasks WHERE id = ?`).get(id);
+        if (!task) {
+            return { ok: false, message: `Task not found: ${id}` };
+        }
+        if (task.status !== 'running') {
+            return { ok: false, message: `Task ${id} is not running (status: ${task.status})` };
+        }
+        if (task.pid) {
+            try {
+                process.kill(task.pid, 'SIGTERM');
+            }
+            catch (err) {
+                const code = err.code;
+                if (code !== 'ESRCH') {
+                    return {
+                        ok: false,
+                        message: `Failed to kill PID ${task.pid}: ${err instanceof Error ? err.message : String(err)}`,
+                    };
+                }
+                // ESRCH = process already gone — still clean up the record
+            }
+        }
+        db.prepare(`UPDATE tasks SET status='failed', error='killed by user',
+       completed_at=?, pid=NULL WHERE id=?`).run(new Date().toISOString(), id);
+        return { ok: true, message: `Killed task ${id}${task.pid ? ` (PID: ${task.pid})` : ''}` };
+    }
+    finally {
+        db.close();
+    }
+}

package/dist/examples/deny-secrets-plugin.d.ts

@@ -0,0 +1,22 @@
+/**
+ * DenyIfTouchesSecretsPlugin — Phase 0 demo HookPlugin.
+ *
+ * Denies Bash tool calls whose command string contains ".env".
+ * Pure string matching — trivially bypassable (see README).
+ *
+ * SECURITY NOTE:
+ *   Do NOT include tool.input content in deny reasons.
+ *   Use static messages only to prevent prompt injection.
+ *   ✅ return ctx.deny('Secrets-related command');
+ *   ❌ return ctx.deny(`Blocked: ${cmd}`);
+ */
+import { HookPlugin } from '@crewx/sdk/hooks';
+import type { HookContext, HookResult } from '@crewx/sdk/hooks';
+export declare class DenyIfTouchesSecretsPlugin extends HookPlugin {
+    readonly name = "deny-secrets";
+    readonly version = "0.1.0";
+    readonly capabilities: {
+        required: readonly ["deny"];
+    };
+    run(ctx: HookContext): Promise<HookResult>;
+}

package/dist/examples/deny-secrets-plugin.js

@@ -0,0 +1,40 @@
+"use strict";
+/**
+ * DenyIfTouchesSecretsPlugin — Phase 0 demo HookPlugin.
+ *
+ * Denies Bash tool calls whose command string contains ".env".
+ * Pure string matching — trivially bypassable (see README).
+ *
+ * SECURITY NOTE:
+ *   Do NOT include tool.input content in deny reasons.
+ *   Use static messages only to prevent prompt injection.
+ *   ✅ return ctx.deny('Secrets-related command');
+ *   ❌ return ctx.deny(`Blocked: ${cmd}`);
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DenyIfTouchesSecretsPlugin = void 0;
+const hooks_1 = require("@crewx/sdk/hooks");
+const SECRET_PATTERNS = ['.env', 'credentials.json', 'service-account-key.json'];
+const SHELL_TOOL_NAMES = new Set(['Bash', 'shell', 'local_shell']);
+class DenyIfTouchesSecretsPlugin extends hooks_1.HookPlugin {
+    name = 'deny-secrets';
+    version = '0.1.0';
+    capabilities = { required: ['deny'] };
+    async run(ctx) {
+        if (!SHELL_TOOL_NAMES.has(ctx.tool.rawName) && ctx.tool.name !== 'shell') {
+            return ctx.pass();
+        }
+        const input = ctx.tool.input;
+        const command = input?.command;
+        if (typeof command !== 'string') {
+            return ctx.pass();
+        }
+        for (const pattern of SECRET_PATTERNS) {
+            if (command.includes(pattern)) {
+                return ctx.deny('Secrets-related command');
+            }
+        }
+        return ctx.pass();
+    }
+}
+exports.DenyIfTouchesSecretsPlugin = DenyIfTouchesSecretsPlugin;

package/dist/main.js

@@ -218,78 +218,78 @@ async function main() {
     process.exit(1);
 }
 function printHelp() {
-    console.log(`
-CrewX CLI v${version_1.CLI_VERSION}
-
-Usage:
-  crewx                          Launch web dashboard + open browser (default)
-  crewx <command> [options]
-
-UI Modes:
-  crewx                          Web dashboard (port 8150, random token, auto-open)
-  crewx serve [options]          Web server (explicit)
-    --port <N>                   Port (default: 8150)
-    --token <T>                  MCP bearer token (⚠️  use --token-file in shared shells)
-    --token-file <PATH>          Read bearer token from file
-    --no-open                    Do not auto-open browser
-  crewx electron [--overlay]     Launch Electron (desktop or overlay window)
-
-Query / Execute:
-  q|query "@agent <message>"     Query an agent (quoted single string)
-  x|execute "@agent <task>"      Execute a task with an agent (quoted single string)
-
-  @agent is optional — defaults to @crewx when omitted.
-
-  Common flags:
-    --thread <name>              Conversation thread
-    --provider <cli/xxx>         Provider override
-    --metadata <json>            Extra metadata (JSON object, double-quoted). Propagated to events/hooks/tracing.
-                                 Invalid JSON aborts with exit code 2.
-                                 e.g. --metadata='{"workflow_id":"wf-1"}'
-    --verbose                    Debug output mode (default: raw response only)
-    --config/-c <path>           Config file path (default: CREWX_CONFIG or crewx.yaml)
-    --output-format <fmt>        Output format (json|text|stream-json)
-    --effort <level>             Model effort (high|medium|low)
-    -f/--prompt-file <path>      Read task body from file (bypasses argv length limits)
-    --                           End of flags; remaining tokens treated as message text
-                                 e.g. crewx q "@agent label" -- --flag-in-message
-
-Agent Management:
-  agent ls [options]             List configured agents
-    --role <value>               Filter by role (comma-separated for OR match)
-    --team <value>               Filter by team (comma-separated for OR match)
-    --provider <value>           Filter by provider (comma-separated for OR match)
-  agent prompt <@id>             Show rendered system prompt for an agent
-
-Task Management:
-  ps                             List running tasks
-  kill <task-id>                 Kill a running task
-  kill --all                     Kill all running tasks
-  result [task-id]               Get task result (or list recent tasks)
-
-Logs & Diagnostics:
-  log [ls|<task-id>]             View task logs
-  doctor [--config <path>]       Run system diagnosis
-  init [--force] [--config <p>]  Initialize crewx.yaml
-
-Built-in Tools:
-  memory <args>                  Memory tool
-  search <args>                  Search tool
-  doc <args>                     Doc tool
-  wbs <args>                     WBS tool
-  cron <args>                    Cron tool
-  workflow <args>                Workflow tool
-  skill <args>                   Skill tool
-
-Hook Platform:
-  hook install [--yes]           Install PreToolUse hook in .claude/settings.json
-  hook uninstall                 Remove crewx hook from .claude/settings.json
-  hook status                    Show hook installation status and plugins
-  hook-dispatch                  Internal: IPC router called by Claude (stdin→stdout)
-
-Global Options:
-  --help, -h                     Show this help
-  --version, -v                  Show version
+    console.log(`
+CrewX CLI v${version_1.CLI_VERSION}
+
+Usage:
+  crewx                          Launch web dashboard + open browser (default)
+  crewx <command> [options]
+
+UI Modes:
+  crewx                          Web dashboard (port 8150, random token, auto-open)
+  crewx serve [options]          Web server (explicit)
+    --port <N>                   Port (default: 8150)
+    --token <T>                  MCP bearer token (⚠️  use --token-file in shared shells)
+    --token-file <PATH>          Read bearer token from file
+    --no-open                    Do not auto-open browser
+  crewx electron [--overlay]     Launch Electron (desktop or overlay window)
+
+Query / Execute:
+  q|query "@agent <message>"     Query an agent (quoted single string)
+  x|execute "@agent <task>"      Execute a task with an agent (quoted single string)
+
+  @agent is optional — defaults to @crewx when omitted.
+
+  Common flags:
+    --thread <name>              Conversation thread
+    --provider <cli/xxx>         Provider override
+    --metadata <json>            Extra metadata (JSON object, double-quoted). Propagated to events/hooks/tracing.
+                                 Invalid JSON aborts with exit code 2.
+                                 e.g. --metadata='{"workflow_id":"wf-1"}'
+    --verbose                    Debug output mode (default: raw response only)
+    --config/-c <path>           Config file path (default: CREWX_CONFIG or crewx.yaml)
+    --output-format <fmt>        Output format (json|text|stream-json)
+    --effort <level>             Model effort (high|medium|low)
+    -f/--prompt-file <path>      Read task body from file (bypasses argv length limits)
+    --                           End of flags; remaining tokens treated as message text
+                                 e.g. crewx q "@agent label" -- --flag-in-message
+
+Agent Management:
+  agent ls [options]             List configured agents
+    --role <value>               Filter by role (comma-separated for OR match)
+    --team <value>               Filter by team (comma-separated for OR match)
+    --provider <value>           Filter by provider (comma-separated for OR match)
+  agent prompt <@id>             Show rendered system prompt for an agent
+
+Task Management:
+  ps                             List running tasks
+  kill <task-id>                 Kill a running task
+  kill --all                     Kill all running tasks
+  result [task-id]               Get task result (or list recent tasks)
+
+Logs & Diagnostics:
+  log [ls|<task-id>]             View task logs
+  doctor [--config <path>]       Run system diagnosis
+  init [--force] [--config <p>]  Initialize crewx.yaml
+
+Built-in Tools:
+  memory <args>                  Memory tool
+  search <args>                  Search tool
+  doc <args>                     Doc tool
+  wbs <args>                     WBS tool
+  cron <args>                    Cron tool
+  workflow <args>                Workflow tool
+  skill <args>                   Skill tool
+
+Hook Platform:
+  hook install [--yes]           Install PreToolUse hook in .claude/settings.json
+  hook uninstall                 Remove crewx hook from .claude/settings.json
+  hook status                    Show hook installation status and plugins
+  hook-dispatch                  Internal: IPC router called by Claude (stdin→stdout)
+
+Global Options:
+  --help, -h                     Show this help
+  --version, -v                  Show version
 `.trim());
 }
 main().catch((err) => {

package/dist/plugins/examples/echo-hook.d.ts

@@ -0,0 +1,24 @@
+/**
+ * EchoObserverPlugin — Tool observer that echoes events to a JSONL log.
+ *
+ * Observes tool:before / tool:after events from the Crewx event bus
+ * and appends them as JSONL to ~/.crewx/logs/echo-hook.log.
+ * Pure observer — no flow control (deny/inject/modify not applicable).
+ */
+import { ToolObserverPlugin } from '@crewx/sdk/hooks';
+import type { ObserverContext, ObserverResult } from '@crewx/sdk/hooks';
+export declare class EchoHookPlugin extends ToolObserverPlugin {
+    readonly name = "echo-hook";
+    readonly version = "0.0.1";
+    readonly on: {
+        beforeTool: true;
+        afterTool: true;
+        beforePrompt: true;
+        sessionStart: true;
+    };
+    private readonly logPath;
+    constructor(logDir?: string);
+    run(ctx: ObserverContext): Promise<ObserverResult>;
+    private ensureLogDir;
+    private echo;
+}

package/dist/plugins/examples/echo-hook.js

@@ -0,0 +1,60 @@
+"use strict";
+/**
+ * EchoObserverPlugin — Tool observer that echoes events to a JSONL log.
+ *
+ * Observes tool:before / tool:after events from the Crewx event bus
+ * and appends them as JSONL to ~/.crewx/logs/echo-hook.log.
+ * Pure observer — no flow control (deny/inject/modify not applicable).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EchoHookPlugin = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const os_1 = require("os");
+const hooks_1 = require("@crewx/sdk/hooks");
+class EchoHookPlugin extends hooks_1.ToolObserverPlugin {
+    name = 'echo-hook';
+    version = '0.0.1';
+    on = {
+        beforeTool: true,
+        afterTool: true,
+        beforePrompt: true,
+        sessionStart: true,
+    };
+    logPath;
+    constructor(logDir) {
+        super();
+        this.logPath = (0, path_1.join)(logDir ?? (0, os_1.homedir)(), '.crewx', 'logs', 'echo-hook.log');
+        this.ensureLogDir();
+    }
+    async run(ctx) {
+        this.echo(ctx);
+        return ctx.pass();
+    }
+    ensureLogDir() {
+        const dir = (0, path_1.dirname)(this.logPath);
+        if (!(0, fs_1.existsSync)(dir)) {
+            (0, fs_1.mkdirSync)(dir, { recursive: true, mode: 0o700 });
+        }
+    }
+    echo(ctx) {
+        try {
+            const line = JSON.stringify({
+                timestamp: new Date().toISOString(),
+                event: ctx.event,
+                traceId: ctx.traceId,
+                agent: ctx.agent,
+                provider: ctx.provider,
+                thread: ctx.thread,
+                tool: ctx.tool,
+                cwd: ctx.cwd,
+                sessionId: ctx.sessionId,
+            });
+            (0, fs_1.appendFileSync)(this.logPath, line + '\n', { encoding: 'utf8', mode: 0o600 });
+        }
+        catch {
+            // Non-fatal
+        }
+    }
+}
+exports.EchoHookPlugin = EchoHookPlugin;

package/dist/plugins/examples/verify-echo-hook.d.ts

@@ -0,0 +1,8 @@
+#!/usr/bin/env npx tsx
+/**
+ * Phase 0 e2e verification — EchoHookPlugin logs Claude Code tool calls.
+ *
+ * Run: npx tsx packages/cli/src/plugins/examples/verify-echo-hook.ts
+ * Prereq: claude CLI installed, crewx.yaml with @claude agent
+ */
+export {};