Terminal

CLI

Run onboard from the terminal. Generate guides, analyze risk zones, or start the full web UI. One binary, zero dependencies beyond Rust.

Install

# Clone and build git clone https://github.com/thierrydamiba/onboard cd onboard cargo install --path . # Set your API key export ANTHROPIC_API_KEY="your-key"

Commands

1

Interactive Mode (default)

Launch the web UI at localhost:4321. Browse curated sources, enter any repo, and generate onboarding guides with live streaming.

onboard # Opens http://localhost:4321
2

Direct Generation

Generate an onboarding guide for a specific repo and persona. Output goes to stdout as markdown.

onboard --repo vercel/next.js --persona "new frontend engineer joining the team" # Control depth with effort parameter onboard --repo django/django --persona "security auditor" --depth deep # Scope to a specific path or branch onboard --repo ./my-project --persona "SRE" --path src/api --branch main
3

MCP Server Mode

Run as a Model Context Protocol server for integration with Claude Code, Cursor, and other MCP clients.

onboard --mcp # Listens on stdio transport

Environment Variables

# Required ANTHROPIC_API_KEY="sk-ant-..." # Optional: GitHub token for private repos and higher rate limits GITHUB_TOKEN="ghp_..." # Optional: custom port (default: 4321) ONBOARD_PORT="4321"