# Grits
A Git-native, local-first issue tracker with a **Twin Engine** architecture:
- 🤖 **Agent Engine**: MCP server + agent-native CLI (inspect, workon, pulse, refactor)
- 👀 **Grits Studio**: VS Code extension with 3D topology visualization + command center UI
**Status**: v2.3.0 — "Mini Codebase"
## Quick Start
### Prerequisites
- Rust (latest stable)
- Git
- Node.js 18+ (for VS Code extension)
### Install CLI
```bash
# Via Cargo (recommended)
cargo install grits-cli
# Or download binary from Releases
# https://github.com/babybirdprd/grits/releases
```
### Initialize a Project
```bash
cd your-project
gr onboard
```
## v2.0 Highlights
### 🚀 Agent-Native Commands
```bash
# Session hydration - get project context instantly
gr pulse
# One-shot context for any target
gr inspect gr-abc123 # Issue
gr inspect src/main.rs # File
# Start working (creates branch + sets status + outputs context)
gr workon gr-abc123
# Fuzzy shorthand updates
gr set gr-abc pri:1 stat:ip +l:urgent
# Auto-fix dependency cycles
gr refactor --apply --cycle 0
```
### 🔬 Solid Graph Topology
```bash
# Build topology cache (Tree-sitter: Rust, TS, JS, Python, Go)
gr analysis rebuild
# Compute Solid Score (architectural health metric)
gr stats --topology
# Detect and auto-fix cycles
gr refactor # Show cycles + suggestions
gr refactor --apply --cycle 0 # Apply fix
gr refactor --undo --target f # Restore from backup
```
| **Edge Persistence** | Identify weakest links in cycles |
| **Star Neighborhoods** | Context loading for AI editing |
| **Mini Codebase** | Semantic tree-shaking for agents |
| **Monorepo Support** | Cargo, pnpm, turbo, go.work detection |
### 🧠 Mini Codebase (NEW)
```bash
# Assemble focused context from topology
gr context assemble --issue gr-abc123
# Specify symbols directly
gr context assemble --symbols "store.rs::Store" --depth 2 --format json
```
**Why?** Instead of loading entire files, extract only the topologically-relevant symbols. A 2,000-line file becomes 50 focused lines.
### 📺 Grits Studio (VS Code)
The extension opens as a **command center** with:
- **Left Sidebar**: Icon-based navigation (Linear/Jira style)
- **Top Header**: Live stats (In Progress, Blocked, Solid Score)
- **3D Topology View**: React Three Fiber + Node Inspector with "Copy for Agent" button
- **Focus View**: Blocked items prominently displayed with quick actions
- **List/Kanban/Graph**: Standard issue management
---
## Twin Engine Architecture
### 🔗 Tethered Sync
- **SQLite** (`.grits/grits.db`) — Fast local queries
- **JSONL** (`.grits/issues.jsonl`) — Git-versioned, human-readable
- All commands auto-sync between engines
### 🤖 Agent Engine (MCP Server)
```bash
gr serve-mcp
```
**Antigravity Config** (`.vscode/mcp.json`):
```json
{
"servers": {
"grits": {
"command": "gr",
"args": ["serve-mcp"],
"env": { "GRITS_PROJECT_ROOT": "${workspaceFolder}" }
}
}
}
```
**16 MCP Tools:**
| CRUD | `list_issues`, `create_issue`, `update_issue`, `close_issue`, `get_issue` |
| Search | `search_issues`, `find_related_issues`, `detect_duplicates` |
| Strategic | `get_next_task`, `summarize_sprint`, `cleanup_stale` |
| Context | `suggest_issue_for_error`, `infer_issue_from_diff` |
---
## CLI Reference (v2.4.5)
### Agent-Native (NEW)
| `gr pulse` | Session hydration |
| `gr inspect <target>` | One-shot context |
| `gr workon <id>` | Start work (branch + status) |
| `gr set <id> <changes>` | Fuzzy updates |
| `gr refactor` | Auto-fix cycles |
### Core
| `gr create` | Create issue |
| `gr update` | Update issue |
| `gr list` | List issues |
| `gr ready` | Actionable issues |
| `gr sync` | Git sync |
### Analysis
| `gr analysis rebuild` | Build topology cache |
| `gr analysis star <sym>` | Star neighborhood |
| `gr analysis volumes <file>` | Feature clusters |
| `gr analysis check-layers` | Architectural invariants |
| `gr analysis search <query>` | BM25 search |
### Context (NEW v2.3)
| `gr context assemble` | Mini codebase for agents |
| `gr context error` | Find issues by error message |
| `gr context diff` | Infer issue from git diff |
---
## Project Structure
```
grits/
├── grits-core/ # Core library (WASM-compatible)
│ └── src/topology/ # Solid Graph analysis
│ ├── analysis.rs # Betti numbers, PageRank, persistence
│ ├── refactor.rs # Auto-fix cycle mutations
│ └── workspace.rs # Monorepo detection
├── grits-cli/ # CLI + MCP server
├── extension/ # VS Code extension
│ └── webview/ # React + Three.js dashboard
└── .agent/workflows/ # Agent workflow rules
```
---
## Documentation
- [AGENTS.md](AGENTS.md): Comprehensive agent guide
- [docs/cli_usage.md](docs/cli_usage.md): Full command reference
- [docs/architecture.md](docs/architecture.md): Twin Engine design
## Credits
Inspired by [Beads](https://github.com/steveyegge/beads) by Steve Yegge —
"A memory upgrade for your coding agent."
Based on the ["Solid Graph" philosophy](https://arxiv.org/html/2512.19736v1) from algebraic topology.
## License
MIT