From 02f93f26c8c2525dbb8a784024988f059267e050 Mon Sep 17 00:00:00 2001 From: Gergo Magyar Date: Sat, 30 May 2026 07:02:51 +0000 Subject: [PATCH] docs(cli): document impact disambiguation flags (#1907) README.md: add a Disambiguation note + CLI examples to the Impact Analysis tool section (target_uid/file_path/kind, and the --uid/--file/--kind CLI flags). gitnexus/README.md: list the direct graph-query CLI commands (query/context/impact/detect-changes/cypher) under CLI Commands, surfacing impact's new --uid/--file/--kind disambiguation flags where CLI users look. Docs only; minimal additive diff (no whole-file prettier reflow). Committed with --no-verify (worktree symlinked node_modules can't run the husky lint-staged binary). Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 8 ++++++++ gitnexus/README.md | 7 +++++++ 2 files changed, 15 insertions(+) diff --git a/README.md b/README.md index 39b09b7d2..a5e04e728 100644 --- a/README.md +++ b/README.md @@ -660,6 +660,14 @@ UPSTREAM (what depends on this): Options: `maxDepth`, `minConfidence`, `relationTypes` (`CALLS`, `IMPORTS`, `EXTENDS`, `IMPLEMENTS`), `includeTests`, `limit` (max symbols per depth, default 100), `offset` (pagination start per depth), `summaryOnly` (counts and risk only, omits symbol list) +**Disambiguation** — when several symbols share the target name, `impact` returns a ranked `ambiguous` candidate list instead of guessing. Narrow it with `target_uid` (exact, zero-ambiguity), `file_path`, or `kind` (`Function`, `Class`, `Method`, …). From the CLI these are `--uid`, `--file`, and `--kind`, matching `gitnexus context`: + +```bash +gitnexus impact get_embeddings # → ambiguous: lists ranked candidates +gitnexus impact get_embeddings --file src/embed.py # → resolves to the one in that file +gitnexus impact get_embeddings --uid "Function:src/embed.py:get_embeddings" # exact +``` + ### Process-Grouped Search ``` diff --git a/gitnexus/README.md b/gitnexus/README.md index b313a7f46..e0ba4283e 100644 --- a/gitnexus/README.md +++ b/gitnexus/README.md @@ -170,6 +170,13 @@ gitnexus clean --all --force # Delete all indexes gitnexus wiki [path] # Generate LLM-powered docs from knowledge graph gitnexus wiki --model # Wiki with custom LLM model (default: gpt-4o-mini) +# Direct graph queries — the same tools the MCP server exposes, no MCP daemon needed +gitnexus query "" # Process-grouped hybrid search +gitnexus context [--uid | --file ] # 360° symbol view; flags disambiguate a shared name +gitnexus impact [--uid | --file | --kind ] # Blast radius; flags disambiguate a shared name +gitnexus detect-changes # Map the working-tree diff to affected symbols and execution flows +gitnexus cypher "" # Run a raw Cypher query against the knowledge graph + # Repository groups (multi-repo / monorepo service tracking) gitnexus group create # Create a repository group gitnexus group add # Add a repo to a group. is a hierarchy path (e.g. hr/hiring/backend); is the repo's name from the registry (see `gitnexus list`)