diff --git a/src/cli/program/core-command-descriptors.ts b/src/cli/program/core-command-descriptors.ts index d54f03e0588..85d915a0bf2 100644 --- a/src/cli/program/core-command-descriptors.ts +++ b/src/cli/program/core-command-descriptors.ts @@ -6,12 +6,12 @@ export type CoreCliCommandDescriptor = NamedCommandDescriptor; const coreCliCommandCatalog = defineCommandDescriptorCatalog([ { name: "crestodian", - description: "Open the ring-zero setup and repair helper", + description: "Open the interactive setup and repair assistant", hasSubcommands: false, }, { name: "setup", - description: "Initialize local config and agent workspace", + description: "Initialize local config and an agent workspace", hasSubcommands: false, }, { @@ -42,7 +42,7 @@ const coreCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "doctor", - description: "Health checks + quick fixes for the gateway and channels", + description: "Diagnose and repair config, Gateway, plugin, and channel problems", hasSubcommands: false, }, { @@ -62,7 +62,7 @@ const coreCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "message", - description: "Send, read, and manage messages", + description: "Send, read, and manage channel messages", hasSubcommands: true, }, { @@ -82,12 +82,12 @@ const coreCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "status", - description: "Show channel health and recent session recipients", + description: "Show Gateway, channel, model, and recent-session status", hasSubcommands: false, }, { name: "health", - description: "Fetch health from the running gateway", + description: "Fetch detailed health from the running Gateway", hasSubcommands: false, }, { @@ -102,7 +102,7 @@ const coreCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "tasks", - description: "Inspect durable background task state", + description: "Inspect durable background tasks and flows", hasSubcommands: true, }, ] as const satisfies ReadonlyArray); diff --git a/src/cli/program/help.ts b/src/cli/program/help.ts index 0f428ca77c9..3b9b5770a60 100644 --- a/src/cli/program/help.ts +++ b/src/cli/program/help.ts @@ -22,22 +22,17 @@ const ROOT_COMMANDS_HINT = "Hint: commands suffixed with * have subcommands. Run --help for details."; const EXAMPLES = [ - ["openclaw models --help", "Show detailed help for the models command."], - [ - "openclaw channels login --verbose", - "Link personal WhatsApp Web and show QR + connection logs.", - ], - [ - 'openclaw message send --target +15555550123 --message "Hi" --json', - "Send via your web session and print JSON result.", - ], - ["openclaw gateway --port 18789", "Run the WebSocket Gateway locally."], + ["openclaw onboard", "Run guided setup for a local Gateway, workspace, auth, and channels."], + ["openclaw status", "Check Gateway, channel, model, and recent-session status."], + ["openclaw doctor --fix", "Repair common config, service, plugin, and channel problems."], + ["openclaw channels status", "See connected messaging accounts and login state."], ["openclaw --dev gateway", "Run a dev Gateway (isolated state/config) on ws://127.0.0.1:19001."], - ["openclaw gateway --force", "Kill anything bound to the default gateway port, then start it."], - ["openclaw gateway ...", "Gateway control via WebSocket."], + ["openclaw gateway run --force", "Start the Gateway and replace anything bound to its port."], + ["openclaw models status", "Show model/provider auth health before running agents."], + ["openclaw plugins list", "Inspect enabled, disabled, and installed plugins."], [ 'openclaw agent --to +15555550123 --message "Run summary" --deliver', - "Talk directly to the agent using the Gateway; optionally send the WhatsApp reply.", + "Run one agent turn through the Gateway and optionally deliver the reply.", ], [ 'openclaw message send --channel telegram --target @mychat --message "Hi"', diff --git a/src/cli/program/subcli-descriptors.ts b/src/cli/program/subcli-descriptors.ts index 9d6449c3cf1..d6b4366f328 100644 --- a/src/cli/program/subcli-descriptors.ts +++ b/src/cli/program/subcli-descriptors.ts @@ -5,14 +5,18 @@ import { isPrivateQaCliEnabled } from "./private-qa-cli.js"; export type SubCliDescriptor = NamedCommandDescriptor; const subCliCommandCatalog = defineCommandDescriptorCatalog([ - { name: "acp", description: "Agent Control Protocol tools", hasSubcommands: true }, + { name: "acp", description: "Run and manage ACP-backed coding agents", hasSubcommands: true }, { name: "gateway", - description: "Run, inspect, and query the WebSocket Gateway", + description: "Run, inspect, and query the OpenClaw Gateway", hasSubcommands: true, }, - { name: "daemon", description: "Gateway service (legacy alias)", hasSubcommands: true }, - { name: "logs", description: "Tail gateway file logs via RPC", hasSubcommands: false }, + { + name: "daemon", + description: "Manage the Gateway service (legacy alias)", + hasSubcommands: true, + }, + { name: "logs", description: "Tail Gateway logs locally or via RPC", hasSubcommands: false }, { name: "system", description: "System events, heartbeat, and presence", @@ -20,17 +24,17 @@ const subCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "models", - description: "Discover, scan, and configure models", + description: "List, scan, and set model providers", hasSubcommands: true, }, { name: "infer", - description: "Run provider-backed inference commands", + description: "Run provider-backed model, media, search, and embedding commands", hasSubcommands: true, }, { name: "capability", - description: "Run provider-backed inference commands (fallback alias: infer)", + description: "Run provider capability commands (fallback alias: infer)", hasSubcommands: true, }, { @@ -45,7 +49,7 @@ const subCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "nodes", - description: "Manage gateway-owned node pairing and node commands", + description: "Pair nodes and run node-host commands through the Gateway", hasSubcommands: true, }, { @@ -80,7 +84,7 @@ const subCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "cron", - description: "Manage cron jobs via the Gateway scheduler", + description: "Schedule and inspect Gateway background jobs", hasSubcommands: true, }, { @@ -135,12 +139,12 @@ const subCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "plugins", - description: "Manage OpenClaw plugins", + description: "Install, enable, disable, and inspect plugins", hasSubcommands: true, }, { name: "channels", - description: "Manage connected chat channels (Telegram, Discord, etc.)", + description: "Add, remove, login, and inspect messaging channels", hasSubcommands: true, }, { @@ -155,12 +159,12 @@ const subCliCommandCatalog = defineCommandDescriptorCatalog([ }, { name: "secrets", - description: "Secrets runtime reload controls", + description: "Audit, apply, and reload SecretRef-backed credentials", hasSubcommands: true, }, { name: "skills", - description: "List and inspect available skills", + description: "List, inspect, and install agent skills", hasSubcommands: true, }, {