CLAUDE.md — aiframework

Make Claude Code understand your project instantly. Stack: Rust.

Commands

# Build
cd rust && cargo build --release

# Lint
cd rust && cargo clippy

# Test
cd rust && cargo test

# Run
cd rust && cargo run -- run --target /path/to/repo

Architecture

• Stack: Rust (single binary, 8.9 MB, zero runtime deps)
• Archetype: cli-tool (active, complex)

Key Locations

• CLI: rust/src/cli.rs
• Scanners: rust/src/scanner/ (13 scanners)
• Indexer: rust/src/indexer/ (13 language parsers, 8 tree-sitter)
• Generators: rust/src/generator/ (14 generators)
• Validators: rust/src/validator/mod.rs (5 checks)
• MCP Server: rust/src/mcp/mod.rs
• Config/Tiers: rust/src/config.rs
• Telemetry: rust/src/telemetry.rs
• UI: rust/src/ui.rs
• Language Registry: rust/data/languages.json

Most important files (by dependency rank):

• rust/src/cli.rs
• rust/src/indexer/mod.rs
• rust/src/scanner/mod.rs
• rust/src/generator/mod.rs
• rust/src/generator/claude_md.rs
• rust/src/config.rs
• rust/src/ui.rs
• rust/src/indexer/graph.rs
• rust/src/validator/mod.rs
• rust/src/mcp/mod.rs

Invariants

• INV-1: LLM trust boundary — validate all AI output
• INV-2: No secrets in source code

Gotchas

• Tree-sitter parsers are NOT thread-safe — create one per rayon thread
• Generators never overwrite user-created files (check write_if_missing_or_generated)
• Tier system gates generators: Lean < Standard < Full < Enterprise
• rust/data/languages.json is embedded at compile time via include_str!
• Manifest field names must match bash version for backward compatibility (e.g., short alias)

Makefile

make build
make install
make uninstall
make lint
make test
make check
make dist

Key State

• Source files: 67 Rust files
• Tests: 42 (cargo test)
• Binary: 8.9 MB (release, stripped, LTO)

Generated by aiframework v2.0.0. Stack: Rust.