OpenParable
Skip to content
← Back to skills

Gitnexus CLI

Apps & Automation
gitnexus-cli

Gitnexus CLI is an Agent Skill for apps & automation published in the abhigyanpatwari/GitNexus repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

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"

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/abhigyanpatwari/GitNexus/blob/HEAD/gitnexus-claude-plugin/skills/gitnexus-cli/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/gitnexus-cli, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

GitNexus CLI Commands

Commands below use node .gitnexus/run.cjs <command> — the project-local runner gitnexus analyze drops next to the index. It auto-selects an available runner at call time (global gitnexus, else pnpm dlx, else npx), so no package-manager assumption and no global install is required.

Not analyzed yet, or node .gitnexus/run.cjs reports Cannot find module (the gitignored runner is absent — e.g. a fresh clone or git clean)? (Re)generate it with npx gitnexus analyze from the project root. On npm 11.x, if npx crashes during install (node.target is null), install once with npm i -g gitnexus (then gitnexus analyze) or use pnpm --allow-build=@ladybugdb/core --allow-build=gitnexus --allow-build=tree-sitter dlx gitnexus@latest analyze. See #1939.

Commands

analyze — Build or refresh the index

node .gitnexus/run.cjs 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.

FlagEffect
--forceForce full re-index even if up to date
--embeddingsEnable embedding generation for semantic search (off by default)
--drop-embeddingsDrop existing embeddings on rebuild. By default, an analyze without --embeddings preserves them.
--pdgBuild the program-dependence layers used by explain and pdg_query (taint, CDG, and REACHING_DEF).

When to run: First time in a project, after major code changes, or when gitnexus://repo/{name}/context reports the index is stale.

status — Check index freshness

node .gitnexus/run.cjs 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

node .gitnexus/run.cjs 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.

FlagEffect
--forceSkip confirmation prompt
--allClean all indexed repos, not just the current one

wiki — Generate documentation from the graph

node .gitnexus/run.cjs wiki

Generates repository documentation from the knowledge graph using an LLM. Requires an API key (saved to ~/.gitnexus/config.json on first use).

FlagEffect
--forceForce full regeneration, also required to re-gerenate an existing wiki in a different language
--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)
--gistPublish wiki as a public GitHub Gist
--timeout <seconds>LLM request timeout in seconds (default: disabled)
--retries <n>Max LLM retry attempts per request (default: 3)
--lang <lang>Output language for generated documentation (e.g. english, chinese, spanish, japanese)

list — Show all indexed repos

node .gitnexus/run.cjs list

Lists all repositories registered in ~/.gitnexus/registry.json. The MCP list_repos tool provides the same information.

After Indexing

  1. Read gitnexus://repo/{name}/context to verify the index loaded
  2. Use the other GitNexus skills (exploring, debugging, impact-analysis, refactoring) for your task

Troubleshooting

  • "Not inside a git repository": Run from a directory inside a git repo
  • Index is stale after re-analyzing: Restart Claude Code to reload the MCP server
  • Embeddings slow: Omit --embeddings (it's off by default) or set OPENAI_API_KEY for faster API-based embedding