@aroman22/codegraph-vba 1.17.2 → 2.1.0
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 +30 -29
- package/dist/directory.d.ts +3 -1
- package/dist/upgrade/index.d.ts +7 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -57,14 +57,14 @@ See [fork capabilities and lineage](docs/fork-capabilities.md) for the delivered
|
|
|
57
57
|
|
|
58
58
|
**Why fork?** To add VBA / Access language support that does not exist upstream, so agents can navigate Microsoft Access projects managed by Dysflow the same way they navigate TypeScript or Python today. See the [VBA / Access + Dysflow integration](#vba--access--dysflow-integration) section below for the feature spec, the pattern table, and the hard invariants.
|
|
59
59
|
|
|
60
|
-
**The fork
|
|
60
|
+
**The fork ships through [GitHub Releases](https://github.com/ardelperal/codegraph-vba/releases).** The upstream package `@colbymchenry/codegraph` does **not** have VBA / Access support — install this fork to get it:
|
|
61
61
|
|
|
62
62
|
```bash
|
|
63
|
-
# Option A —
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
63
|
+
# Option A — one-line installer from GitHub Releases (no Node, no npm):
|
|
64
|
+
# macOS / Linux
|
|
65
|
+
curl -fsSL https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.sh | sh
|
|
66
|
+
# Windows (PowerShell)
|
|
67
|
+
irm https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1 | iex
|
|
68
68
|
```
|
|
69
69
|
|
|
70
70
|
```bash
|
|
@@ -98,17 +98,15 @@ curl -fsSL https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/insta
|
|
|
98
98
|
irm https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1 | iex
|
|
99
99
|
```
|
|
100
100
|
|
|
101
|
-
<details>
|
|
102
|
-
<summary><b>Already have Node? Use npm instead (works on any version)</b></summary>
|
|
103
|
-
|
|
104
|
-
```bash
|
|
105
|
-
npm i -g @aroman22/codegraph-vba
|
|
106
|
-
```
|
|
107
|
-
|
|
108
101
|
<sub>CodeGraph bundles its own runtime — nothing to compile, no native build, works the same everywhere. The installer puts `codegraph-vba` on your PATH but **doesn't change your current shell** — open a new terminal before the next step so the command resolves.</sub>
|
|
109
102
|
|
|
110
103
|
<sub>**Upgrade any time** with `codegraph-vba upgrade` — it detects how you installed (bundle, npm, or npx) and updates in place. Add `--check` to see if an update is available, or `codegraph-vba upgrade <version>` to pin one.</sub>
|
|
111
104
|
|
|
105
|
+
<details>
|
|
106
|
+
<summary><b>npm (legacy)</b></summary>
|
|
107
|
+
|
|
108
|
+
The npm package `@aroman22/codegraph-vba` is published only on a best-effort basis and can lag behind GitHub Releases. Prefer the installer above; if you already installed through npm, re-run the installer to switch.
|
|
109
|
+
|
|
112
110
|
</details>
|
|
113
111
|
|
|
114
112
|
### 2. Wire up your agent(s)
|
|
@@ -119,7 +117,7 @@ In a **new terminal**, run the installer to connect CodeGraph to the agents you
|
|
|
119
117
|
codegraph-vba install
|
|
120
118
|
```
|
|
121
119
|
|
|
122
|
-
<sub>Detects and auto-configures Claude Code, Cursor, Codex CLI, opencode, Hermes Agent, Gemini CLI, Antigravity IDE, and Kiro — wiring the CodeGraph MCP server into each. **This is the step that connects CodeGraph to your agent;** installing the CLI in step 1 does not do it on its own. It only wires up your agent — it does **not** index any code; building each project's graph is the separate `codegraph-vba init` in step 3
|
|
120
|
+
<sub>Detects and auto-configures Claude Code, Cursor, Codex CLI, opencode, Hermes Agent, Gemini CLI, Antigravity IDE, and Kiro — wiring the CodeGraph MCP server into each. **This is the step that connects CodeGraph to your agent;** installing the CLI in step 1 does not do it on its own. It only wires up your agent — it does **not** index any code; building each project's graph is the separate `codegraph-vba init` in step 3.</sub>
|
|
123
121
|
|
|
124
122
|
### 3. Initialize each project
|
|
125
123
|
|
|
@@ -128,7 +126,7 @@ cd your-project
|
|
|
128
126
|
codegraph-vba init
|
|
129
127
|
```
|
|
130
128
|
|
|
131
|
-
<sub>`codegraph-vba init` creates the local `.codegraph
|
|
129
|
+
<sub>`codegraph-vba init` creates the local `.codegraph/` directory and builds the full graph in the same step — one command, done.</sub>
|
|
132
130
|
|
|
133
131
|
<div align="center">
|
|
134
132
|
|
|
@@ -148,7 +146,7 @@ Changed your mind? One command removes CodeGraph from every agent it configured:
|
|
|
148
146
|
codegraph-vba uninstall
|
|
149
147
|
```
|
|
150
148
|
|
|
151
|
-
<sub>Reverses the installer — strips CodeGraph's MCP server config, instructions, and permissions from each configured agent. Your project indexes (`.codegraph
|
|
149
|
+
<sub>Reverses the installer — strips CodeGraph's MCP server config, instructions, and permissions from each configured agent. Your project indexes (`.codegraph/`) are left untouched; remove those per-project with `codegraph-vba uninit`. Use `--target` to remove from specific agents, or `--yes` to run non-interactively.</sub>
|
|
152
150
|
|
|
153
151
|
---
|
|
154
152
|
|
|
@@ -552,8 +550,10 @@ payload as JSON.
|
|
|
552
550
|
|
|
553
551
|
### 1. Run the Installer
|
|
554
552
|
|
|
553
|
+
Install the CLI (see [Get Started](#get-started)), then run:
|
|
554
|
+
|
|
555
555
|
```bash
|
|
556
|
-
|
|
556
|
+
codegraph-vba install
|
|
557
557
|
```
|
|
558
558
|
|
|
559
559
|
The installer will:
|
|
@@ -595,14 +595,15 @@ codegraph-vba init
|
|
|
595
595
|
|
|
596
596
|
Builds the per-project knowledge graph index, which then auto-syncs on every file change. A single global `codegraph-vba install` works in every project you open — no need to re-run the installer per project.
|
|
597
597
|
|
|
598
|
-
That's it — your agent will use CodeGraph tools automatically when a `.codegraph
|
|
598
|
+
That's it — your agent will use CodeGraph tools automatically when a `.codegraph/` directory exists.
|
|
599
599
|
|
|
600
600
|
<details>
|
|
601
601
|
<summary><strong>Manual Setup (Alternative)</strong></summary>
|
|
602
602
|
|
|
603
|
-
**Install
|
|
603
|
+
**Install the CLI:**
|
|
604
604
|
```bash
|
|
605
|
-
|
|
605
|
+
curl -fsSL https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.sh | sh # macOS / Linux
|
|
606
|
+
irm https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1 | iex # Windows
|
|
606
607
|
```
|
|
607
608
|
|
|
608
609
|
**Add to `~/.claude.json`:**
|
|
@@ -641,7 +642,7 @@ CodeGraph's MCP server delivers its usage guidance to your agent **automatically
|
|
|
641
642
|
- **Answer structural questions directly with CodeGraph** — it *is* the pre-built index, so a grep/read loop just repeats work it already did. Treat the returned source as already read.
|
|
642
643
|
- **Reach for `codegraph_explore` for almost anything** — "how does X work", a flow/"how does X reach Y", or surveying an area. One call returns the relevant symbols' verbatim source grouped by file, the call paths between them (dynamic-dispatch hops included), and a blast-radius summary. Name a file or symbol in the query to read its current line-numbered source.
|
|
643
644
|
- **Trust the results — don't re-verify with grep**, and check the staleness banner after edits.
|
|
644
|
-
- Works **per project**: query any project that has a `.codegraph
|
|
645
|
+
- Works **per project**: query any project that has a `.codegraph/` index by passing `projectPath` — so a monorepo where only some services are indexed, or a second repo, works in one session. A path with no index returns clean guidance to use built-in tools; indexing stays your decision.
|
|
645
646
|
|
|
646
647
|
The exact text is `src/mcp/server-instructions.ts` — the single source of truth for the main agent. Because subagents and non-MCP harnesses never see the MCP guidance, the installer also writes a short marker-fenced section into the agent's instructions file pointing at the `codegraph-vba explore` CLI equivalent.
|
|
647
648
|
|
|
@@ -674,7 +675,7 @@ The exact text is `src/mcp/server-instructions.ts` — the single source of trut
|
|
|
674
675
|
|
|
675
676
|
1. **Extraction** — [tree-sitter](https://tree-sitter.github.io/) parses source code into ASTs. Language-specific queries extract nodes (functions, classes, methods) and edges (calls, imports, extends, implements).
|
|
676
677
|
|
|
677
|
-
2. **Storage** — Everything goes into a local SQLite database (`.codegraph
|
|
678
|
+
2. **Storage** — Everything goes into a local SQLite database (`.codegraph/codegraph.db`) with FTS5 full-text search.
|
|
678
679
|
|
|
679
680
|
3. **Resolution** — After extraction, references are resolved: function calls → definitions, imports → source files, class inheritance, and framework-specific patterns.
|
|
680
681
|
|
|
@@ -750,7 +751,7 @@ When running as an MCP server, CodeGraph exposes a **single tool** — `codegrap
|
|
|
750
751
|
|
|
751
752
|
The other tools (`codegraph_node`, `codegraph_search`, `codegraph_callers`, `codegraph_callees`, `codegraph_impact`, `codegraph_files`, `codegraph_status`, and the Access-specific `codegraph_behavior_evidence`) stay fully functional but **unlisted by default** — everything they return already arrives inline on `codegraph_explore` (its blast-radius section, the relationship map, a symbol's body as its callee list). Re-enable any of them for the MCP surface with the `CODEGRAPH_MCP_TOOLS` environment variable (e.g. `CODEGRAPH_MCP_TOOLS=explore,node,search,callers`), or use their CLI equivalents (`codegraph-vba node` / `query` / `callers` / `callees` / `impact` / `files` / `status`).
|
|
752
753
|
|
|
753
|
-
Even when the server's own root has no `.codegraph
|
|
754
|
+
Even when the server's own root has no `.codegraph/` index, the tools stay available: pass `projectPath` to query any indexed project — a sub-service in a monorepo, or a second repo — in the same session. A path that has no index returns clean guidance to use built-in tools instead, so nothing fails loudly, and indexing stays your decision.
|
|
754
755
|
|
|
755
756
|
---
|
|
756
757
|
|
|
@@ -883,9 +884,9 @@ compile) for all three desktop OSes, on both Intel/AMD (x64) and ARM (arm64):
|
|
|
883
884
|
|
|
884
885
|
| Platform | Architectures | Install |
|
|
885
886
|
|----------|---------------|---------|
|
|
886
|
-
| Windows | x64, arm64 | PowerShell installer
|
|
887
|
-
| macOS | x64, arm64 | shell installer
|
|
888
|
-
| Linux | x64, arm64 | shell installer
|
|
887
|
+
| Windows | x64, arm64 | PowerShell installer |
|
|
888
|
+
| macOS | x64, arm64 | shell installer |
|
|
889
|
+
| Linux | x64, arm64 | shell installer |
|
|
889
890
|
|
|
890
891
|
See [Get Started](#get-started) for the one-line install commands.
|
|
891
892
|
|
|
@@ -972,8 +973,8 @@ Framework routing is validated the same way, on a canonical app per framework: E
|
|
|
972
973
|
|
|
973
974
|
**MCP hits `database is locked`** — current builds shouldn't: CodeGraph bundles its own Node runtime and uses Node's built-in `node:sqlite` in WAL mode, where concurrent reads never block on a writer. If you still see it:
|
|
974
975
|
|
|
975
|
-
- **You're on an old (pre-0.9) install.** Reinstall to get the bundled runtime — `curl -fsSL https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.sh | sh` (macOS/Linux), `irm https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1 | iex` (Windows)
|
|
976
|
-
- **`codegraph-vba status` shows `Journal:` other than `wal`** — WAL couldn't be enabled on this filesystem (common on network shares and WSL2 `/mnt`), so reads can block on writes. Move the project (with its `.codegraph
|
|
976
|
+
- **You're on an old (pre-0.9) install.** Reinstall to get the bundled runtime — `curl -fsSL https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.sh | sh` (macOS/Linux), `irm https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1 | iex` (Windows).
|
|
977
|
+
- **`codegraph-vba status` shows `Journal:` other than `wal`** — WAL couldn't be enabled on this filesystem (common on network shares and WSL2 `/mnt`), so reads can block on writes. Move the project (with its `.codegraph/` folder) onto a local disk.
|
|
977
978
|
|
|
978
979
|
**MCP server not connecting** — Your agent starts the server itself, so you don't launch it by hand. Make sure the project is initialized and indexed (`codegraph-vba status`) and that the path in your MCP config is correct. If it still won't connect, re-run `codegraph-vba install` to rewrite the config.
|
|
979
980
|
|
|
@@ -981,7 +982,7 @@ Framework routing is validated the same way, on a canonical app per framework: E
|
|
|
981
982
|
|
|
982
983
|
**Missing symbols** — The MCP server auto-syncs on save (wait a couple seconds). Run `codegraph-vba sync` manually if needed. Check that the file's language is supported and isn't inside a `.gitignore`d or default-excluded directory (e.g. `node_modules`, `dist`).
|
|
983
984
|
|
|
984
|
-
**Sharing one checkout between Windows and WSL** — Don't point both at the same `.codegraph
|
|
985
|
+
**Sharing one checkout between Windows and WSL** — Don't point both at the same `.codegraph/`: the background-server lock and the SQLite index are tied to the OS that wrote them, and SQLite locking across the WSL2/Windows filesystem boundary is unreliable. Give each side its own index in the same tree by setting `CODEGRAPH_DIR` to a distinct name on one of them — e.g. `CODEGRAPH_DIR=.codegraph-win` on Windows, leaving WSL on the default `.codegraph`. CodeGraph skips any sibling `.codegraph-*` directory when indexing and watching, so the two never trip over each other.
|
|
985
986
|
|
|
986
987
|
## Star History
|
|
987
988
|
|
package/dist/directory.d.ts
CHANGED
|
@@ -36,7 +36,9 @@ export declare const CODEGRAPH_DIR: string;
|
|
|
36
36
|
* default `.codegraph`, the active `CODEGRAPH_DIR` override, and any
|
|
37
37
|
* `.codegraph-*` sibling. File-watching and the indexer skip ALL of these, so
|
|
38
38
|
* when two environments share one working tree (Windows + WSL, issue #636)
|
|
39
|
-
* neither indexes or watches the other's index directory.
|
|
39
|
+
* neither indexes or watches the other's index directory. The prefix match
|
|
40
|
+
* also covers the legacy `.codegraph-vba/` directory older releases of this
|
|
41
|
+
* fork wrote, so a stale one left in a consumer repo is never indexed.
|
|
40
42
|
*/
|
|
41
43
|
export declare function isCodeGraphDataDir(name: string): boolean;
|
|
42
44
|
/**
|
package/dist/upgrade/index.d.ts
CHANGED
|
@@ -26,6 +26,13 @@
|
|
|
26
26
|
export declare const REPO = "ardelperal/codegraph-vba";
|
|
27
27
|
export declare const NPM_PACKAGE = "@aroman22/codegraph-vba";
|
|
28
28
|
export declare const INSTALL_SH_URL = "https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.sh";
|
|
29
|
+
export declare const INSTALL_PS1_URL = "https://raw.githubusercontent.com/ardelperal/codegraph-vba/main/install.ps1";
|
|
30
|
+
/**
|
|
31
|
+
* The one-line shell command that installs the CLI from GitHub Releases on
|
|
32
|
+
* this platform (issue #326 — no npm). Used both to run the install and in
|
|
33
|
+
* user-facing hints, so the two can never disagree.
|
|
34
|
+
*/
|
|
35
|
+
export declare function cliInstallCommand(platform: NodeJS.Platform): string;
|
|
29
36
|
export type InstallMethod = {
|
|
30
37
|
kind: 'bundle';
|
|
31
38
|
os: 'unix' | 'windows';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aroman22/codegraph-vba",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Local-first code intelligence for AI agents (MCP). Self-contained — bundles its own runtime.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"codegraph-vba": "npm-shim.js"
|
|
@@ -15,12 +15,12 @@
|
|
|
15
15
|
"./package.json": "./package.json"
|
|
16
16
|
},
|
|
17
17
|
"optionalDependencies": {
|
|
18
|
-
"@aroman22/codegraph-vba-darwin-arm64": "1.
|
|
19
|
-
"@aroman22/codegraph-vba-darwin-x64": "1.
|
|
20
|
-
"@aroman22/codegraph-vba-linux-arm64": "1.
|
|
21
|
-
"@aroman22/codegraph-vba-linux-x64": "1.
|
|
22
|
-
"@aroman22/codegraph-vba-win32-arm64": "1.
|
|
23
|
-
"@aroman22/codegraph-vba-win32-x64": "1.
|
|
18
|
+
"@aroman22/codegraph-vba-darwin-arm64": "2.1.0",
|
|
19
|
+
"@aroman22/codegraph-vba-darwin-x64": "2.1.0",
|
|
20
|
+
"@aroman22/codegraph-vba-linux-arm64": "2.1.0",
|
|
21
|
+
"@aroman22/codegraph-vba-linux-x64": "2.1.0",
|
|
22
|
+
"@aroman22/codegraph-vba-win32-arm64": "2.1.0",
|
|
23
|
+
"@aroman22/codegraph-vba-win32-x64": "2.1.0"
|
|
24
24
|
},
|
|
25
25
|
"files": [
|
|
26
26
|
"npm-shim.js",
|