omen

Omen

A multi-language code analysis CLI built in Go. Omen uses tree-sitter for parsing source code across 13 languages, providing insights into complexity, technical debt, code duplication, and defect prediction.

Features

• Cyclomatic & Cognitive Complexity - Measure code complexity at function and file levels
• Self-Admitted Technical Debt (SATD) - Detect TODO, FIXME, HACK markers and classify severity
• Dead Code Detection - Find unused functions and variables
• Git Churn Analysis - Identify frequently changed files
• Code Clone Detection - Find duplicated code blocks (Type-1, Type-2, Type-3 clones)
• Defect Prediction - Predict defect probability using PMAT weights
• Technical Debt Gradient (TDG) - Composite scoring for prioritizing refactoring
• Dependency Graph - Generate Mermaid diagrams of module dependencies

Supported Languages

Go, Rust, Python, TypeScript, JavaScript, TSX/JSX, Java, C, C++, C#, Ruby, PHP, Bash

Installation

go install github.com/panbanda/omen/cmd/omen@latest

Or build from source:

git clone https://github.com/panbanda/omen.git
cd omen
go build -o omen ./cmd/omen

Quick Start

# Run all analyzers
omen analyze ./src

# Analyze complexity
omen analyze complexity ./src

# Detect technical debt
omen analyze satd ./src

# Find dead code
omen analyze deadcode ./src

# Analyze git churn (last 90 days)
omen analyze churn ./

# Detect code clones
omen analyze duplicates ./src

# Predict defect probability
omen analyze defect ./src

# Calculate TDG scores
omen analyze tdg ./src

# Generate dependency graph
omen analyze graph ./src --metrics

Commands

Top-level Commands

Analyzer Subcommands (omen analyze <subcommand>)

Output Formats

All commands support multiple output formats:

omen analyze complexity ./src -f text      # Default, colored terminal output
omen analyze complexity ./src -f json      # JSON for programmatic use
omen analyze complexity ./src -f markdown  # Markdown tables
omen analyze complexity ./src -f toon      # TOON format

Write output to a file:

omen analyze ./src -f json -o report.json

Configuration

Create omen.toml, .omen.toml, or .omen/omen.toml:

[exclude]
patterns = ["vendor/**", "node_modules/**", "**/*_test.go"]
dirs = [".git", "dist", "build"]

[thresholds]
cyclomatic = 10
cognitive = 15
duplicate_min_lines = 6
duplicate_similarity = 0.8
dead_code_confidence = 0.8

[analysis]
churn_days = 90

See omen.example.toml for all options.

Examples

Find Complex Functions

omen analyze complexity ./pkg --functions-only --cyclomatic-threshold 15

High-Risk Files Only

omen analyze defect ./src --high-risk-only

Top 5 TDG Hotspots

omen analyze tdg ./src --hotspots 5

Generate LLM Context

omen context ./src --include-metrics --include-graph

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -am 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a Pull Request

Acknowledgments

Omen draws heavy inspiration from paiml-mcp-agent-toolkit - a fantastic CLI and comprehensive suite of code analysis tools for LLM workflows. If you're doing serious AI-assisted development, it's worth checking out. Omen exists as a streamlined alternative for teams who want a focused subset of analyzers without the additional dependencies. If you're looking for a Rust-focused MCP/agent generator as an alternative to Python, it's definitely worth checking out.

License

MIT License - see LICENSE for details.