Documentation

AIOptimize docs

AIOptimize is a static-first auditor for AI codebases. It reads your repo, maps every LLM call against a continuously-updated knowledge base of provider best practices, and emits concrete diffs with cost and latency impact estimates.

Quickstart

Install the CLI and scan your first repo in under a minute.

bash

# Recommended: isolated install with pipx
$ pipx install aioptimize

# Or into your project
$ pip install aioptimize

# Run a scan
$ aioptimize scan .

Common output formats

bash

# Human-readable terminal output
$ aioptimize scan .

# JSON for CI or tooling
$ aioptimize scan . --format json > findings.json

# Markdown suitable for PR comments
$ aioptimize scan . --format markdown > REPORT.md

# Fail CI if any warn/error findings
$ aioptimize scan . --fail-on-severity warn

# Suppress specific rules
$ aioptimize scan . --ignore D003

Walk through a full example in the Quickstart guide.

v0.1 detectors

More detectors ship each sprint. Current coverage:

ID	Severity	Finds
D001	warn	Anthropic system prompt without `cache_control`
D002	warn	Deprecated model version (Anthropic + OpenAI)
D003	info	`messages.create` without `max_tokens`