From 45a0fce90f5d753dd96ae67ee664519672b6e964 Mon Sep 17 00:00:00 2001 From: YuanHanzhong Date: Mon, 18 May 2026 21:59:13 +0800 Subject: [PATCH] docs: mention index-only analyze mode --- README.md | 6 ++++++ gitnexus/README.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/README.md b/README.md index 714d2cbfd..cfdcc6978 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,12 @@ npx gitnexus analyze That's it. This indexes the codebase, installs agent skills, registers Claude Code hooks, and creates `AGENTS.md` / `CLAUDE.md` context files — all in one command. +If you only want to refresh the index and leave existing agent files and skills untouched, use: + +```bash +npx gitnexus analyze --index-only +``` + To configure MCP for your editor, run `npx gitnexus setup` once — or set it up manually below. > **Faster install (no C++ toolchain needed):** set `GITNEXUS_SKIP_OPTIONAL_GRAMMARS=1` before `npm install -g gitnexus` to skip the native `tree-sitter-dart` and `tree-sitter-proto` builds. Dart/Proto files won't be parsed, but install completes in seconds without `python3`/`make`/`g++`. Strict `=1` only — any other value falls through to the rebuild. diff --git a/gitnexus/README.md b/gitnexus/README.md index 55cdc12f7..d5afb6508 100644 --- a/gitnexus/README.md +++ b/gitnexus/README.md @@ -24,6 +24,12 @@ npx gitnexus analyze That's it. This indexes the codebase, installs agent skills, registers Claude Code hooks, and creates `AGENTS.md` / `CLAUDE.md` context files — all in one command. +If you only want to refresh the index and leave existing agent files and skills untouched, use: + +```bash +npx gitnexus analyze --index-only +``` + To configure MCP for your editor, run `npx gitnexus setup` once — or set it up manually below. `gitnexus setup` auto-detects your editors and writes the correct global MCP config. You only need to run it once.