Getting Started
Get up and running with noodlbox
This guide will help you get noodlbox set up and start exploring your codebase.
Prerequisites
- Supported platforms:
- macOS (Apple Silicon)
- Linux (x64)
- Linux (ARM64)
- An MCP-compatible client (e.g., Claude Code, Cursor, Codex, OpenCode)
Quick Start
How It Works
Your agent has MCP tools to analyze, delete, search, and query repositories. You just need to install once.
Install the CLI
Sign in to noodlbox.io and copy the install command from the dashboard.
The installer runs noodl init automatically, which:
- Authenticates with noodlbox (opens browser)
- Configures MCP for your agents (Claude Code, Cursor, Codex)
After installation, ask your agent:
"Analyze this codebase"
"What communities exist here?"
"How does the authentication flow work?"The agent calls noodlbox_analyze automatically when needed.
Already installed? Run noodl init to set up authentication and agent configuration.
When to Use Manual
- CI/CD pipelines and automation scripts
- Batch operations across multiple repositories
- Explicit control over when analysis happens
- Environments without interactive authentication
Install the CLI
Sign in to noodlbox.io and copy the install command from the dashboard.
The installer authenticates and configures MCP automatically.
Analyze your codebase
noodl analyze .This extracts code entities and relationships, building a knowledge graph.
Integrate your Agents
noodl configureThis sets up MCP, skills, and hooks for Claude Code, Cursor, and Codex.
After setup, ask your agent:
"What communities exist in this codebase?"
"How does the authentication flow work?"
"What would be impacted if I changed this function?"What You Can Do
Plan Changes
Research and gather context before implementing
Debug Issues
Track down bugs by tracing execution paths
Review Code
Review PRs for quality, safety, and impact
Troubleshooting
| Problem | Solution |
|---|---|
| Connection failed | Run noodl status to check authentication |
| No repositories | Agent-first: Ask agent to analyze. Manual: Run noodl analyze /path/to/repo |
| Config not applied | Restart your agent, or run noodl reset to start fresh |
| Auth expired | Run noodl auth to re-authenticate |
Next Steps
- CLI Reference - Complete command reference
- Claude Code Plugin - Commands, skills, and agents
- Explore the platform - Understand communities, processes, and the knowledge graph
- MCP Tools & Resources - What your agent can access