| name | gitnexus-cli |
| description | Use when the user needs to run GitNexus CLI commands like analyze/index a repo, check status, clean the index, generate a wiki, or list indexed repos. Examples: "Index this repo", "Reanalyze the codebase", "Generate a wiki" |
GitNexus CLI Commands
IMPORTANT — How to use GitNexus: GitNexus is a standalone CLI tool. Run it directly
via gitnexus <command> in the Bash tool. Do NOT use mcpl call gitnexus ... or
npx gitnexus ... — gitnexus is installed globally and invoked by name.
Multi-repo note: This workspace has multiple repos indexed. For commands that
operate on a specific repo (query, context, impact, detect-changes, rename, cypher),
always pass --repo <name> to avoid "multiple repositories" errors.
Commands
analyze — Build or refresh the index
gitnexus analyze
Run from the project root. This parses all source files, builds the knowledge graph, writes it to .gitnexus/, and generates CLAUDE.md / AGENTS.md context files.
| Flag | Effect |
|---|
--force | Force full re-index even if up to date |
--embeddings | Enable embedding generation for semantic search (off by default) |
When to run: First time in a project, after major code changes, or when gitnexus status reports the index is stale. In Claude Code, a PostToolUse hook runs analyze automatically after git commit and git merge, preserving embeddings if previously generated.
status — Check index freshness
gitnexus status
Shows whether the current repo has a GitNexus index, when it was last updated, and symbol/relationship counts. Use this to check if re-indexing is needed.
clean — Delete the index
gitnexus clean
Deletes the .gitnexus/ directory and unregisters the repo from the global registry. Use before re-indexing if the index is corrupt or after removing GitNexus from a project.
| Flag | Effect |
|---|
--force | Skip confirmation prompt |
--all | Clean all indexed repos, not just the current one |
wiki — Generate documentation from the graph
gitnexus wiki
Generates repository documentation from the knowledge graph using an LLM. Requires an API key (saved to ~/.gitnexus/config.json on first use).
| Flag | Effect |
|---|
--force | Force full regeneration |
--model <model> | LLM model (default: minimax/minimax-m2.5) |
--base-url <url> | LLM API base URL |
--api-key <key> | LLM API key |
--concurrency <n> | Parallel LLM calls (default: 3) |
--gist | Publish wiki as a public GitHub Gist |
list — Show all indexed repos
gitnexus list
Lists all repositories registered in ~/.gitnexus/registry.json.
After Indexing
- Run
gitnexus status to verify the index loaded
- Use the other GitNexus skills (
gitnexus-exploring, gitnexus-debugging, gitnexus-impact-analysis, gitnexus-refactoring) for your task
Troubleshooting
- "Not inside a git repository": Run from a directory inside a git repo
- "multiple repositories" error: Add
--repo <name> to the command
- Index is stale after re-analyzing: Re-run
gitnexus status to confirm
- Embeddings slow: Omit
--embeddings (it's off by default) or set OPENAI_API_KEY for faster API-based embedding