Skip to content

README.md

Latest commit

 

History

History
327 lines (227 loc) · 4.75 KB

README.md

File metadata and controls

327 lines (227 loc) · 4.75 KB
Raw

🏛️ Archeon

Archeon

Understand any Rust codebase in 30 seconds.

Semantic code comprehension engine for Rust.

Install • Commands • Architecture • Examples • License

Build a semantic knowledge graph of your project and ask human questions instead of searching files.

Rust License Tests Zero Dependencies Status

Not a linter. Not a formatter. Not another grep.
Archeon is a code comprehension engine.

✨ Why Archeon?

Most tools answer:

"Where is this function?"

Archeon answers:

  • 🧠 What does this function actually do?
  • 🕸️ What depends on it?
  • 🚦 How do I get from A to B?
  • 📈 Which components are most important?
  • 🩺 What should I fix first?
  • 🏗️ How is this project architected?

🚀 Demo

archeon analyze serde
Repository
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Language          Rust
Architecture      Mixed
Definitions       4762
Dependencies      2847
Resolver          53.8%

Health Score
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

███████████░░░░░░░░░ 58/100   Grade C

Repository Scorecard

Architecture      B
Maintainability   B
Complexity        C
Coupling          A
Testing           N/A

Architectural Hubs

1. Str (Struct)
2. test (Function) ◉ HUB

⚡ Four Commands

🔍 Analyze

Understand an entire repository.

archeon analyze <path>

✔ Health Score

✔ Repository Scorecard

✔ Architectural Hubs

✔ Insights

✔ Dependency Graph

🧠 Explain

Understand any symbol.

archeon explain add
add

This is a domain service.

Belongs to:
Domain Layer

Used by:
5 symbols

Impact:
Low

Architectural violations:
None detected

Confidence:
86%

🛣 Journey

Find how two symbols are connected.

archeon journey main add
main
  │
  ▼
add

Confidence 80%

🩺 Doctor

Prioritized improvements.

archeon doctor serde
Priority 1
Remove circular dependency
+8 Health

Priority 2
Split UserService
+5 Health

Estimated Health
73/100 (B)

⚙ Installation

Cargo

cargo install archeon-cli

Build from source

git clone https://github.com/beatzip/Archeon-Ai.git

cd Archeon-Ai

cargo build --release

🏗 Architecture

        Scanner
            │
            ▼
        Tree-sitter
            │
            ▼
      Symbol Engine
            │
            ▼
        Resolver
            │
            ▼
     Intelligence Engine
            │
            ▼
     Reasoning Engine
            │
            ▼
      Human Narrative

🧬 Pipeline

Files
   │
   ▼
AST
   │
   ▼
Definitions
   │
   ▼
Dependency Graph
   │
   ▼
Semantic Knowledge
   │
   ▼
Human Explanation

🎯 Why not grep?

Question grep Archeon
Find a symbol ✅ ✅
Find callers ❌ ✅
Explain what it does ❌ ✅
Discover architecture ❌ ✅
Find critical components ❌ ✅
Find path A → B ❌ ✅
Prioritize technical debt ❌ ✅

📚 Commands

Command Description
analyze Repository overview
explain Explain any symbol
journey Trace dependencies
doctor Prioritized improvements

🔧 Global Flags

--verbose
--debug
--json
--check

🚦 Exit Codes

Code Meaning
0 Success
1 Critical insights found (--check)
2 CLI error
3 Parse error
4 Invalid arguments

🧩 How Archeon is Different

Traditional static analyzers tell you:

❌ "Something is wrong."

Archeon tells you:

✅ "Here's how this part of the system works, why it matters, and what to improve first."

📄 License

MIT