Quick Start

Get up and running with Ody Refine in under 2 minutes.

Install and Run

Zero-install with npx:

npx ody-refine ./docs/

Or install globally:

npm install -g ody-refine
ody-refine ./docs/

Requirements

• Node.js >= 20
• Ollama for local LLM inference -- install here
• Or set an API key environment variable to use a hosted provider (see below)

LLM Providers

Refine auto-detects your provider from environment variables. Set any one of these:

Provider	Env Variable	Default Model
Anthropic	ANTHROPIC_API_KEY	claude-haiku-4-5-20251001
OpenAI	OPENAI_API_KEY	gpt-4o-mini
Groq	GROQ_API_KEY	llama-3.3-70b-versatile
Gemini	GEMINI_API_KEY	gemini-2.0-flash
xAI	XAI_API_KEY	grok-4.1-fast-non-reasoning
OpenRouter	OPENROUTER_API_KEY	google/gemini-2.0-flash-lite-001
Ollama	(none, local)	llama3

Auto-detection priority: Anthropic > OpenAI > Groq > Gemini > xAI > OpenRouter > MLX (Apple Silicon) > Ollama.

# Example: use Anthropic
export ANTHROPIC_API_KEY=sk-ant-...
npx ody-refine ./docs/

# Example: use OpenRouter with a specific model
OPENROUTER_API_KEY=sk-or-... npx ody-refine ./docs/ \
  --provider openrouter \
  --model google/gemini-2.0-flash-lite-001

# Example: use Ollama (no API key needed)
npx ody-refine ./docs/ --provider ollama --model qwen2.5:7b

What It Looks Like

$ npx ody-refine ./docs/

ody-refine v0.1.0 — scanning ./docs/ (34 files)

  Contradictions   2 found
  Stale claims     5 found
  Time bombs       1 found
  Duplicates       3 found

  ┌─────────────────────────────────────────────────────┐
  │  Knowledge Health: 85/100                           │
  │  ██████████████████░░  2 contradictions need review  │
  └─────────────────────────────────────────────────────┘

  → Report saved to .ody-refine/report.html
  → Run `ody-refine resolve` to fix interactively

Next Steps

1. Resolve findings -- triage issues interactively with ody-refine resolve
2. Export training data -- generate DPO pairs with ody-refine export --format trl
3. Set up CI -- fail builds when docs health drops with ody-refine ci --min-health 80
4. Connect sources -- pull from Slack, Notion, Confluence, and more with ody-refine connect