fix(cli): 顶层 usage 优化 + skill 索引标题修正 #85

Closed
opened 2026-05-07 15:25:53 +00:00 by xingyue · 0 comments
Owner

Problems

1. 顶层 usage 缺少说明和分组

当前 uncaged-workflow 无参数输出就是一堆命令列表,没有:

  • 工具整体介绍(一句话说明这是什么)
  • 命令分组标题(workflow / thread / cas / init 各组没有标题说明)
  • --help 使用提示

2. skill 索引页标题还是旧的

uncaged-workflow skill 输出的标题是 # uncaged-workflow help --skill,应该是 # uncaged-workflow skill

Proposal

顶层 usage 改进

uncaged-workflow — workflow engine CLI

Workflow registry:
  workflow add <name> <file>        Register a bundle
  workflow list                     List all workflows
  workflow show <name>              Show details
  workflow rm <name>                Remove
  workflow history <name>           Version history
  workflow rollback <name> [hash]   Rollback to previous version

Thread execution:
  thread run <name> [--prompt ...]  Start a thread
  thread list [name]                List threads
  thread show <id>                  Show thread state
  thread rm <id>                    Remove
  thread fork <id> [--from-role ..]  Fork from a role
  thread ps                         Running threads
  thread kill <id>                  Kill
  thread live <id> | --latest       Stream output live
  thread pause / resume <id>        Pause or resume

Content-addressable storage:
  cas get <tid> <hash>              Read content by hash
  cas put <tid> <content>           Store content
  cas list <tid>                    List entries
  cas rm <tid> <hash>               Remove entry
  cas gc                            Garbage collect

Development:
  init workspace <name>             Scaffold a new workspace
  init template <name>              Add a template package

Shortcuts:
  run <name> [...]                  → thread run
  live <id> [...]                   → thread live

Reference:
  skill [topic]                     Agent-consumable docs (cli, develop, author)

Use <command> --help for subcommand details.

Environment variables:
  WORKFLOW_STORAGE_ROOT             Override storage directory
  UNCAGED_WORKFLOW_STORAGE_ROOT     Internal override (priority)

skill 索引标题修正

# uncaged-workflow help --skill# uncaged-workflow skill

## Problems ### 1. 顶层 usage 缺少说明和分组 当前 `uncaged-workflow` 无参数输出就是一堆命令列表,没有: - 工具整体介绍(一句话说明这是什么) - 命令分组标题(workflow / thread / cas / init 各组没有标题说明) - `--help` 使用提示 ### 2. `skill` 索引页标题还是旧的 `uncaged-workflow skill` 输出的标题是 `# uncaged-workflow help --skill`,应该是 `# uncaged-workflow skill`。 ## Proposal ### 顶层 usage 改进 ``` uncaged-workflow — workflow engine CLI Workflow registry: workflow add <name> <file> Register a bundle workflow list List all workflows workflow show <name> Show details workflow rm <name> Remove workflow history <name> Version history workflow rollback <name> [hash] Rollback to previous version Thread execution: thread run <name> [--prompt ...] Start a thread thread list [name] List threads thread show <id> Show thread state thread rm <id> Remove thread fork <id> [--from-role ..] Fork from a role thread ps Running threads thread kill <id> Kill thread live <id> | --latest Stream output live thread pause / resume <id> Pause or resume Content-addressable storage: cas get <tid> <hash> Read content by hash cas put <tid> <content> Store content cas list <tid> List entries cas rm <tid> <hash> Remove entry cas gc Garbage collect Development: init workspace <name> Scaffold a new workspace init template <name> Add a template package Shortcuts: run <name> [...] → thread run live <id> [...] → thread live Reference: skill [topic] Agent-consumable docs (cli, develop, author) Use <command> --help for subcommand details. Environment variables: WORKFLOW_STORAGE_ROOT Override storage directory UNCAGED_WORKFLOW_STORAGE_ROOT Internal override (priority) ``` ### skill 索引标题修正 `# uncaged-workflow help --skill` → `# uncaged-workflow skill`
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/workflow#85