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
The fastest path — no account or sign-in required:
curl -fsSL https://install.noodlbox.io | bash # install the CLI (auto-runs noodl init)
noodl init # configure your agents (Claude Code, Cursor, Codex)
noodl analyze # build the knowledge graph
noodl ui # open the local dashboardHow It Works
Your agent has MCP tools to analyze, delete, search, and query repositories. You just need to install once.
Install the CLI
curl -fsSL https://install.noodlbox.io | bashThe installer runs noodl init automatically, configuring MCP for your agents (Claude Code, Cursor, Codex). No account or sign-in required.
After installation, ask your agent:
"Analyze this codebase"
"Find the authentication code"
"What calls the authentication entry point?"The agent calls noodlbox_analyze automatically when needed.
Already installed? Run noodl init to configure your agents.
When to Use Manual
- CI/CD pipelines and automation scripts
- Batch operations across multiple repositories
- Explicit control over when analysis happens
- Environments without interactive setup
Install the CLI
curl -fsSL https://install.noodlbox.io | bashThe installer runs noodl init automatically, configuring MCP for your agents (Claude Code, Cursor, Codex). No account or sign-in required.
Analyze your codebase
noodl analyze .This extracts code entities and relationships, building a knowledge graph.
Open the local dashboard
noodl uiExplore the knowledge graph — communities, workflows, and symbol connections — in your browser. No account or sign-in required.
Integrate your Agents
noodl configureThis sets up MCP, skills, and hooks for Claude Code, Cursor, and Codex.
After setup, ask your agent:
"Find the authentication code"
"What calls the authentication entry point?"
"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 through callers and dependencies
Review Code
Review PRs for quality, safety, and impact
Troubleshooting
| Problem | Solution |
|---|---|
| Connection failed | Run noodl status to check connection status |
| 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 symbols, relationships, and the knowledge graph
- MCP Tools & Resources - What your agent can access