@kentwynn/kgraph 0.2.1 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -74,6 +74,8 @@ That shows matched files/symbols, files importing the target, known callers/call
|
|
|
74
74
|
|
|
75
75
|
## Install
|
|
76
76
|
|
|
77
|
+
The official npm package is `@kentwynn/kgraph`; the official repository is `github.com/kentwynn/KGraph`.
|
|
78
|
+
|
|
77
79
|
Use the published CLI:
|
|
78
80
|
|
|
79
81
|
```bash
|
|
@@ -90,6 +92,8 @@ npx @kentwynn/kgraph@latest "auth token refresh"
|
|
|
90
92
|
|
|
91
93
|
KGraph requires Node.js 20 or newer.
|
|
92
94
|
|
|
95
|
+
KGraph's core functionality is free and local-first. It does not require accounts, telemetry, cloud services, API keys, or source-code upload.
|
|
96
|
+
|
|
93
97
|
## Quick Start
|
|
94
98
|
|
|
95
99
|
From the root of a repository:
|
|
@@ -302,7 +306,7 @@ All runtime data lives under `.kgraph/`:
|
|
|
302
306
|
└── context/
|
|
303
307
|
```
|
|
304
308
|
|
|
305
|
-
The files are local, inspectable, and human-readable. There is no database, telemetry, cloud service, account, API key, embedding service, or
|
|
309
|
+
The files are local, inspectable, and human-readable. Core KGraph functionality is free. There is no database, telemetry, cloud service, account, API key, embedding service, model provider, or source-code upload.
|
|
306
310
|
|
|
307
311
|
## Language Support
|
|
308
312
|
|
|
@@ -371,14 +375,25 @@ npm run release:pack
|
|
|
371
375
|
|
|
372
376
|
## Release
|
|
373
377
|
|
|
374
|
-
Releases are
|
|
378
|
+
Releases are PR-first because `main` is protected. Use the Makefile helper to bump the version on a release branch, push it, and open a pull request when the GitHub CLI is available:
|
|
379
|
+
|
|
380
|
+
```bash
|
|
381
|
+
make release
|
|
382
|
+
```
|
|
383
|
+
|
|
384
|
+
Use `RELEASE=minor` or `RELEASE=major` when needed:
|
|
385
|
+
|
|
386
|
+
```bash
|
|
387
|
+
make release RELEASE=minor
|
|
388
|
+
```
|
|
389
|
+
|
|
390
|
+
After the PR is merged, tag the merged commit from an up-to-date `main`:
|
|
375
391
|
|
|
376
392
|
```bash
|
|
377
|
-
|
|
378
|
-
git push origin main --follow-tags
|
|
393
|
+
make release-tag VERSION=v0.2.2
|
|
379
394
|
```
|
|
380
395
|
|
|
381
|
-
The release workflow builds, tests, packs, publishes the npm package on version tags, creates a GitHub Release, and uploads the tarball artifact.
|
|
396
|
+
The release workflow builds, tests, packs, publishes the npm package on version tags, creates a GitHub Release, and uploads the tarball artifact. Do not push directly to `main` for releases.
|
|
382
397
|
|
|
383
398
|
## Design Principles
|
|
384
399
|
|
|
@@ -391,8 +406,9 @@ The release workflow builds, tests, packs, publishes the npm package on version
|
|
|
391
406
|
|
|
392
407
|
## Roadmap
|
|
393
408
|
|
|
409
|
+
- Better Git-aware token saving and diff context.
|
|
394
410
|
- Smarter cross-file symbol and call relationship inference.
|
|
395
411
|
- Stronger TypeScript path alias and package export resolution.
|
|
396
412
|
- Richer graph filtering for large repositories.
|
|
397
|
-
- Optional MCP
|
|
398
|
-
- Team workflows
|
|
413
|
+
- Optional MCP and editor integration.
|
|
414
|
+
- Team-friendly shared cognition workflows that stay local-first.
|