# Skelecode
**Code structure scanner that generates project-wide context graphs for humans and AI.**
> [!NOTE]
> **Stable Release v1.0.0** β All core phases (1-12) are completed.
Skelecode scans your source code and produces a compact structural representation, preserving types, methods, and call relationships while stripping implementation details. Perfect for giving LLMs project-wide context without hitting token limits.
## β¨ Features
- π₯οΈ **Interactive TUI** β Browse modules, types, and methods with live **Obsidian Preview**.
- π¦ **Multi-language Support** β Built-in parsers for **Rust**, **Java**, **Kotlin**, **JavaScript**, **TypeScript**, and **Python**.
- π΅οΈ **Symbol Search** β Real-time TUI jump-to-symbol with live filtering and highlighting.
- πΈοΈ **Advanced Call Graph** β Heuristic call resolution (Level 1 & 2) and **Reverse Call Graphs** (Phase 10).
- π€ **AI-Ready Output** β Export "Machine Context" format optimized for LLMs.
- π **Obsidian Vault** β Generate an interactive knowledge graph with rich Dataview metadata.
- π **Performance** β Fast, tree-sitter based analysis with builtin exclusion for build artifacts.
## π Quick Start
```bash
# Clone and build
git clone https://github.com/gianglaodai/skelecode.git
cd skelecode
cargo build --release
# Launch TUI to scan a project
./target/release/skelecode /path/to/your/project
```
## β¨οΈ TUI Keybindings
| `Enter` / `l` / `β` | Expand node / Toggle details |
| `h` / `β` | Collapse node / Jump to parent |
| `/` | **Symbol Search** (live filter) |
| `Tab` | Switch between Machine Context & Obsidian Preview |
| `y` | **Copy** current detail panel to clipboard |
| `u` / `d` | **Scroll** detail panel up/down |
| `e` | Open Export Overlay |
| `b` / `Esc` | Back to Welcome Screen |
| `q` | Quit |
## π Documentation
Detailed documentation is available in the [docs/](docs/README.md) folder:
- [**README**](docs/README.md) β Overview, installation, and TUI guide.
- [**CLI Usage**](docs/cli.md) β Command-line arguments and non-interactive mode.
- [**Architecture**](docs/architecture.md) β Internals, Unified IR, and Parser design.
- [**Output Formats**](docs/output-formats.md) β Obsidian Vault and Machine Context specifications.
## π οΈ Built With
- [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) β High-performance parsing.
- [Ratatui](https://ratatui.rs/) β Interactive terminal interface.
- [Clap](https://clap.rs/) β Robust CLI argument handling.
License: MIT