Sigroom Docs

Workflows And Automation

The hosted harness docs should include workflow guides in addition to command tables, because most users need a task route more than an alphabetized command list.

draftPower users and automation authorsVerified 2026-06-03

Workflow Guides To Publish

  • Install and initialize GeneSYS from source.
  • Start the runtime and open the UI.
  • Authenticate into the local UI.
  • Ask a one-off question from the CLI.
  • Run a long-running task and inspect or terminate it.
  • Review a repository or current diff.
  • Generate and promote a self-heal fix.
  • Explore a reference repository and apply insights.
  • Configure memory backend and inspect memory graph/status.
  • Install or import a plugin, reload it, and verify MCP/LSP tools.
  • Pair Telegram or another channel and approve or reject pairing codes.
  • Use browser automation to open a page, snapshot state, take a screenshot, and act on elements.
  • Diagnose failures with doctor, logs tail, gateway, policy status, and sandbox status.
  • Run TradingAgents analysis safely and understand output artifacts.

Minimum Copyable Examples

bash
gene --help
gene doctor --fix
gene start --ui-host 127.0.0.1 --ui-port 5173 --open
gene ask --stream "Explain the current repository"
gene ask --long-running "Run the test suite and summarize failures"
gene sessions list --json
gene logs tail --runtime --lines 100
gene config get companion
gene secret set OPENAI_API_KEY
gene tools list
gene policy show --effective
gene plugins list
gene plugins install <plugin>@<marketplace> --scope user --preflight
gene sandbox status --ensure
gene browser open https://example.com
gene selfheal --fix "Fix the failing unit test" --source .
gene explore . --goal "Map the architecture" --json
gene research "Compare the tradeoffs of local-first AI workspaces" --deep
gene trading-help analyze --ticker SPY --date 2026-04-30 --json
gene stop

Automation Contract

  • Define human-readable output conventions separately from JSON output.
  • Document JSON flags and stable schemas command-by-command.
  • Publish exit-code conventions and stable fields that scripts can depend on.
  • Mark what is intentionally not stable yet.

Source Material

  • Pasted GeneSYS CLI Documentation Outline
  • docs/features/SELFHEAL_README.md
  • docs/tools/PLUGIN_SYSTEM.md
  • docs/tools/tool-catalog.md