Troubleshooting And Hosting Checklist
Before the GeneSYS CLI docs are treated as hosted user documentation, command coverage and examples should be audited against the current build.
Troubleshooting Topics
- Missing provider keys.
- Missing pnpm or Node.js versions.
- Backend not running.
- Stale runtime state.
- UI port conflicts.
- MCP not ready.
- Plugin load failures.
- Sandbox or browser instance failures.
- Docker unavailable for trading or sandbox workflows.
- Auth token expired or missing.
- Memory backend unavailable.
- Enterprise service install failures.
- Commands that require backend returning connection errors.
Verification Before Hosting
- Every top-level command in packages/ui/src/index.ts has a docs entry.
- Every public subcommand in packages/cli/src/commands/*/service.ts is represented.
- Commands marked backend-required are accurate.
- Command-specific --help behavior is safe and consistent.
- All examples run against the current build.
- JSON examples include redacted sample output.
- Paths and environment variables match current config behavior.
- Existing docs are linked or consolidated.
Known Gaps To Resolve
- Audit command-specific help; top-level gene --help is reliable in the inspected build, but not every gene <command> --help path is guaranteed help-only.
- Decide whether internal commands such as companion run-job are public or intentionally hidden.
- Define which commands are stable public API versus experimental operator tools.
- Clarify packaged-user install instructions separately from monorepo developer instructions.
- Include a generated command/options snapshot so the hosted page does not drift from the CLI catalog.
- Mark commands that mutate ~/.gene, repo-local .gene, external services, Docker state, or Git state.
Source Material
- Pasted GeneSYS CLI Documentation Outline
- docs/runbooks/RUNBOOK_LIVE_WORKSPACE_E2E.md
- docs/features/COMPANION_README.md