You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,10 +25,10 @@ Path-only SysML indexer: builds a knowledge graph from `.sysml` files and expose
25
25
26
26
## Version
27
27
28
-
-**Current package version:****0.8.0** — bump this line when you release; [`package.json`](package.json)`"version"` is what npm publishes.
28
+
-**Current package version:****0.8.2** — bump this line when you release; [`package.json`](package.json)`"version"` is what npm publishes.
29
29
-**Policy:**[Semantic versioning](https://semver.org/) — **MAJOR** / **MINOR** / **PATCH** as usual. CLI and MCP tool names and shapes are treated as stable within a major line unless release notes say otherwise.
30
30
31
-
To ship: set `"version"` in `package.json`, note changes (e.g. `release-notes-v*.md`), run`npm run build`, `npm test`, and `npm run test:daemon`, then `npm publish` — see[Publishing (npm)](#publishing-npm).
31
+
To ship: follow [docs/PUBLISH.md](docs/PUBLISH.md) (version, notes,`npm run build` / `test` / `test:daemon`, `npm publish`) — summary in[Publishing (npm)](#publishing-npm).
32
32
33
33
## Requirements
34
34
@@ -79,6 +79,7 @@ Or one step from repo root: `npm run index-and-map` (optional path argument).
79
79
|**`SYSMLEGRAPH_WORKER_PORT`**| Daemon bind port; **`0`** = OS-assigned (default when unset). Used when running `worker:daemon` / `daemon.js` directly. |
80
80
|**`SYSMLLSP_SERVER_PATH`**| Path to sysml-v2-lsp **`server.js`** if not using default `lsp/` or `node_modules` resolution. |
81
81
|**`SYSMEDGRAPH_USE_MCP_SYMBOLS`**| Set to **`1`** to fall back to MCP `getSymbols` when LSP returns no symbols (indexing). |
82
+
|**`SYSMLEGRAPH_INDEX_REFERENCES`**| Set to **`1`** to run an extra MCP **`getReferences`** pass after indexing and add **REFERENCES** edges (slow; needs **setup-lsp** / **sysml-v2-lsp**). See [docs/MCP_INTERACTION_GUIDE.md](docs/MCP_INTERACTION_GUIDE.md) §6. |
82
83
|**`SYSMLEDGRAPH_USE_WORKER`**| Set to **`1`** to use a **per-command** stdio graph worker instead of in-process Kuzu (short-lived child). |
83
84
84
85
### Global CLI option
@@ -174,23 +175,25 @@ Configure **sysmledgraph** in **`.cursor/mcp.json`** (see [docs/MCP_SERVER_FOR_C
[`.github/workflows/ci.yml`](.github/workflows/ci.yml) runs **`npm ci`**, **`npm run build`**, **`npm test`**, and **`npm run test:daemon`** on **windows-latest** (Node 20).
188
+
[`.github/workflows/ci.yml`](.github/workflows/ci.yml) runs **`npm ci`**, **`npm run build`**, **`npm test`**, and **`npm run test:daemon`** on **windows-latest**and **ubuntu-latest**(Node 20).
186
189
187
190
## Publishing (npm)
188
191
189
192
Others can install with **`npm install sysmledgraph`** or run **`npx sysmledgraph analyze <path>`**.
190
193
191
194
1.**Name:****`sysmledgraph`** in `package.json` (or a scoped name if needed).
192
195
2.**Build:****`prepublishOnly`** runs **`npm run build`** so **`dist/`** ships in the tarball.
193
-
3.**Files:****`package.json`****`files`** lists **`dist`**, **`scripts`**, **`lsp`**, **`README.md`**, **`docs`**. Consumers run **`npm run setup-lsp`** inside the package for**`lsp/`**.
196
+
3.**Files:****`package.json`****`files`** lists **`dist`**, **`scripts`**, explicit **`lsp/`** files (**`package.json`**, **`package-lock.json`**, **`README.md`**, **`test-server.mjs`** — not the whole folder, so **`lsp/node_modules`** is never packed), **`README.md`**, **`docs`**. Consumers run **`npm run setup-lsp`** inside the package to install **sysml-v2-lsp** under**`lsp/`**.
0 commit comments