From de2443a937c1d1693522edad1cbeb6a13085a67c Mon Sep 17 00:00:00 2001 From: devmaxxx Date: Sat, 17 Oct 2026 17:48:12 +0200 Subject: [PATCH 1/4] chore(release): bump to 0.6.2 Ships the root README to npm (#198); the binary is unchanged. --- Cargo.lock | 2 +- Cargo.toml | 2 +- docs/commands.md | 2 +- docs/releases/0.6.2.md | 12 ++++++++++++ npm/zerograph/package.json | 2 +- 5 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 docs/releases/0.6.2.md diff --git a/Cargo.lock b/Cargo.lock index 72be2449..935edef5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -3227,7 +3227,7 @@ dependencies = [ [[package]] name = "zerograph" -version = "0.6.1" +version = "0.6.2" dependencies = [ "anyhow", "ast-grep-language", diff --git a/Cargo.toml b/Cargo.toml index 729430f7..2d0bddb3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "zerograph" -version = "0.6.1" +version = "0.6.2" edition = "2021" rust-version = "1.98" description = "A project knowledge graph built and queried at zero API tokens" diff --git a/docs/commands.md b/docs/commands.md index bb5655f4..65eefcf2 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -2,7 +2,7 @@ ## Status -0.6.1 is the version `main` carries. Its default globs read TypeScript and JavaScript, Kotlin, Java, +0.6.2 is the version `main` carries. Its default globs read TypeScript and JavaScript, Kotlin, Java, C#, Rust, Python, Dart, Swift, GraphQL, SQL, Bicep, HCL, Shell, Vue, Lua, Go, C, C++, PHP, Ruby, Scala, Elixir and OCaml; every command below is implemented rather than planned: diff --git a/docs/releases/0.6.2.md b/docs/releases/0.6.2.md new file mode 100644 index 00000000..606485b3 --- /dev/null +++ b/docs/releases/0.6.2.md @@ -0,0 +1,12 @@ +# zerograph 0.6.2 + +The release notes for the GitHub release page. The why behind each change is in the docs each line +links to. + +## Fixes + +- **The npm page shows the repository's README**, badges, navigation and the comparison image + included. The package used to carry a short hand-kept copy that had drifted from it; the README + is now cut from the root one at pack time, every relative path pinned to the release tag. + +No change to the binary since 0.6.1. diff --git a/npm/zerograph/package.json b/npm/zerograph/package.json index 5e78e8a9..ac034177 100644 --- a/npm/zerograph/package.json +++ b/npm/zerograph/package.json @@ -1,6 +1,6 @@ { "name": "zerograph", - "version": "0.6.1", + "version": "0.6.2", "description": "Knowledge graph of a repository's requirement docs and code in 24 languages, built and refreshed at zero model tokens, asked by id, keyword or paraphrase", "license": "MIT", "repository": { From 19b0788aa00d2f9e0dfb68c43e2b9bf334971707 Mon Sep 17 00:00:00 2001 From: devmaxxx Date: Sat, 17 Oct 2026 17:48:27 +0200 Subject: [PATCH 2/4] docs(readme): drop the from-source install line The README is now the npm page too, where a source checkout is not what the reader has; docs/install.md keeps the source route. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f14282cc..71adf0b5 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ Sources: [the three-tool run](docs/bench/2026-09-04-three-graphs-results.md) and pnpm add -D zerograph # prebuilt: macOS arm64, Linux x64, Windows x64 pnpm add -g zerograph # or globally with pnpm npm install -g zerograph # or globally with npm -cargo install --path . # or from source zerograph build # full build into .zerograph/ (add it to .gitignore) zerograph ask cancellation policy # answer in a few lines From a73bcd9d728913491a092edd7f4a02cfd11ce23a Mon Sep 17 00:00:00 2001 From: devmaxxx Date: Sat, 17 Oct 2026 17:52:45 +0200 Subject: [PATCH 3/4] docs(readme): add a step-by-step project setup The README is the npm page now, so the first thing a reader there needs is how to wire zerograph into their own repository: ignore the store, build, ask, connect the agent, and where the config lives. --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 71adf0b5..cad2251a 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,48 @@ Sources: [the three-tool run](docs/bench/2026-09-04-three-graphs-results.md) and pnpm add -D zerograph # prebuilt: macOS arm64, Linux x64, Windows x64 pnpm add -g zerograph # or globally with pnpm npm install -g zerograph # or globally with npm - -zerograph build # full build into .zerograph/ (add it to .gitignore) -zerograph ask cancellation policy # answer in a few lines ``` +### Set up a project + +Run these from the repository root. + +1. **Keep the store out of git.** The graph lives in `.zerograph/`, built per checkout: + + ```bash + echo .zerograph/ >> .gitignore + ``` + +2. **Build the graph.** The first build downloads the embedding model once (about 1.2 GB, cached + under `~/.cache/zerograph`); `--no-dense` skips it and answers by id and keyword only. + + ```bash + zerograph build + ``` + +3. **Ask.** Every reader catches the graph up with your edits before it answers, so there is no + `update` to remember. + + ```bash + zerograph ask cancellation policy + ``` + +4. **Connect your agent** (optional). Writes the agent's config (`--claude` also registers the MCP + server) and `post-merge` and `post-checkout` git hooks that refresh the graph after a pull or a + branch switch: + + ```bash + zerograph install-agent --claude # or --codex + zerograph install-agent --claude --command "pnpm exec zerograph" # installed as a dev dependency + ``` + +5. **Tune what is read** (optional). With no config, markdown and code in all 24 languages are read + and `node_modules`, `dist` and build output are skipped. A `zerograph.toml` at the root narrows + or widens that — see [Configuration](docs/configuration.md). + +For repeated questions, `zerograph serve --detach` keeps the model loaded between them +([serve](docs/serve.md)). + - On Windows: [Windows notes](docs/install.md#windows-notes). - Upgrading from repograph: the old store, config and variables are read where they are, see [coming from repograph](docs/install.md#coming-from-repograph). From 6fe6adb84c97df1de9ca7b49d3b34bba0c8dadea Mon Sep 17 00:00:00 2001 From: devmaxxx Date: Sat, 17 Oct 2026 17:53:52 +0200 Subject: [PATCH 4/4] docs(readme): fold the project setup into one command block --- README.md | 49 +++++++------------------------------------------ 1 file changed, 7 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index cad2251a..792f21fa 100644 --- a/README.md +++ b/README.md @@ -33,50 +33,15 @@ Sources: [the three-tool run](docs/bench/2026-09-04-three-graphs-results.md) and ## Get started ```bash -pnpm add -D zerograph # prebuilt: macOS arm64, Linux x64, Windows x64 -pnpm add -g zerograph # or globally with pnpm -npm install -g zerograph # or globally with npm +npm install -g zerograph # or: pnpm add -D zerograph +echo .zerograph/ >> .gitignore # the graph is built per checkout +zerograph build # first run downloads the embedding model (~1.2 GB) +zerograph ask cancellation policy # stays fresh with your edits, no update to run +zerograph install-agent --claude # optional: MCP server + git hooks (or --codex) ``` -### Set up a project - -Run these from the repository root. - -1. **Keep the store out of git.** The graph lives in `.zerograph/`, built per checkout: - - ```bash - echo .zerograph/ >> .gitignore - ``` - -2. **Build the graph.** The first build downloads the embedding model once (about 1.2 GB, cached - under `~/.cache/zerograph`); `--no-dense` skips it and answers by id and keyword only. - - ```bash - zerograph build - ``` - -3. **Ask.** Every reader catches the graph up with your edits before it answers, so there is no - `update` to remember. - - ```bash - zerograph ask cancellation policy - ``` - -4. **Connect your agent** (optional). Writes the agent's config (`--claude` also registers the MCP - server) and `post-merge` and `post-checkout` git hooks that refresh the graph after a pull or a - branch switch: - - ```bash - zerograph install-agent --claude # or --codex - zerograph install-agent --claude --command "pnpm exec zerograph" # installed as a dev dependency - ``` - -5. **Tune what is read** (optional). With no config, markdown and code in all 24 languages are read - and `node_modules`, `dist` and build output are skipped. A `zerograph.toml` at the root narrows - or widens that — see [Configuration](docs/configuration.md). - -For repeated questions, `zerograph serve --detach` keeps the model loaded between them -([serve](docs/serve.md)). +Prebuilt for macOS arm64, Linux x64 and Windows x64. Defaults read markdown and code in 24 +languages; a `zerograph.toml` changes that ([Configuration](docs/configuration.md)). - On Windows: [Windows notes](docs/install.md#windows-notes). - Upgrading from repograph: the old store, config and variables are read where they are, see