Oh My Pi SDK for Workshop

This SDK provides omp, the oh-my-pi AI coding agent. It ships with hash-anchored edits, LSP integration, DAP debugging, persistent Python and JavaScript eval kernels, first-class subagents, and 40+ AI provider connections out of the box. Configuration, sessions, memory (Hindsight), and plugins are persisted across workshop updates.

---

Reference workshop

A minimal workshop:

# workshop.yaml
name: my-project
base: ubuntu@24.04
sdks:
  - name: omp
    channel: 15/edge

This gives you omp on your PATH inside the workshop immediately after workshop launch.

---

Using the SDK

Prerequisites, project layout

1. No prerequisite SDKs are required.
2. No specific project layout is needed. omp operates in any directory.
3. On launch, the SDK adds omp to PATH and installs bash completions. /home/workshop/.omp (config, sessions, API keys, plugins, Hindsight memory) is backed by a Workshop-managed private host directory — it persists across workshop stop/refresh and SDK updates, but it is not your existing host ~/.omp; a fresh workshop starts empty. See Use your host's ~/.omp below to opt in.

Running the agent

workshop shell

# Start an interactive session in your project
cd /project
omp

# Non-interactive one-shot
omp "explain the architecture of this codebase"

# Resume the most recent session
omp --resume

# Commit staged changes with atomic, dependency-ordered commits
omp commit

Configure API keys

Settings live in ~/.omp/agent/settings.yml (or via omp config):

workshop shell
omp config set providers.anthropic.apiKey sk-ant-...

All changes are persisted to a Workshop-managed host directory through the omp-home mount and survive SDK updates.

Shell completions

Bash completions are installed automatically. For other shells:

workshop shell

# zsh
eval "$(omp completions zsh)"

# fish
omp completions fish > ~/.config/fish/completions/omp.fish

Verify from the command line

workshop shell
omp --version

---

Plugs (resources this SDK consumes)

omp-home

• Interface: mount
• Workshop target: /home/workshop/.omp
• Purpose: Persists all of omp's state — agent config and API keys (~/.omp/agent/settings.yml), session history (history.db), Hindsight memory (memories/), installed plugins (plugins/), and the Python eval environment (python-env/) — across workshop updates. The host source is a private directory Workshop allocates under $XDG_DATA_HOME (not your existing host ~/.omp); a fresh workshop starts empty.

Use your host's ~/.omp

By default Workshop mounts a private host directory into /home/workshop/.omp. To use your real host ~/.omp instead, run these commands on the host (the workshop must be stopped first because ~/.omp is not empty):

workshop stop <workshop>
workshop remount <workshop>/omp:omp-home ~/.omp
workshop start <workshop>

The mount is read-write: omp will read and write your host ~/.omp directly.

To revert to the private Workshop-managed directory:

workshop disconnect <workshop>/omp:omp-home --forget
workshop refresh <workshop>

---

Documentation and guidance

• Oh My Pi documentation
• Workshop documentation
• DEVELOPERS.md — branch model, release automation, bootstrapping a new major
• AGENTS.md — quick-restart context for AI coding agents working in this repo

---

Community and support

• Oh My Pi community: Discord
• Workshop forum: Discourse
• Please review our Code of Conduct before participating.

---

Contributions

All contributions, including code, documentation updates, and issue reports, are welcome!

• See CONTRIBUTING.md for guidelines.
• Open issues or pull requests on the official repository.

---

License and copyright

Copyright 2026 Canonical Ltd.

This SDK is released under the MIT License.

Oh My Pi is licensed under the MIT License.