Sigroom Docs

Install And Quick Start

The first-run docs should give a copyable path from local bootstrap to a working runtime session, while clearly calling out provider keys and backend readiness.

draftNew GeneSYS usersVerified 2026-06-03

Requirements

  • Node.js and pnpm versions expected by the repository.
  • Git for source checkouts and patch workflows.
  • Docker where sandbox, browser, or trading-help workflows require containers.
  • Provider keys such as OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY, or OPENROUTER_API_KEY for real model runs.
  • Optional web search keys for Tavily or Brave when those providers are selected during init.

From-Source Setup

bash
pnpm install
pnpm run build
pnpm run dev
scripts/setup/install.sh

First-Run Happy Path

bash
gene init
gene doctor --fix
gene start --open
gene login --ui
gene ask "Summarize this repo"
gene stop

First-Run Notes

  • Document what gene init writes or updates, including generated config and environment files.
  • Explain what happens when model provider secrets are missing.
  • Show how init chooses tavily, brave, or duckduckgo_html for web search.
  • Give port-conflict recovery steps and show how to start without opening a browser.
  • Include detached mode when users want the runtime to survive the current shell.

Source Material

  • Pasted GeneSYS CLI Documentation Outline
  • README.md
  • scripts/setup/install.sh
  • scripts/setup/remove.sh