code-kg

Local code knowledge graph CLI for TypeScript/JavaScript projects.

• Builds a local graph in SQLite
• Serves an interactive full 3D graph UI with Rust+WASM layout acceleration
• Exposes deterministic JSON APIs for graph exploration and insights

Privacy

code-kg runs locally and does not send code to external services by default.

Quick Start (npx)

npx code-kg

This will:

1. Index the current directory
2. Start the local server on port 4783
3. Print the local UI URL

Explicit Commands

# index project
npx code-kg init --path .

# re-index project
npx code-kg reindex --path .

# serve graph UI/API
npx code-kg serve --path . --port 4783

# one command flow
npx code-kg run --path . --port 4783 --open

Dev Dependency Workflow

npm i -D code-kg

Example package.json scripts:

{
  "scripts": {
    "codekg": "codekg",
    "codekg:run": "codekg run --path . --port 4783",
    "codekg:insights": "codekg insights --path . --format json --output .codekg/insights.json"
  }
}

CLI JSON Outputs

# ranked insights
npx code-kg insights --path . --limit 10 --format json

# filtered graph
npx code-kg graph \
  --path . \
  --view symbolGraph \
  --node-types Function,Class \
  --edge-types CALLS,REFERENCES \
  --format json

# shortest directed path
npx code-kg path \
  --path . \
  --from file:src/index.ts \
  --to file:src/server/app.ts \
  --max-depth 12 \
  --format json

API Endpoints

• GET /api/meta
• GET /api/search?q=...
• GET /api/node/:id
• GET /api/graph?view=fileDeps|moduleGraph|symbolGraph|all&nodeTypes=...&edgeTypes=...&q=...&limit=... (includes optional meta with query timing and recommended renderer quality mode)
• GET /api/subgraph?seed=<nodeId>&depth=2&direction=both
• GET /api/path?from=<nodeId>&to=<nodeId>&maxDepth=12&edgeTypes=...
• GET /api/routes
• GET /api/cycles
• POST /api/query
• POST /api/llm/query (optional stub)

Development

npm install
npm run wasm:build
npm run build
npm test
npm run test:perf