docs: update README — all current commands and configuration

[greynewell]

Summary

• Rewrites README to accurately reflect all current commands after the factory command was removed and audit was added
• Documents both workflows: file mode (.graph.* sidecar files) and on-demand analysis
• Adds configuration section covering ~/.supermodel/config.yaml and all environment variables
• Adds Claude Code hook setup and MCP setup sections with copy-paste snippets

Test plan

• Verify all commands in the Commands table match supermodel --help output
• Confirm no mention of the removed factory command
• Check that config env vars (SUPERMODEL_API_KEY, SUPERMODEL_API_BASE, SUPERMODEL_FILES) match internal/config/config.go
• Verify hook JSON snippet is valid and matches supermodel hook --help description
• Verify MCP JSON snippet matches supermodel mcp --help example

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Restructured README to emphasize command-based workflows and configuration
  • Added distinct documentation for file mode (writes sidecar files) and on-demand analysis modes
  • Included detailed setup instructions for Claude Code integration and MCP tools
  • Clarified configuration options and environment variable overrides

[coderabbitai]

Walkthrough

The README was restructured from a marketing-focused layout to a command-centric guide. It now explicitly documents two operational modes (file mode and on-demand analysis), provides quickstart instructions with CI-friendly authentication, lists command categories with their purposes, and includes detailed configuration and integration setup for Claude Code and MCP.

Changes

Cohort / File(s)	Summary
Documentation Update README.md	Restructured from marketing narrative to command-driven guide; added operational modes (file mode vs. on-demand analysis), organized commands by category, documented configuration via ~/.supermodel/config.yaml, and added setup instructions for Claude Code hook integration and MCP tool exposure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• jonathanpopham

Poem

📖 The docs got a makeover clean,
From "what we do" to commands on screen,
File mode, on-demand, config files too,
MCP and Claude hooks—now readers know what to do! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: updating the README to document all current commands and configuration.
Description check	✅ Passed	The description covers the What (README rewrite with specific updates) and Why (reflect current commands, document workflows, add config/setup docs), but the Test plan section is incomplete—missing actual test execution confirmation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-update

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

108-123: Configuration section is accurate.

The documented environment variables (SUPERMODEL_API_KEY, SUPERMODEL_API_BASE, SUPERMODEL_FILES) match the implementation in internal/config/config.go. The CI example on lines 119-123 gives a practical, copy-paste-ready snippet.

One minor observation: the output field on line 115 shows valid values (human | json) but doesn't mention an environment variable override, while the other fields do. This is actually correct—there's no SUPERMODEL_OUTPUT env var in the code—but you might consider adding a brief note like "# human | json (no env override)" to make the formatting more consistent with the other fields and avoid any user confusion.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 108 - 123, Update the README Configuration block to
clarify that the "output" setting does not have an environment-variable
override: revise the `output: human            # human | json` line to add a
short note such as "(no env override)" so it matches the format used for other
fields and avoids confusion; reference the `output` field in the README and the
lack of `SUPERMODEL_OUTPUT` in internal/config/config.go when making this
clarification.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 108-123: Update the README Configuration block to clarify that the
"output" setting does not have an environment-variable override: revise the
`output: human            # human | json` line to add a short note such as "(no
env override)" so it matches the format used for other fields and avoids
confusion; reference the `output` field in the README and the lack of
`SUPERMODEL_OUTPUT` in internal/config/config.go when making this clarification.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3e523a1b-f84c-47c7-948d-5b5593a2c3c5

📥 Commits

Reviewing files that changed from the base of the PR and between 9651f86 and b8c5817.

📒 Files selected for processing (1)

• README.md