Docs
Quickstart
Review the current access flow, run the installer, choose your client surfaces, verify the setup, and start your first retained-context workflow. The goal is simple: wire the repo once, then let every later session inherit better context than the last one had.
Access status. TRW installs are currently approved through a gated beta. If you are still evaluating fit, read this page first. If you already know you want to try it, request access on the waitlist.
Fast path
Step 1
Request or confirm access
Current installs roll out through a gated beta. Approved users can authenticate during install or reuse an existing API key.
Step 2
Run the bootstrap
The shell bootstrap installs trw-mcp, downloads the full Python installer, and starts guided setup in your project root.
Step 3
Select your client surfaces
On first install, the Python installer now prompts you with a multi-select TUI so one repo can be wired for multiple clients at once.
Step 4
Verify and start
Confirm the generated files, open one configured client, call trw_session_start(), and finish with trw_deliver().
Prerequisites
| Requirement | Version | Install | Verify |
|---|---|---|---|
| Python | 3.10+ (3.11+ recommended) | brew install python / apt install python3 | python3 --version |
| pip | 22.0+ | python3 -m pip install --upgrade pip | python3 -m pip --version |
| git | 2.30+ | brew install git / apt install git | git --version |
| AI coding client | latest stable available to you | Claude Code, Cursor IDE, Cursor CLI, OpenCode, Codex CLI, GitHub Copilot CLI, Gemini CLI, or Aider | Run your client’s version command or open the repo in the client you plan to use |
Installation
Run the bootstrap from the project root after approval or with an existing API key. The shell bootstrap installs trw-mcp, authenticates if needed, downloads the full Python installer, and writes the repo-local config automatically.
curl -fsSL https://trwframework.com/install.sh | bashOn first install, the Python installer now opens a guided client picker so you can wire this repo for more than one surface in the same pass.
Select the client surfaces you want TRW to configure
[x] Claude Code
[x] Cursor IDE
[ ] Cursor CLI
[ ] OpenCode
[x] Codex CLI
[ ] GitHub Copilot CLI
[ ] Gemini CLI
[ ] Aider
Use ↑/↓ to move • Space to toggle • Enter to confirmSupported clients
The installer writes different instruction surfaces depending on what you select. Full profiles expose more automation. Light profiles keep the footprint smaller and rely more on instructions plus MCP.
| Client | Ceremony | What TRW writes | Automation | Best fit |
|---|---|---|---|---|
Claude Code Best-understood end-to-end profile for local, hook-heavy TRW workflows. | Full | CLAUDE.md, .claude/INSTRUCTIONS.md, .claude/hooks/, .mcp.json | Deepest local hook, skill, and agent-team surface | Users who want the fullest TRW surface in one CLI |
Cursor IDE Full TRW surface tuned for Cursor’s IDE-native rules and automation. | Full | .cursor/rules/, .cursor/mcp.json, .cursor/hooks/, .cursor/skills/ | IDE rules plus translated hooks, commands, skills, and subagents | Interactive editor-first workflows inside Cursor |
Cursor CLI A lighter profile for headless Cursor runs where explicit permissions matter. | Light | AGENTS.md, .cursor/cli.json, .cursor/hooks.json, .cursor/mcp.json | Headless-safe permissions and CLI hook subset | cursor-agent, CI, and scripted terminal workflows |
OpenCode Instruction-first TRW integration with OpenCode-native commands and agents. | Light | opencode.json, .opencode/INSTRUCTIONS.md, .opencode/commands/, .opencode/agents/ | Curated commands, agents, and instruction-first guidance | Lean terminal workflows with curated TRW surfaces |
Codex CLI A light TRW profile shaped around Codex’s workflow and context constraints. | Light | .codex/config.toml, .codex/INSTRUCTIONS.md, .codex/agents/, optional .codex/hooks.json | Codex-specific config, agents, curated skills, optional hooks | Codex users who want tighter context and lighter ceremony defaults |
GitHub Copilot CLI Full TRW support translated into Copilot’s GitHub-first surfaces. | Full | .github/copilot-instructions.md, .github/instructions/, .github/hooks/, .github/agents/ | Repo instructions, path-scoped guidance, hooks, agents, and skills | GitHub-native repos adopting agent workflows and path-scoped guidance |
Gemini CLI Full TRW support adapted to Gemini’s native instruction and subagent surfaces. | Full | GEMINI.md, .gemini/settings.json, .gemini/agents/ | Gemini-native instructions, MCP config, and subagents | Very large-context sessions and Gemini-native agent work |
Aider A light TRW profile for users who want compounding context without heavy scaffolding. | Light | AGENTS.md and .aider/instructions.md-compatible guidance | Instruction-first, low-ceremony integration | Minimal terminal workflows that still need durable project memory |
Claude Code
Best-understood end-to-end profile for local, hook-heavy TRW workflows.
Cursor IDE
Full TRW surface tuned for Cursor’s IDE-native rules and automation.
Cursor CLI
A lighter profile for headless Cursor runs where explicit permissions matter.
OpenCode
Instruction-first TRW integration with OpenCode-native commands and agents.
Codex CLI
A light TRW profile shaped around Codex’s workflow and context constraints.
GitHub Copilot CLI
Full TRW support translated into Copilot’s GitHub-first surfaces.
Gemini CLI
Full TRW support adapted to Gemini’s native instruction and subagent surfaces.
Aider
A light TRW profile for users who want compounding context without heavy scaffolding.
Verification
| Check | Command | What success looks like |
|---|---|---|
| trw-mcp is on PATH | which trw-mcp | Returns a path such as /home/you/.local/bin/trw-mcp |
| .trw/config.yaml exists | ls .trw/config.yaml | The repo-local config file exists |
| Selected target_platforms were written | grep -n "target_platforms" -A8 .trw/config.yaml | Shows every client surface you selected during install |
| At least one client config exists | ls .claude .cursor .codex .github .gemini AGENTS.md 2>/dev/null | One or more client-specific files or directories now exist in the repo |
Your first session
Start the session
Loads prior learnings and recovers an active run if the work was interrupted.
trw_session_start()Do the work
Checkpoint whenever you cross a milestone so the session can recover instead of restart.
trw_checkpoint("rate limiter merged, tests next")Record a discovery
If you learn something the next session should not rediscover, persist it while the context is fresh.
trw_learn(summary="Cursor CLI needs .cursor/cli.json permissions baseline", detail="...")Close the loop
Verify the work and persist the session state before you leave the task.
trw_build_check(scope="full")
trw_deliver()Tip
The client surface changes. The TRW core loop does not: trw_session_start() first, trw_build_check() before delivery, and trw_deliver() last.
If something feels off
Need deeper debugging? Head to troubleshooting for client-specific startup issues, install errors, and runtime recovery steps.
Next: learn the model
Once the repo is wired, spend five minutes on the concepts page so the session, run, learning, and ceremony model feels obvious before the first serious task.