Setup Guide

For a first run, start with Quickstart. This guide covers install and configuration details.

Install the CLI

npm install -g oh-my-experience
ome init

The first command installs the global ome command. The second starts the setup wizard, which chooses a library path, installs the default provider hook, and writes starter cards so you can verify recall immediately.

If you do not want a global install, run it with npx:

npx oh-my-experience init

Have your agent do it:

Help me set up Oh My Experience.

1. Run `ome init` and accept the default library path.
2. Run `ome doctor` to verify the library, config, and hook state.
3. Run `ome hook status --provider codex` to check the Codex hook state.

Report each result. If anything writes hooks, changes config, or needs my confirmation, call it out first.

After initialization, copy the printed first task to your agent to experience starter card recall.

You can re-run ome init later. If a library already exists, the wizard shows the current config as defaults.

Scripted initialization

For non-interactive environments:

ome init -y --data-dir ~/.oh-my-experience

-y skips interactive prompts for scripts, CI, or agent runners. Passing --data-dir explicitly prevents setup from targeting the wrong library.

Configure data directory

You can point it anywhere, including an Obsidian vault:

ome config preview dataDir ~/Obsidian/Oh-My-Experience   # Preview changes
ome config set dataDir ~/Obsidian/Oh-My-Experience       # Execute migration
ome doctor                                                # Confirm success

dataDir controls the global library and runtime state. It does not move project libraries. Project libraries are always discovered at <project-root>/.oh-my-experience/; initialize one with ome project init when the repository should carry its own cards.

Install hooks

ome hook status --provider codex     # Check current state
ome init --provider claude            # Add Claude hook
ome init --provider all               # Install both

ome init configures the Codex hook and installs the bundled OME skill by default. The wizard shows hook file paths before writing.

Uninstall

ome uninstall                         # Remove hooks, keep library
ome uninstall --provider all          # Remove all provider hooks
ome uninstall --delete-library --yes  # Delete all local data

Default uninstall removes prompt-time recall entry points and keeps the library. Use --delete-library only when you intentionally want to remove all local cards, reflect runs, and logs.

Spool (optional)

OME can optionally integrate with the Spool CLI, a local AI session index that unifies Claude, Codex, Gemini, and other agent histories. Core functionality works without it. Interactive ome init asks whether to install the Spool CLI after core setup:

npm install -g @spool-lab/cli

OME does not install the Spool desktop client. Scripted init (-y, dry-run) never prompts for Spool. See Import Sources.