Oh My Pi

🚀 Getting Started

2 min read

Install omp, start a session, and give it the context and inputs that matter on day one.

Install

curl -fsSL https://omp.sh/install | sh          # macOS / Linux
brew install can1357/tap/omp                    # Homebrew
bun install -g @oh-my-pi/pi-coding-agent        # Bun >= 1.3.14
irm https://omp.sh/install.ps1 | iex            # Windows PowerShell, native
mise use -g github:can1357/oh-my-pi             # pinned versions
  • Completions: eval "$(omp completions zsh)" — also bash, fish.
  • omp setup — onboarding + optional dependencies.
  • omp update — stay current.

First session

cd your-repo
omp
  • /login — log in to a provider, inside the TUI.
  • Routing is by role: default, smol, slow, plan, advisor, … — mix a strong planner with a cheap worker.
  • /models — list available models. Alt+M — selector, assigns roles.

Four inputs that matter day one

InputEffect
/planRead-only planning mode; agent writes an execution spec to local://<slug>-plan.md and hands you the approval. Read the file.
Shift+TabCycle thinking (reasoning) level live. Bare ultrathink in a prompt buys one maximum-depth turn.
Ctrl+PCycle role models forward; Shift+Ctrl+P back, Alt+P temporary pick.
/omfgForges a permanent stream rule from your complaint about what the agent just did. Free until it fires.

Context files

Both discovered from the nearest ancestor of cwd:

FileJob
.omp/AGENTS.mdProject context: conventions, gotchas, architecture notes.
.omp/RULES.mdSticky rules, re-attached near the current turn so they still bite 200 messages in. Short, non-negotiable.

Example .omp/RULES.md:

Never commit or push unless I explicitly ask.
Do not edit generated files.
  • CLAUDE.md, AGENTS.md, Cursor rules, .clinerules are read natively — nothing to migrate; native .omp files win on collision.

Attach files

omp @spec.md @screenshot.png "implement this"
  • @path attaches files to the first message.
  • Ctrl+V pastes images inside the TUI.

Headless

omp -p "summarize the changes in this diff" --mode json --tools read,grep,glob --max-time 5m --no-session

Next

  • Cheat sheet — the whole surface on one page.
  • Settings — the config model, and the approvals decision you must make.
  • Traps — read before your first fan-out.
  • Source: oh-my-pi.

Condensed from the omp guide by Hugo Lopes (MIT). Verify against your install: omp config list.

Graph View

Backlinks