- Move CLI commands into subdirectories matching command hierarchy: dev/, go/, php/, build/, ci/, sdk/, pkg/, vm/, docs/, setup/, doctor/, test/, ai/ - Create shared/ package for common styles and utilities - Add new `core ai` root command with claude subcommand - Update package declarations and imports across all files - Create commands.go entry points for each package - Remove GUI-related files (moved to core-gui repo) This makes the filesystem structure match the CLI command structure, improving context capture and code organization. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
5.6 KiB
5.6 KiB
CLI Documentation TODO
Commands and subcommands that need documentation.
Missing Documentation
| Command | Subcommand | Status |
|---|---|---|
| dev | health | Missing |
| dev | commit | Missing |
| dev | push | Missing |
| dev | pull | Missing |
| dev | issues | Missing |
| dev | reviews | Missing |
| dev | ci | Missing |
| dev | impact | Missing |
| dev | api | Missing |
| dev | api sync | Missing |
| dev | sync | Missing |
| dev | tasks | Missing |
| dev | task | Missing |
| dev | task:update | Missing |
| dev | task:complete | Missing |
| dev | task:commit | Missing |
| dev | task:pr | Missing |
| dev | install | Missing |
| dev | boot | Missing |
| dev | stop | Missing |
| dev | status | Missing |
| dev | shell | Missing |
| dev | serve | Missing |
| dev | test | Missing |
| dev | claude | Missing |
| dev | update | Missing |
| go | work sync | Missing |
| go | work init | Missing |
| go | work use | Missing |
| go | mod tidy | Missing |
| go | mod download | Missing |
| go | mod verify | Missing |
| go | mod graph | Missing |
| php | dev | Missing |
| php | logs | Missing |
| php | stop | Missing |
| php | status | Missing |
| php | ssl | Missing |
| php | build | Missing |
| php | serve | Missing |
| php | shell | Missing |
| php | test | Missing |
| php | fmt | Missing |
| php | analyse | Missing |
| php | packages | Missing |
| php | packages link | Missing |
| php | packages unlink | Missing |
| php | packages update | Missing |
| php | packages list | Missing |
| php | deploy | Missing |
| php | deploy:status | Missing |
| php | deploy:rollback | Missing |
| php | deploy:list | Missing |
| build | from-path | Missing |
| build | pwa | Missing |
| ci | - | Missing (only has subcommands) |
| sdk | diff | Missing |
| sdk | validate | Missing |
| pkg | install | Missing |
| pkg | list | Missing |
| pkg | update | Missing |
| pkg | outdated | Missing |
| vm | run | Missing |
| vm | ps | Missing |
| vm | stop | Missing |
| vm | logs | Missing |
| vm | exec | Missing |
| vm | templates show | Missing |
| vm | templates vars | Missing |
| docs | sync | Missing |
| docs | list | Missing |
Needs Update
| Command | Issue |
|---|---|
| build/sdk | Documentation exists but command has been moved to build sdk |
| go/work | Index exists but subcommands (sync, init, use) are undocumented |
| go/mod | Index exists but subcommands (tidy, download, verify, graph) are undocumented |
| vm/templates | Index exists but subcommands (show, vars) are undocumented |
| pkg/search | Index exists but may need updating with new flags |
Documentation Structure Notes
The following commands have complete documentation:
test- /Users/snider/Code/host-uk/core/docs/cmd/test/index.mddoctor- /Users/snider/Code/host-uk/core/docs/cmd/doctor/index.mdsetup- /Users/snider/Code/host-uk/core/docs/cmd/setup/index.mddev/work- /Users/snider/Code/host-uk/core/docs/cmd/dev/work/index.mddev(parent) - /Users/snider/Code/host-uk/core/docs/cmd/dev/index.mdgo(parent) - /Users/snider/Code/host-uk/core/docs/cmd/go/index.mdgo/test- /Users/snider/Code/host-uk/core/docs/cmd/go/test/index.mdgo/cov- /Users/snider/Code/host-uk/core/docs/cmd/go/cov/index.mdgo/fmt- /Users/snider/Code/host-uk/core/docs/cmd/go/fmt/index.mdgo/lint- /Users/snider/Code/host-uk/core/docs/cmd/go/lint/index.mdgo/install- /Users/snider/Code/host-uk/core/docs/cmd/go/install/index.mdgo/mod(parent) - /Users/snider/Code/host-uk/core/docs/cmd/go/mod/index.mdgo/work(parent) - /Users/snider/Code/host-uk/core/docs/cmd/go/work/index.mdci/init- /Users/snider/Code/host-uk/core/docs/cmd/ci/init/index.mdci/changelog- /Users/snider/Code/host-uk/core/docs/cmd/ci/changelog/index.mdci/version- /Users/snider/Code/host-uk/core/docs/cmd/ci/version/index.mdbuild(parent) - /Users/snider/Code/host-uk/core/docs/cmd/build/index.mdbuild/sdk- /Users/snider/Code/host-uk/core/docs/cmd/build/sdk/index.mdsdk(parent) - /Users/snider/Code/host-uk/core/docs/cmd/sdk/index.mdpkg(parent) - /Users/snider/Code/host-uk/core/docs/cmd/pkg/index.mdpkg/search- /Users/snider/Code/host-uk/core/docs/cmd/pkg/search/index.mdvm(parent) - /Users/snider/Code/host-uk/core/docs/cmd/vm/index.mdvm/templates(parent) - /Users/snider/Code/host-uk/core/docs/cmd/vm/templates/index.mdphp(parent) - /Users/snider/Code/host-uk/core/docs/cmd/php/index.mddocs(parent) - /Users/snider/Code/host-uk/core/docs/cmd/docs/index.md
Priority Recommendations
High priority (commonly used commands):
devsubcommands (health, commit, push, pull, issues, reviews, ci, impact)phpsubcommands (dev, build, test, fmt, packages)go/modsubcommands (tidy, download, verify)go/worksubcommands (sync, init, use)vmcore commands (run, ps, stop, logs)
Medium priority:
devtask management commandsdevdev environment commands (install, boot, stop, status, shell)sdkvalidation commandspkgpackage management commandsphpdeployment commandsbuildalternative builders (from-path, pwa)
Low priority:
devadvanced commands (api sync, claude, update)vm/templatessubcommandsdocsmanagement commands
Issues Found
- There appears to be duplicate documentation under
/Users/snider/Code/host-uk/core/docs/cmd/docs/cmd/which mirrors the main command structure. This should be cleaned up. - The
ciparent command has no index.md, only subcommand documentation exists. - Many parent commands (dev, go, php, etc.) have good overview documentation but are missing subcommand details.
Last verified: 2026-01-29