@andreprado/agentkit 0.1.0-alpha.2 → 0.1.0-alpha.21

package/src/cli/help.ts

@@ -0,0 +1,236 @@
+export function renderHelp(): string {
+  return `AgentKit
+
+Create, run, inspect, and deploy Agent Capsules.
+
+Quick start:
+  agentkit new support-agent --template support
+  cd support-agent
+  npm run dev
+  npm run chat -- --message "hello"
+
+Usage:
+  agentkit <command> [options]
+
+Start:
+  agentkit new <name> [--template blank|support|dentista] [--no-install]
+  agentkit dev
+  agentkit open
+  agentkit chat-ui --deploy
+  agentkit chat --message <text> [--conversation-id <id>]
+  agentkit inspect
+
+Build:
+  agentkit knowledge add <path>
+  agentkit knowledge search <query>
+  agentkit spec init --brief <text>
+  agentkit sync run
+  agentkit tool <name> [--input <path-or-json>]
+  agentkit db migrate
+  agentkit eval run
+  agentkit eval from-conversation <id>
+  agentkit improve collect --deploy --since 24h
+  agentkit feedback create --about last-run --kind bug --summary <text>
+  agentkit replay <bundle-dir> --against local
+  agentkit conversations list
+
+Deploy:
+  agentkit login --token <token>
+  agentkit deploy doctor
+  agentkit secret set <NAME> --stdin
+  agentkit secret sync --from-local
+  agentkit deploy --smoke "hello"
+  agentkit deploy status
+
+More:
+  agentkit channels ...
+  agentkit integrations status
+  agentkit billing checkout --slots <count>
+  agentkit account token ...
+  agentkit access token ...
+  agentkit env ...
+  agentkit feedback create --summary <text>
+  agentkit docs full
+  agentkit help commands
+`;
+}
+
+export function renderCommandReference(): string {
+  return `AgentKit Command Reference
+
+Usage:
+  agentkit new <name> [--template blank|support|dentista] [--no-install]
+  agentkit dev [--port <number>]
+  agentkit open
+  agentkit chat-ui --deploy [--port <number>] [--token-file <path>]
+  agentkit chat --message <text> [--conversation-id <id>]
+  agentkit tool <name> [--input <path-or-json>]
+  agentkit knowledge add <path-or-url>
+  agentkit knowledge sync
+  agentkit knowledge inspect
+  agentkit knowledge search <query> [--top-k <number>]
+  agentkit spec init --brief <text> [--out <path>] [--force]
+  agentkit spec check [--file <path>]
+  agentkit sync init [--force]
+  agentkit sync run [--file <path>]
+  agentkit db migrate
+  agentkit db reset --yes
+  agentkit db shell
+  agentkit db seed [--file <path>]
+  agentkit eval run
+  agentkit eval from-conversation <conversation-id> [--out <path>] [--force]
+  agentkit improve collect [--deploy] [--since <duration|iso>] [--conversation-id <id>] [--out <directory>]
+  agentkit improve evals <bundle-dir-or-json> [--force]
+  agentkit feedback create [--about last-run|deploy|manual] [--kind bug|confusion|missing_docs|feature_request|deploy_issue|runtime_issue|other] --summary <text> [--message <text>] [--out <path>]
+  agentkit feedback preview [draft.json]
+  agentkit feedback send [draft.json] [--about last-run|deploy|manual] [--kind <kind>] --summary <text> [--message <text>] [--api <url>] [--save]
+  agentkit replay <bundle-dir-or-json> --against local
+  agentkit conversations list [--deploy]
+  agentkit conversations show <conversation-id> [--deploy]
+  agentkit conversations trace <conversation-id> [--deploy]
+  agentkit channels list
+  agentkit channels add <website|telegram|whatsapp|discord|slack|webhook> <name> [--provider zapster|meta|uazapi|evolution] [--mode interactions|bot] [--api <url>]
+  agentkit channels connect <website|telegram|whatsapp|discord|slack|webhook> <name> [--provider zapster|meta|uazapi|evolution] [--mode interactions|bot] [--api <url>]
+  agentkit channels setup <name> [--apply] [--api <url>]
+  agentkit channels status <name> [--api <url>]
+  agentkit channels doctor <name> [--api <url>]
+  agentkit channels test <name> [--message <text>] [--fixture <path>] [--api <url>]
+  agentkit channels test-audio <name> [--fixture voice-note|audio-file|<path>] [--api <url>]
+  agentkit channels deliveries list <name> [--api <url>]
+  agentkit channels deliveries show <delivery-id> [--api <url>]
+  agentkit channels buffers list <name> [--api <url>]
+  agentkit channels buffers show [<name>] <conversation-id> [--api <url>]
+  agentkit channels buffers flush [<name>] <conversation-id> [--api <url>]
+  agentkit channels buffers clear [<name>] <conversation-id> [--api <url>]
+  agentkit channels buffers retry [<name>] <conversation-id> [--api <url>]
+  agentkit integrations status [--toolkit <slug>] [--api <url>]
+  agentkit integrations connect composio [--toolkit <slug>] [--callback-url <url>] [--api <url>]
+  agentkit skills status
+  agentkit skills sync
+  agentkit inspect
+  agentkit build [--target cloudflare|container]
+  agentkit login --token <token> [--api <url>]
+  agentkit logout
+  agentkit billing checkout --slots <count> [--email <email>] [--api <url>]
+  agentkit billing status <billing-intent-id> --secret <secret> [--api <url>]
+  agentkit billing claim <billing-intent-id> --secret <secret> [--token-name <name>] [--api <url>]
+  agentkit billing portal [--api <url>]
+  agentkit account token create <name> [--api <url>] [--use] [--out <path>]
+  agentkit account token list [--api <url>]
+  agentkit account token revoke <token-id> [--api <url>]
+  agentkit deploy [--target cloudflare|vps] [--host <host>] [--api <url>] [--dry-run] [--anonymous] [--local-wrangler] [--smoke <message>]
+  agentkit deploy doctor [--api <url>] [--anonymous]
+  agentkit deploy smoke [--message <text>] [--api <url>]
+  agentkit deploy status [--api <url>]
+  agentkit deploy pause [--api <url>]
+  agentkit deploy resume [--api <url>]
+  agentkit transcribe smoke [--provider test|openai|groq] [--model <model>] [--fixture <audio-file>]
+  agentkit secret set <NAME> <VALUE> [--api <url>]
+  agentkit secret set <NAME> --stdin [--api <url>]
+  agentkit secret set <NAME> --from-env [ENV_NAME] [--api <url>]
+  agentkit secret set <NAME> --from-local-env [--api <url>]
+  agentkit secret sync --from-local [--api <url>]
+  agentkit secret list [--api <url>]
+  agentkit secret unset <NAME> [--api <url>]
+  agentkit access token create <name> [--api <url>] [--out <path>]
+  agentkit access token list [--api <url>]
+  agentkit access token revoke <token-id> [--api <url>]
+  agentkit env set <NAME> <VALUE>
+  agentkit env set <NAME> --stdin
+  agentkit env set <NAME> --from-env [ENV_NAME]
+  agentkit env list
+  agentkit env unset <NAME>
+  agentkit docs path
+  agentkit docs llms
+  agentkit docs full
+  agentkit handoff codex [goal]
+  agentkit help commands
+  agentkit --help
+
+Commands:
+  new             Create a new Agent Capsule
+  dev             Run the Agent Capsule locally
+  open            Open the local Agent Capsule UI if it is already running
+  chat-ui         Run a local chat UI, optionally pointed at a hosted deploy
+  chat            Send one message to the local Agent Capsule
+  tool            Run one registered tool directly
+  knowledge       Add, sync, inspect, and search local Knowledge sources
+  spec            Create or check the agent implementation contract from the owner brief
+  sync            Run or scaffold catalog/data synchronization
+  db              Manage the local SQLite database
+  eval            Run local eval files or create one from a conversation
+  improve         Collect production or local traces and generate regression evals
+  feedback        Create local redacted feedback drafts and send them to AgentKit Cloud
+  replay          Replay an improve bundle against the local Agent Capsule
+  conversations   List, inspect, and trace stored local conversations
+  channels        Manage hosted channel resources
+  integrations    Manage hosted AgentKit-managed integrations
+  skills          Check or refresh local AgentKit skill files
+  transcribe      Smoke-test audio transcription providers
+  inspect         Print machine-readable Agent Capsule state
+  build           Build a hosted deploy artifact
+  login           Store an AgentKit Cloud alpha token outside the capsule
+  logout          Remove the stored AgentKit Cloud alpha token
+  billing         Buy deploy slots, claim checkout tokens, and open the billing portal
+  account         Manage AgentKit Cloud account tokens
+  deploy          Build and send a hosted artifact to AgentKit Cloud
+  secret          Manage hosted AgentKit Cloud secrets without readback
+  access          Manage hosted deploy access tokens
+  env             Manage local .env values without opening code
+  docs            Print AgentKit docs locations
+  handoff         Print a ready-to-paste prompt for another coding agent
+  help            Print focused help or the full command reference
+
+Examples:
+  agentkit new support-agent --template support
+  cd support-agent
+  agentkit dev
+  agentkit open
+  agentkit tool lookup_order --input '{"orderId":"A100"}'
+  agentkit eval run
+
+  agentkit new clara-dentista --template dentista
+`;
+}
+
+export function renderCommandHelp(command: string): string {
+  const usage: Record<string, string> = {
+    new: "agentkit new <name> [--template blank|support|dentista] [--no-install]",
+    dev: "agentkit dev [--port <number>]",
+    open: "agentkit open",
+    "chat-ui": "agentkit chat-ui --deploy [--port <number>] [--token-file <path>]",
+    chat: 'agentkit chat --message "hello" [--conversation-id <id>]',
+    tool: "agentkit tool <name> [--input <path-or-json>]",
+    knowledge: "agentkit knowledge add <path-or-url> | sync | inspect | search <query> [--top-k <number>]",
+    spec: 'agentkit spec init --brief "owner request" | agentkit spec check',
+    sync: "agentkit sync init [--force] | agentkit sync run [--file <path>]",
+    eval: "agentkit eval run | agentkit eval from-conversation <conversation-id> [--out <path>] [--force]",
+    improve:
+      "agentkit improve collect [--deploy] [--since <duration|iso>] [--conversation-id <id>] [--out <directory>] | agentkit improve evals <bundle-dir-or-json> [--force]",
+    feedback:
+      "agentkit feedback create|preview|send [draft.json] [--about last-run|deploy|manual] [--kind <kind>] [--summary <text>] [--message <text>]",
+    replay: "agentkit replay <bundle-dir-or-json> --against local",
+    conversations:
+      "agentkit conversations list [--deploy] | agentkit conversations show <conversation-id> [--deploy] | agentkit conversations trace <conversation-id> [--deploy]",
+    channels:
+      "agentkit channels list | add | connect | setup | status | doctor | test | test-audio | deliveries | buffers",
+    skills: "agentkit skills status | agentkit skills sync",
+    transcribe: "agentkit transcribe smoke [--provider test|openai|groq] [--model <model>] [--fixture <audio-file>]",
+    deploy:
+      'agentkit deploy [--smoke "hello"] | agentkit deploy smoke [--message "hello"] | agentkit deploy doctor | status | pause | resume',
+    secret:
+      "agentkit secret set <NAME> --stdin | --from-env [ENV_NAME] | --from-local-env | agentkit secret sync --from-local | list | unset <NAME>",
+    access: "agentkit access token create <name> [--out <path>] | list | revoke <token-id>",
+    account: "agentkit account token create <name> [--use] [--out <path>] | list | revoke <token-id>",
+    billing:
+      "agentkit billing checkout --slots <count> [--email <email>] | status <intent-id> --secret <secret> | claim <intent-id> --secret <secret> | portal",
+    integrations: "agentkit integrations status [--toolkit <slug>] | agentkit integrations connect composio [--toolkit <slug>]",
+    env: "agentkit env set <NAME> --stdin | --from-env [ENV_NAME] | list | unset <NAME>",
+    docs: "agentkit docs path | llms | full",
+    handoff: "agentkit handoff codex [goal] | agentkit handoff claude [goal]",
+  };
+
+  return `Usage: ${usage[command] ?? "agentkit <command> [options]"}
+
+Run \`agentkit help commands\` for the full command reference.`;
+}