@pixelml/agenticflow-cli 0.1.0 → 1.0.0

package/README.md

@@ -1,71 +1,273 @@
 # AgenticFlow CLI
 
-Agent-native CLI for AgenticFlow public APIs.
+A command-line interface for the [AgenticFlow](https://agenticflow.ai) platform.
+Manage agents, workflows, connections, and more — directly from your terminal.
 
-## Features
+Built on the `@pixelml/agenticflow-sdk`.
 
-- OpenAPI-backed operation discovery and invocation.
-- High-level commands for workflows, agents, node types, and connections.
-- API-key-based auth profiles (`AGENTICFLOW_PUBLIC_API_KEY`).
-- Preflight checks (`doctor`) and capability catalog (`catalog`).
-- Local guardrails (`policy`) and audit log support.
-- Built-in CLI playbooks (no MCP required).
+## Installation
 
-## Install (Python)
+```bash
+npm install -g @pixelml/agenticflow-cli
+```
+
+Or run directly via `npx`:
+
+```bash
+npx @pixelml/agenticflow-cli --help
+```
+
+## Authentication
+
+### Option 1: Environment variables
 
 ```bash
-pip install agenticflow-cli
+export AGENTICFLOW_API_KEY="sk-..."
+export AGENTICFLOW_WORKSPACE_ID="ws-..."
+export AGENTICFLOW_PROJECT_ID="proj-..."
 ```
 
-Then run:
+### Option 2: Import from `.env` file
 
 ```bash
-agenticflow --help
+agenticflow auth import-env --file .env
 ```
 
-## Install (from source)
+This writes credentials to `~/.agenticflow/auth.json` and they are used
+automatically for all commands.
+
+### Option 3: CLI flags
 
 ```bash
-python -m pip install -e .
-agenticflow --help
+agenticflow --api-key sk-... --workspace-id ws-... agent list
 ```
 
-## Auth
+**Priority order**: CLI flag → environment variable → `~/.agenticflow/auth.json`
 
-Use API key only:
+### Verify credentials
 
 ```bash
-export AGENTICFLOW_PUBLIC_API_KEY=...
-agenticflow doctor --json
+agenticflow auth whoami
+```
+
+```
+Profile:      default
+API Key:      present
+Workspace ID: ws-abc123
+Project ID:   proj-xyz789
+Config:       ~/.agenticflow/auth.json
 ```
 
-Or import from env file:
+## Usage
+
+### Agents
 
 ```bash
-agenticflow auth import-env --file ./.env --profile default
-agenticflow auth whoami --json
+# List agents
+agenticflow agent list
+
+# Get agent details
+agenticflow agent get <agent-id>
+
+# Create an agent
+agenticflow agent create --body '{"name": "My Agent"}'
+
+# Update an agent
+agenticflow agent update <agent-id> --body '{"name": "Updated"}'
+
+# Delete an agent
+agenticflow agent delete <agent-id>
+
+# Stream a message to an agent
+agenticflow agent stream <agent-id> --body '{"input": "Hello"}'
+
+# Publishing
+agenticflow agent publish-info <agent-id>
+agenticflow agent publish <agent-id> --body '{"platform": "web"}'
+agenticflow agent unpublish <agent-id> --body '{"platform": "web"}'
+
+# Reference impact
+agenticflow agent reference-impact <agent-id>
+
+# Save as template
+agenticflow agent save-as-template <agent-id> --body '{...}'
 ```
 
-`--token` bearer override is intentionally unsupported.
+### Workflows
+
+```bash
+# List workflows
+agenticflow workflow list
+
+# Get workflow details
+agenticflow workflow get <workflow-id>
+
+# Create / update / delete
+agenticflow workflow create --body '{...}'
+agenticflow workflow update <workflow-id> --body '{...}'
+agenticflow workflow delete <workflow-id>
+
+# Run a workflow
+agenticflow workflow run --body '{"workflow_id": "wf-123", "input": {}}'
+
+# Check run status
+agenticflow workflow run-status <run-id>
+
+# List runs for a workflow
+agenticflow workflow list-runs <workflow-id>
+
+# Run history
+agenticflow workflow run-history <workflow-id>
+
+# Validate a workflow definition
+agenticflow workflow validate --body '{...}'
 
-## Node Wrapper (npm)
+# Like / unlike
+agenticflow workflow like <workflow-id>
+agenticflow workflow unlike <workflow-id>
+agenticflow workflow like-status <workflow-id>
+```
 
-This repo also ships a thin npm wrapper package (`@pixelml/agenticflow-cli`) that invokes the Python CLI.
+### Connections
 
 ```bash
-npm i -g @pixelml/agenticflow-cli
-agenticflow --help
+# List connections
+agenticflow connections list
+
+# Create a connection
+agenticflow connections create --body '{...}'
+
+# Get default connection for a category
+agenticflow connections get-default --category <name>
+
+# Update / delete
+agenticflow connections update <connection-id> --body '{...}'
+agenticflow connections delete <connection-id>
+
+# List connection categories
+agenticflow connections categories
+
+# Health checks
+agenticflow connections health-check-pre --body '{...}'
+agenticflow connections health-check-post <connection-id>
 ```
 
-The wrapper requires Python 3.10+ with `agenticflow-cli` installed or importable.
+### Node Types
+
+```bash
+# List all node types
+agenticflow node-types list
 
-## Release Tags
+# Get a specific node type
+agenticflow node-types get <name>
 
-- Python release: `py-vX.Y.Z`
-- npm wrapper release: `npm-vX.Y.Z`
+# Search node types
+agenticflow node-types search <query>
+
+# Get dynamic options
+agenticflow node-types dynamic-options --name <name> --field-name <field>
+```
+
+### Uploads
+
+```bash
+# Create an upload session
+agenticflow uploads create --body '{...}'
+
+# Check upload session status
+agenticflow uploads status <session-id>
+```
+
+### Generic API Calls
+
+For any API endpoint not covered by resource commands:
+
+```bash
+# By operation ID
+agenticflow call --operation-id getAgentModel
+
+# By method + path
+agenticflow call --method GET --path /v1/agents/
+
+# With parameters
+agenticflow call --operation-id updateAgent \
+  -P agent_id=abc123 \
+  --body '{"name": "Updated"}'
+
+# With query parameters
+agenticflow call --method GET --path /v1/agents/ \
+  -Q limit=10 -Q offset=0
+
+# Dry run (show request without executing)
+agenticflow call --operation-id listAgents --dry-run
+```
+
+### Operations Discovery
+
+```bash
+# List all available operations
+agenticflow ops list
+
+# Show details of an operation
+agenticflow ops show <operation-id>
+```
+
+### Preflight Check
+
+```bash
+agenticflow doctor
+```
+
+Runs connectivity checks, validates API key, and verifies the OpenAPI spec.
+
+### Other Commands
+
+```bash
+# Catalog management
+agenticflow catalog export
+agenticflow catalog rank
+
+# Policy management
+agenticflow policy show
+agenticflow policy init
+
+# Playbook management
+agenticflow playbook list
+agenticflow playbook export
+```
+
+## Global Options
+
+| Flag | Description |
+|---|---|
+| `--api-key <key>` | API key for authentication |
+| `--workspace-id <id>` | Default workspace ID |
+| `--project-id <id>` | Default project ID |
+| `--spec-file <path>` | Path to OpenAPI spec JSON file |
+| `--json` | Force JSON output |
+| `--version` | Show version |
+| `--help` | Show help |
+
+## Output
+
+All commands output JSON by default:
+
+```json
+{
+  "status": 200,
+  "body": { ... }
+}
+```
+
+Error responses set a non-zero exit code:
+
+```json
+{
+  "status": 404,
+  "body": { "detail": "Not found" }
+}
+```
 
-## OSS Hygiene
+## License
 
-- No hardcoded secrets in CLI code path.
-- `.env*` and `.agenticflow/` are ignored.
-- Users provide their own `AGENTICFLOW_PUBLIC_API_KEY`.
+Apache-2.0

package/dist/bin/agenticflow.d.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+/**
+ * AgenticFlow CLI entry point.
+ */
+export {};
+//# sourceMappingURL=agenticflow.d.ts.map

package/dist/bin/agenticflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agenticflow.d.ts","sourceRoot":"","sources":["../../src/bin/agenticflow.ts"],"names":[],"mappings":";AAEA;;GAEG"}

package/dist/bin/agenticflow.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * AgenticFlow CLI entry point.
+ */
+import { runCli } from "../cli/main.js";
+runCli().catch((err) => {
+    console.error(err instanceof Error ? err.message : err);
+    process.exit(1);
+});
+//# sourceMappingURL=agenticflow.js.map

package/dist/bin/agenticflow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"agenticflow.js","sourceRoot":"","sources":["../../src/bin/agenticflow.ts"],"names":[],"mappings":";AAEA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACxD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/dist/cli/client.d.ts

@@ -0,0 +1,17 @@
+/**
+ * HTTP request builder helpers for AgenticFlow CLI commands.
+ */
+import type { Operation } from "./spec.js";
+export interface RequestSpec {
+    method: string;
+    url: string;
+    params: Record<string, string>;
+    headers: Record<string, string>;
+    body?: unknown;
+    json?: unknown;
+}
+export declare function parseKeyValuePairs(rawValues: string[]): Record<string, string>;
+export declare function loadJsonPayload(raw: string): unknown;
+export declare function resolveApiKey(explicitKey?: string | null): string | null;
+export declare function buildRequestSpec(operation: Operation, baseUrl: string, pathParams: Record<string, string>, queryParams: Record<string, string>, extraHeaders: Record<string, string>, token?: string | null, body?: unknown): RequestSpec;
+//# sourceMappingURL=client.d.ts.map

package/dist/cli/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/cli/client.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAa9E;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAoBpD;AAED,wBAAgB,aAAa,CAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAC1B,MAAM,GAAG,IAAI,CAGf;AAED,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAClC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACnC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACpC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,IAAI,CAAC,EAAE,OAAO,GACb,WAAW,CA4Bb"}

package/dist/cli/client.js

@@ -0,0 +1,102 @@
+/**
+ * HTTP request builder helpers for AgenticFlow CLI commands.
+ */
+import { readFileSync } from "node:fs";
+export function parseKeyValuePairs(rawValues) {
+    const parsed = {};
+    for (const raw of rawValues) {
+        if (!raw.includes("=")) {
+            throw new Error(`Invalid key-value pair: ${raw}`);
+        }
+        const idx = raw.indexOf("=");
+        const key = raw.slice(0, idx);
+        const value = raw.slice(idx + 1);
+        if (!key)
+            throw new Error(`Invalid key-value pair: ${raw}`);
+        parsed[key] = value;
+    }
+    return parsed;
+}
+export function loadJsonPayload(raw) {
+    let payloadText;
+    if (raw.startsWith("@")) {
+        const filePath = raw.slice(1).trim();
+        if (!filePath)
+            throw new Error(`Unable to read body file: ${raw}`);
+        try {
+            payloadText = readFileSync(filePath, "utf-8");
+        }
+        catch {
+            throw new Error(`Unable to read body file: ${raw}`);
+        }
+    }
+    else {
+        payloadText = raw;
+    }
+    try {
+        return JSON.parse(payloadText);
+    }
+    catch {
+        throw new Error(`Invalid JSON payload: ${raw}`);
+    }
+}
+export function resolveApiKey(explicitKey) {
+    if (explicitKey)
+        return explicitKey;
+    return process.env["AGENTICFLOW_PUBLIC_API_KEY"] ?? null;
+}
+export function buildRequestSpec(operation, baseUrl, pathParams, queryParams, extraHeaders, token, body) {
+    const normalizedUrl = baseUrl.replace(/\/+$/, "");
+    const formattedPath = formatPath(operation.path, pathParams);
+    const normalizedPath = formattedPath.startsWith("/") ? formattedPath : `/${formattedPath}`;
+    const url = `${normalizedUrl}${normalizedPath}`;
+    const headers = { ...extraHeaders };
+    if (token) {
+        headers["Authorization"] = `Bearer ${token}`;
+    }
+    if (body != null) {
+        const hasContentType = Object.keys(headers).some((k) => k.toLowerCase() === "content-type");
+        if (!hasContentType) {
+            headers["Content-Type"] = "application/json";
+        }
+    }
+    return {
+        method: operation.method.toUpperCase(),
+        url,
+        params: { ...queryParams },
+        headers,
+        body,
+        json: body,
+    };
+}
+function formatPath(path, pathParams) {
+    if (!path.includes("{"))
+        return path;
+    const required = extractPathParameterNames(path);
+    const missing = required.filter((name) => !(name in pathParams));
+    if (missing.length > 0) {
+        throw new Error(`Missing required path parameters: ${missing.sort().join(", ")}`);
+    }
+    let formatted = path;
+    for (const name of required) {
+        formatted = formatted.replace(`{${name}}`, encodeURIComponent(pathParams[name]));
+    }
+    return formatted;
+}
+function extractPathParameterNames(path) {
+    const names = [];
+    let inBraces = false;
+    let start = 0;
+    for (let i = 0; i < path.length; i++) {
+        if (path[i] === "{") {
+            inBraces = true;
+            start = i + 1;
+        }
+        else if (path[i] === "}" && inBraces) {
+            names.push(path.slice(start, i));
+            inBraces = false;
+        }
+    }
+    return names;
+}
+//# sourceMappingURL=client.js.map

package/dist/cli/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/cli/client.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAYvC,MAAM,UAAU,kBAAkB,CAAC,SAAmB;IACpD,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;QAC9B,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QACjC,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,GAAW;IACzC,IAAI,WAAmB,CAAC;IAExB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC;YACH,WAAW,GAAG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;SAAM,CAAC;QACN,WAAW,GAAG,GAAG,CAAC;IACpB,CAAC;IAED,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,EAAE,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,WAA2B;IAE3B,IAAI,WAAW;QAAE,OAAO,WAAW,CAAC;IACpC,OAAO,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,IAAI,IAAI,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,SAAoB,EACpB,OAAe,EACf,UAAkC,EAClC,WAAmC,EACnC,YAAoC,EACpC,KAAqB,EACrB,IAAc;IAEd,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAClD,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC7D,MAAM,cAAc,GAAG,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,aAAa,EAAE,CAAC;IAC3F,MAAM,GAAG,GAAG,GAAG,aAAa,GAAG,cAAc,EAAE,CAAC;IAEhD,MAAM,OAAO,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;IACpC,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,KAAK,EAAE,CAAC;IAC/C,CAAC;IAED,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACjB,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAC9C,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,cAAc,CAC1C,CAAC;QACF,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE;QACtC,GAAG;QACH,MAAM,EAAE,EAAE,GAAG,WAAW,EAAE;QAC1B,OAAO;QACP,IAAI;QACJ,IAAI,EAAE,IAAI;KACX,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,IAAY,EAAE,UAAkC;IAClE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAErC,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;IACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,UAAU,CAAC,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,qCAAqC,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC5B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,EAAE,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,yBAAyB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YACpB,QAAQ,GAAG,IAAI,CAAC;YAChB,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;aAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,QAAQ,EAAE,CAAC;YACvC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;YACjC,QAAQ,GAAG,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}