Skip to content

docs: update README with comprehensive quick install documentation#286

Open
GindaChen wants to merge 1 commit intomainfrom
readme-install-docs
Open

docs: update README with comprehensive quick install documentation#286
GindaChen wants to merge 1 commit intomainfrom
readme-install-docs

Conversation

@GindaChen
Copy link
Copy Markdown
Collaborator

Summary

Updates the README.md with comprehensive documentation for the quick install system based on the scripts/research-agent lifecycle manager and install.sh installer.

Changes

  • Replace hardcoded install URL — pointed to main branch instead of a specific release tag
  • Add install channels — document stable (latest tag), latest (main tip), and commit:<SHA> (pinned commit) channels
  • Add install modes — document runtime (prebuilt binaries) vs source (clone + build) modes
  • Add options reference — full table of all install.sh flags (--install-dir, --channel, --mode, --repo-url, etc.)
  • Consolidate Quick Start — merged the old 'Quick Start (Recommended)' section into the new 'After Installation' subsection to reduce duplication
  • Post-install CLI usage — document research-agent start/status/tunnel/stop commands

- Replace hardcoded install URL with main branch reference
- Add install channels table (stable, latest, commit:SHA)
- Add install modes table (runtime, source)
- Add full install options reference table
- Consolidate Quick Start into the new Quick Install section
- Document post-install CLI usage (start, status, tunnel, stop)
@GindaChen
Copy link
Copy Markdown
Collaborator Author

Execution Context

User request: Read the scripts/research-agent installer script and update the README with documentation on how to use the quick install to install latest, stable, etc.

Flow:

  1. Read scripts/research-agent (1553-line lifecycle manager) to understand channels, modes, and CLI commands
  2. Read install.sh (1759-line installer) to understand the curl one-liner flow and options
  3. Identified three key concepts: channels (stable/latest/commit:SHA), modes (runtime/source), and post-install CLI (start/status/tunnel/stop)
  4. Rewrote the README's install section to document all of the above with tables and code examples
  5. Consolidated the old 'Quick Start' section into the new 'After Installation' subsection to avoid duplication

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 20, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant