https://github.com/gjczone/pi-shazam
A native codebase awareness extension for the Pi coding agent that delivers analysis tools and hooks for AI agents, and also enables non‑Pi agents (via MCP, e.g., Cursor, Claude Code, Kimi‑code, Trae, Qoder, Codebuddy) to achieve full tool support like pi‑shazam.
https://github.com/gjczone/pi-shazam
ai-coding ast claude-desktop code-analysis codebase-analysis cursor dependency-graph lsp mcp pagerank pi-agent pi-package tree-sitter
Last synced: 8 days ago
JSON representation
A native codebase awareness extension for the Pi coding agent that delivers analysis tools and hooks for AI agents, and also enables non‑Pi agents (via MCP, e.g., Cursor, Claude Code, Kimi‑code, Trae, Qoder, Codebuddy) to achieve full tool support like pi‑shazam.
- Host: GitHub
- URL: https://github.com/gjczone/pi-shazam
- Owner: gjczone
- License: mit
- Created: 2026-06-05T07:44:20.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-22T01:06:09.000Z (16 days ago)
- Last Synced: 2026-06-22T02:31:22.649Z (16 days ago)
- Topics: ai-coding, ast, claude-desktop, code-analysis, codebase-analysis, cursor, dependency-graph, lsp, mcp, pagerank, pi-agent, pi-package, tree-sitter
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/pi-shazam
- Size: 1.1 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# pi-shazam
Codebase awareness toolkit for the Pi coding agent — 7 structural analysis tools powered by tree-sitter and LSP that give your agent deep understanding of any project.
## Installation
Two ways to use pi-shazam, depending on your agent:
### Native Extension — Pi Coding Agent only
For the [Pi coding agent](https://github.com/gjczone/pi-coding-agent). Installs as a first-class extension — tools appear alongside `read`/`write`/`bash` with no distinction.
```bash
pi install npm:pi-shazam
```
### MCP Server — all other AI agents
For Kimi Code, CodeBuddy, Qwen Code, Claude, Codex, Qoder, Trae, and any MCP-compatible client.
```json
{
"mcpServers": {
"pi-shazam": {
"command": "npx",
"args": ["-y", "-p", "pi-shazam@latest", "pi-shazam-mcp"]
}
}
}
```
## Analysis Tools
| Tool | When to use | What it does |
| ---------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| `shazam_overview` | First entry, need project structure | Project summary: top files, dependencies, hotspots, entry points, key data structures |
| `shazam_lookup` | Need symbol details or concept search | Unified lookup + fuzzy concept search ("how is X implemented") |
| `shazam_impact` | Before editing shared or exported modules | Blast radius analysis — every file, symbol, and test affected by a change |
| `shazam_verify` | After every write or edit | Post-edit verification: LSP diagnostics with auto-detection of unreliable servers, graph analysis, PASS/WARN/FAIL |
| `shazam_changes` | After edits to see what changed | Git change summary with symbol-level detail, risk level, affected callers |
| `shazam_format` | When `shazam_verify` reports format errors | Auto-fix formatting (prettier, biome, eslint, ruff, cargo fmt, gofmt) |
| `shazam_rename_symbol` | Before renaming any symbol | LSP cross-file symbol rename with atomic writes |
## Slash Commands
Setup and hook installation run automatically on session start. No manual commands needed.
| Command | When | Purpose |
| --------------------------- | -------------------- | -------------------------------------------------------------------- |
| `/shazam-setup` | Automatic (on start) | Detect and report LSP server availability with install instructions |
| `/shazam-install-git-hooks` | Automatic (on start) | Install git pre-commit hook that runs `shazam_verify` |
| `/shazam-doctor` | When troubleshooting | Health check: tree-sitter grammars, LSP servers, cache integrity |
| `/shazam-remove-git-hooks` | When uninstalling | Remove the shazam git pre-commit hook |
| `/shazam-pre-commit-verify` | Automatic (by hook) | Run pre-commit verification (called by git hook; not for manual use) |
## Supported Languages
| Language | Tree-sitter | LSP |
| ---------- | ----------- | --------------------------- |
| Python | Yes | pyright / pylsp |
| TypeScript | Yes | typescript-language-server |
| JavaScript | Yes | typescript-language-server |
| Go | Yes | gopls |
| Rust | Yes | rust-analyzer |
| Dart | Yes | dart language-server |
| JSON | Yes | vscode-json-language-server |
| YAML | - | yaml-language-server |
## Platform Support
| Platform | Status |
| -------- | ------------------------------------------- |
| Linux | Supported |
| macOS | Supported |
| Windows | Not supported (tree-sitter native bindings) |
## License
[MIT](LICENSE)