OpenReport

AI-powered code analysis reports for your projects.

OpenReport is a modern CLI/TUI tool that orchestrates multiple AI agents to generate comprehensive, structured reports about your codebase. Get architecture reviews, security audits, code quality assessments, and more — all from your terminal.

Features

• Multi-agent AI analysis — Specialized agents work in parallel to analyze different aspects of your project
• 8 analysis agents — Architecture, security, code quality, dependencies, performance, test coverage, API docs, onboarding
• Interactive TUI — Navigate reports, configure settings, and manage history from a beautiful terminal UI
• HTML reports — Export reports as styled HTML pages you can share with your team
• Todo list generation — Automatically generate actionable todo lists from findings
• Multi-provider support — Use any AI provider: Anthropic, OpenAI, Google, Mistral, Ollama, or CLI tools like Claude Code, Gemini CLI, Codex CLI

Quick Start

# Install globally
bun add -g openreport

# Initialize configuration
openreport init

# Launch the interactive TUI
openreport

# Or run a report directly
openreport run

Report Types

Report Type	Agents	Description
Full Audit	architecture, security, code-quality, dependencies, performance, test-coverage	Comprehensive analysis covering all aspects
Quick Health	code-quality, dependencies	Fast overview of code quality and dependencies
Security Review	security, dependencies	Focused security audit
Architecture	architecture	Architecture analysis with diagrams and patterns
Dependencies	dependencies	Dependency health, vulnerabilities, and licenses
Onboarding	onboarding, architecture	New developer onboarding guide

Additional agents available: API Documentation, Todo Generator.

Providers

API Providers

Provider	Default Model	Env Variable
Anthropic	claude-sonnet-4-5-20250929	ANTHROPIC_API_KEY
OpenAI	gpt-4o	OPENAI_API_KEY
Google	gemini-2.0-flash	GOOGLE_GENERATIVE_AI_API_KEY
Mistral	mistral-large-latest	MISTRAL_API_KEY
Ollama	qwen2.5-coder:14b	Local (no key needed)

CLI Providers

Provider	CLI Tool	Description
claude-code	claude	Uses Claude Code CLI (default provider)
gemini-cli	gemini	Uses Gemini CLI
codex-cli	codex	Uses Codex CLI

CLI providers are auto-detected and wrap existing CLI tools via subprocess.

Configuration

OpenReport uses a .openreport.json file in your project root. Run openreport init to create one, or create it manually:

{
  "defaultProvider": "claude-code",
  "defaultModel": "sonnet",
  "providers": {
    "anthropic": { "apiKey": "sk-..." }
  },
  "output": {
    "directory": ".openreport/reports",
    "format": "markdown"
  },
  "agents": {
    "maxConcurrency": 3,
    "temperature": 0.3
  },
  "features": {
    "todoList": false
  }
}

CLI Commands

Command	Description
openreport	Launch the interactive TUI
openreport run	Run a report directly (non-interactive)
openreport init	Initialize configuration in the current project
openreport list	List previously generated reports
openreport view <id>	View a specific report

Requirements

• Bun >= 1.0
• At least one AI provider configured (API key or CLI tool installed)

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

License

MIT — Copyright (c) 2025 timiliris