prime
Show LLM-friendly project overview with live stats.
Synopsis
bobbin prime [OPTIONS] [PATH]
Description
The prime command generates a comprehensive project overview designed to be consumed by LLMs and AI agents. It includes what bobbin does, architecture details, available commands, MCP tools, and live index statistics.
Use --section to request a specific part, or --brief for a compact summary.
Arguments
| Argument | Description |
|---|---|
PATH | Directory to check (default: .) |
Options
| Option | Default | Description |
|---|---|---|
--brief | Show brief (compact) overview only | |
--section <NAME> | Show a specific section (e.g., architecture, commands, mcp tools) |
Examples
Show full project overview:
bobbin prime
Brief summary:
bobbin prime --brief
Specific section:
bobbin prime --section "mcp tools"
JSON output:
bobbin prime --json
Prerequisites
Works best with a bobbin index for live stats, but can run without one.
See Also
- status — index statistics