The Claude Experience you wish you had.
Important: Claude Pro/Max/Team subscription required
Claudex requires Claude Code, which is only available with a Claude Pro, Max, or Team subscription. The free Claude tier does not include Claude Code access.
Every task starts with a session β a folder that accumulates everything Claude produces:
.claudex/sessions/
βββ api-refactor-abc123/
βββ session-overview.md β Auto-maintained status & index
βββ feature-description.md β Manually added from Jira, Linear, etc.
βββ research-findings.md β Research artifacts
βββ execution-plan.md β Architecture decisions
βββ ... β Your custom docs
Why it matters: Claude's context window fills up. When you clear it, Claude normally forgets everything. With claudex, the session folder persists β Claude reads session-overview.md on startup and catches up in seconds.
Session modes:
- Resume β Continue where you left off with full claude's conversation history
- Fresh memory β Clear claude's context window, keep all docs (Claude catches up via overview)
- Fork β Branch into a new task while cloning all the docs
A background agent silently maintains session-overview.md as you workβno manual note-taking:
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β You work normally β
β β β
β Every few messages, claudex updates the session-overview.md document β
β β β
β Clear claude's context window β
β β β
β Leverage full claude's potential β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Example of auto-maintained session-overview.md:
# Session: API Refactor
## Status
Phase 2 in progress - Authentication endpoints complete
## Key Decisions
- JWT over session cookies (see research-auth.md)
- Rate limiting at gateway level
## Documents
- [research-auth.md](./research-auth.md) β Auth strategy analysis
- [execution-plan.md](./execution-plan.md) β Implementation phasesPick up any session instantlyβeven weeks later. Claude reads the overview, follows the pointers, and catches up in seconds.
Keep your codebase documentation up-to-date automatically. On first run in a git repo, claudex offers to install a post-commit hook:
π Enable auto-docs update after git commits? [y/n/never]:
When enabled, after each commit:
- Detects which files changed
- Identifies affected
index.mdfiles - Spawns Claude (Haiku) to intelligently update them
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β git commit β
β β β
β Post-commit hook triggers claudex --update-docs β
β β β
β Claude reads existing index.md, explores surrounding context β
β β β
β Makes thoughtful updates to keep docs relevant β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Manual trigger: claudex --update-docs
Skip for a commit: CLAUDEX_SKIP_DOCS=1 git commit -m "quick fix"
A team-lead agent coordinates specialists through a structured workflow:
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
β You describe what you need β
β β β
β Explore agent investigates codebase & docs β
β β β
β Plan agent creates execution plan with phases β
β β β
β Engineers execute in parallel: β
β βββ Track A: Auth service β
β βββ Track B: API endpoints β
β βββ Track C: Database migrations β
βββββββββββββββββββββββββββββββββββββββββββββββββββββββ
Work gets broken into independent tracks. Multiple engineers execute simultaneously: divide-and-conquer.
- Claude Pro, Max, or Team subscription β Required for Claude Code access
- Claude Code CLI β Install via
npm install -g @anthropic-ai/claude-code - Node.js 14+ β For npm installation
- Go 1.21+ β Only needed if building from source
On first run, claudex will prompt you to install these recommended MCPs for the best experience:
| MCP | Description |
|---|---|
| Sequential Thinking | Structured reasoning through complex problems step-by-step |
| Context7 | Up-to-date documentation lookup for libraries and frameworks |
You can also configure them manually anytime with claudex --setup-mcp or make install-mcp.
npm install -g @claudex/cliThis works on macOS and Linux without needing to clone the repository.
git clone https://github.com/mgonzalezbaile/claudex.git
cd claudex
make installAdd to your shell config if needed:
export PATH="$HOME/.local/bin:$PATH"Navigate to your project directory and run:
cd /path/to/your/project
claudexOn first run, claudex creates a .claude folder with agent profiles and hooks. If a .claude folder already exists, files are merged (use --no-overwrite to preserve your existing files).
The TUI will guide you through:
- Session selection (new, ephemeral, or existing)
- Profile selection (choose agent type)
- Launch Claude with your selections
β/β- NavigateEnter- Select/- Fuzzy searchqorCtrl+C- Quit
Claudex includes specialized agent profiles:
| Profile | Purpose |
|---|---|
team-lead |
Strategic planning and orchestration |
principal-engineer-{stack} |
Implementation (TypeScript, Python, Go, PHP) |
prompt-engineer |
Prompt design and optimization |
Profiles are automatically assembled based on your project's technology stack.
Claudex stores its artifacts in a .claudex/ folder in your project root:
.claudex/
βββ config.toml # Configuration file (auto-created)
βββ sessions/ # Session data
βββ logs/ # Log files
βββ preferences.json # User preferences
Edit .claudex/config.toml to customize behavior:
# Documentation files always loaded into context
doc = ["docs/index.md"]
# Preserve existing .claude files during setup
no_overwrite = true
[features]
# Auto-documentation during session (default: true)
autodoc_session_progress = true
# Auto-documentation on session end (default: true)
autodoc_session_end = true
# Tool executions between doc updates (default: 5)
autodoc_frequency = 5Environment variables override config values: CLAUDEX_AUTODOC_SESSION_PROGRESS, CLAUDEX_AUTODOC_SESSION_END, CLAUDEX_AUTODOC_FREQUENCY.
Tip: Keep doc files lightweightβthey're passed to every agent. Use an index with brief descriptions and pointers:
# Project Documentation Index
## Product
- [docs/product-overview.md](docs/product-overview.md) β Business goals, user personas, success metrics
## Technology
- [docs/architecture.md](docs/architecture.md) β System design, service boundaries, data flow
- [docs/tech-stack.md](docs/tech-stack.md) β Languages, frameworks, infrastructure choices
## Development
- [docs/coding-standards.md](docs/coding-standards.md) β Style guide, patterns, conventions
- [docs/testing-strategy.md](docs/testing-strategy.md) β Test types, coverage requirementsClaude reads the index, understands what's available, and loads detailed docs on demandβsaving context for actual work.
MIT License - see LICENSE for details.
Built with:
- Bubble Tea - TUI framework
- Lipgloss - Terminal styling
- Bubbles - TUI components
- Readline - Readline implementation
