Skip to content

vir documentation

vir reads the Claude Code and Codex transcripts already on your disk, filters out what isn’t yours, and writes typed markdown notes into a folder you own — an Obsidian vault works great, but any folder does. It’s a CLI, an MCP server, an Obsidian plugin, and a skill any coding agent can install. Nothing is hosted.

New here? Getting started takes about five minutes.

Getting started Prerequisites, install, your first run, and what appears in the vault
How it works The pipeline, what gets filtered and why, the anatomy of a note, and the quality controls
Inputs The sources: Claude Code and Codex sessions, clipped web articles, PDFs
Codex Codex sessions, the keyless codex-cli provider, and Codex over MCP
Retrieval and MCP vir query, embedding providers, and letting Claude Code or Codex consult the vault mid-session
Keeping it current The daemon, sync-claude (CLAUDE.md and AGENTS.md), review, lint, dedupe, and syntheses
Recurring rules vir connect: lessons you keep re-learning, proposed as cited rules that reach CLAUDE.md only with your yes
Any agent The skill that lets Claude Code, Codex, Cursor and others check your notes before they work
Commands Every subcommand, with what it costs
Providers and cost The four distill providers, measured spend, hybrid routing, and every cost control
Configuration Every key in ~/.vir/config.json, with defaults
Obsidian plugin The sidebar: recent notes, related notes, daemon health
Troubleshooting Start with vir doctor, then the failures people actually hit
Privacy What leaves your machine, what stays, and what you can turn off
Changelog Every release, newest first

GitHub · npm · Obsidian plugin · Report an issue