xiaoju
f115718564
chore: cleanup dead code and update CLI docs
...
- Remove cmdThreadRunning dead code (CLI uses --status running now)
- Remove step read from README (command not registered)
- Update cli-reference.ts to reflect new four-layer commands
Refs #463
2026-05-24 11:41:02 +00:00
xiaoju
031c3aa632
docs(cli): add deprecation handlers and update documentation ( #463 )
...
Complete the CLI refactoring with deprecation error handlers, updated
help text, and comprehensive migration guide.
## Changes
### Deprecation Handlers
Add error handlers for all removed commands with helpful migration messages:
- `workflow put` → suggests `workflow add`
- `thread step` → suggests `thread exec`
- `thread steps` → suggests `step list`
- `thread step-details` → suggests `step show`
- `thread fork` → suggests `step fork`
- `thread kill` → suggests `thread stop` or `thread cancel`
- `thread running` → suggests `thread list --status running`
Error messages follow the format:
```
Error: Command 'X' has been removed.
Use 'Y' instead.
For more information, see: uwf help Y
```
### Help Documentation
Updated CLI help text to explain four-layer architecture:
- Main help shows architecture diagram with Chinese labels
- Command group descriptions reference layers:
- `workflow` → "Workflow definitions (layer 1: templates)"
- `thread` → "Thread execution (layer 2: instances)"
- `step` → "Step results (layer 3: single cycle)"
- Deprecated commands appear in help with [DEPRECATED] tag
### README Updates
Comprehensive documentation updates:
- Added "Four-Layer Architecture" section with diagram
- Updated all command tables with new command names
- Added complete migration guide with:
- Renamed commands table
- Merged commands table
- Split commands table
- Moved commands table
- Example deprecation error output
- Updated "Internal Structure" to show new step.ts module
## Testing
- ✅ All 124 tests pass
- ✅ Build completes successfully
- ✅ Deprecation handlers tested manually
- ✅ Help output verified for main, thread, and step commands
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com >
2026-05-24 10:46:31 +00:00
xiaoju
ffc31a8c19
docs: sync all README.md files with current codebase
...
- Root README: add all 9 packages to table, update architecture diagram,
refresh CLI reference from uwf --help
- New READMEs for 8 packages (cli-workflow, workflow-protocol,
workflow-moderator, workflow-agent-kit, workflow-agent-hermes,
workflow-agent-builtin, workflow-agent-claude-code, workflow-dashboard)
- Updated workflow-util README to match current exports
- All API sections verified against src/index.ts exports
小橘 🍊 （NEKO Team）
2026-05-23 15:00:05 +00:00
xiaoju
d63d58ccb5
chore: reorganize repo — legacy packages to legacy-packages/, templates to examples/
...
- Move 15 old workflow-* packages to legacy-packages/ (inactive, preserved for reference)
- Rename templates/ → examples/ for clarity
- Rewrite docs/architecture.md to reflect current uwf architecture
- Active packages remain in packages/: cli-uwf, uwf-agent-hermes, uwf-agent-kit, uwf-moderator, uwf-protocol, workflow-util
小橘 🍊 （NEKO Team）
2026-05-19 07:19:40 +00:00
xingyue
a5c09adae6
docs: add README.md to all 8 packages
...
Each README includes: package description, install instructions,
usage example, API overview, and (for templates) role/moderator flow.
Packages documented:
- @uncaged/workflow (core)
- @uncaged/cli-workflow (CLI)
- @uncaged/workflow-agent-cursor
- @uncaged/workflow-agent-hermes
- @uncaged/workflow-agent-llm
- @uncaged/workflow-template-develop
- @uncaged/workflow-template-solve-issue
- @uncaged/workflow-util-agent
2026-05-08 10:17:40 +08:00
xiaoju
xingyue