Skip to content

README.en.md

Latest commit

 

History

History
86 lines (67 loc) · 2.92 KB

README.en.md

File metadata and controls

86 lines (67 loc) · 2.92 KB
Raw

CodeSense

中文 | English

Config-driven code knowledge graph engine for Vue projects. Powered by tree-sitter AST parsing, LadybugDB graph database, MCP protocol, and Sigma.js visualization.

Inspired by GitNexus, with enhancements focused on Vue/Electron semantics.

Quick Start

# One-step onboarding: init → index → doctor → wiki → summary
npx @code-sense/core analyze

# Or step by step
npx @code-sense/core init --interactive
npx @code-sense/core index
npx @code-sense/core view
npx @code-sense/core serve

Install globally:

npm install -g @code-sense/core
code-sense analyze

Core Capabilities

  • Build graph nodes from .vue components, stores, routes, Electron IPC, and more
  • Build graph edges from imports, store usage, route mappings, and IPC channels
  • Detect Vue framework API calls (such as ref, computed, watch) and Electron communication links
  • Living Wiki: Auto-generate Markdown project knowledge base from the graph, with source evidence links
  • Incremental Refresh: --stale-only only refreshes wiki pages whose source dependencies changed
  • Flow Map: Trace complete business flows: route→component→store→composable→IPC
  • One-Step Analyze: Project onboarding in one command (config check→index→health check→wiki)
  • Provide MCP tools for impact analysis, call tracing, and semantic search
  • Provide interactive browser visualization via Sigma.js

Commands

Command Description
analyze One-step: auto-init, index, doctor checks, wiki, summary
index Build the knowledge graph
view Start visualization server (default port 3456)
serve Start MCP server for AI agents
wiki Generate Living Wiki (--stale-only for incremental refresh)
init Scaffold a default codesense.yaml
init --interactive Scaffold a fuller project config

MCP Tools (11 tools)

Tool What it does
entity_context Full context for file/entity
function_context Callers, callees, and sibling functions
impact_analysis Change impact analysis
diff_impact Git diff based impact tracing
route_map Route-to-component mapping
trace_usage Symbol usage trace with evidence
find_entrypoints Identify entry points (routes, pages, etc.)
semantic_search Semantic search for functions/snippets
flow_map Trace layered business flow for an entity (routes/components/stores/IPC)
project_overview Graph-level project stats
cypher Raw Cypher queries for debugging

MCP Config Example (Claude Code / Codex)

{
  "mcpServers": {
    "code-sense": {
      "command": "npx",
      "args": ["@code-sense/core", "serve"]
    }
  }
}

Do not hardcode absolute paths in MCP config, or multiple projects may connect to the same graph data directory.

License

MIT