let5see/clawdbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(cli): add per-command CLI pages

Browse Source
This commit is contained in:
Peter Steinberger
2026-01-15 06:12:54 +00:00
parent 5b23f847d6
commit 0cbfea79fa
58 changed files with 881 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/cli/program/register.maintenance.ts
View File

@@ -4,11 +4,17 @@ import { doctorCommand } from "../../commands/doctor.js";
import { resetCommand } from "../../commands/reset.js";
import { uninstallCommand } from "../../commands/uninstall.js";
import { defaultRuntime } from "../../runtime.js";
import { formatDocsLink } from "../../terminal/links.js";
import { theme } from "../../terminal/theme.js";
export function registerMaintenanceCommands(program: Command) {
program
.command("doctor")
.description("Health checks + quick fixes for the gateway and channels")
.addHelpText(
"after",
() => `\n${theme.muted("Docs:")} ${formatDocsLink("/cli/doctor", "docs.clawd.bot/cli/doctor")}\n`,
)
.option("--no-workspace-suggestions", "Disable workspace memory system suggestions", false)
.option("--yes", "Accept defaults without prompting", false)
.option("--repair", "Apply recommended repairs without prompting", false)
@@ -36,6 +42,11 @@ export function registerMaintenanceCommands(program: Command) {
program
.command("dashboard")
.description("Open the Control UI with your current token")
.addHelpText(
"after",
() =>
`\n${theme.muted("Docs:")} ${formatDocsLink("/cli/dashboard", "docs.clawd.bot/cli/dashboard")}\n`,
)
.option("--no-open", "Print URL but do not launch a browser", false)
.action(async (opts) => {
try {
@@ -51,6 +62,10 @@ export function registerMaintenanceCommands(program: Command) {
program
.command("reset")
.description("Reset local config/state (keeps the CLI installed)")
.addHelpText(
"after",
() => `\n${theme.muted("Docs:")} ${formatDocsLink("/cli/reset", "docs.clawd.bot/cli/reset")}\n`,
)
.option("--scope <scope>", "config|config+creds+sessions|full (default: interactive prompt)")
.option("--yes", "Skip confirmation prompts", false)
.option("--non-interactive", "Disable prompts (requires --scope + --yes)", false)
@@ -72,6 +87,11 @@ export function registerMaintenanceCommands(program: Command) {
program
.command("uninstall")
.description("Uninstall the gateway service + local data (CLI remains)")
.addHelpText(
"after",
() =>
`\n${theme.muted("Docs:")} ${formatDocsLink("/cli/uninstall", "docs.clawd.bot/cli/uninstall")}\n`,
)
.option("--service", "Remove the gateway service", false)
.option("--state", "Remove state + config", false)
.option("--workspace", "Remove workspace dirs", false)