omm

omm setup

Re-run the first-time setup wizard — a hardware scan followed by a checklist of local AI runners to install — any time, not just on first run.

01 / 06

Overview

setup is what runs automatically the first time omm is used, and it's also the command to reach for later: to pick up a runner you skipped, to re-check your hardware summary, or to turn shell tab-completion on. It takes no arguments — everything it does is an interactive step: a hardware summary, a checklist of runners (already-installed ones shown but not selectable), a one-time data-sharing question, and an offer to enable tab-completion. The data-sharing step spells out exactly what one anonymous daily batch would contain and defaults to No; answering yes also turns crash reports on, and either answer can be changed later with omm setting upload. It needs a real terminal; running it with no TTY attached fails immediately instead of hanging, and a non-interactive run leaves usage stats and crash reports off.

02 / 06

Options

Every flag this command accepts, and what it defaults to when you leave it out.

  • --quiet—Default: off

    Suppress the engine-install progress lines while the wizard installs the runners you picked. Prompts, warnings and the final summary still print.

03 / 06

Examples

From a plain search to something you'd put in a script.

The full wizard: hardware summary, runner checklist, tab-completion offer.

$ omm setup

Same wizard, without the per-line progress output while runners install.

$ omm setup --quiet

04 / 06

A real run

Two real driven runs, both through a real terminal against a throwaway OMM_HOME so nothing touched this machine's real config. The banner, theme picker, hardware summary and runner checklist come from the 2026-08-25 run against the same mid-range PC recommend's page uses (Intel Core Ultra 7 155H, 15.5 GB RAM, Intel Arc, Ollama/LM Studio/Jan already installed) rather than this session's own laptop. The data-sharing panel, the declined answer, and the closing lines were re-captured on 2026-09-01, after the data-sharing step landed, on this session's laptop — verbatim, panel borders included. The theme picker, runner checklist and consent prompt are questionary screens rendered straight to the terminal, captured through a terminal emulator rather than plain stdout.

06 / 06

If something goes wrong

Every message below is one this command actually prints. Find yours, read why it happened, then do the last line.

  1. Engine selection requires an interactive terminal. Re-run this command from a real terminal.
    why
    The runner checklist is an interactive prompt, and this run's stdin wasn't a real terminal (e.g. piped, or run from a script).
    what to do
    Run omm setup from an actual terminal.
    source
    src/omm/onboarding.py:232-233
  2. AnythingLLM isn't auto-installable yet. Install it yourself, then re-run `omm setup` or `omm link`. See https://omm.run/#runners
    why
    Some runners don't have an automated installer on every platform yet — this one has to be installed by hand on this system.
    what to do
    Install it yourself from the compatible-programs list, then re-run omm setup or omm link so omm picks it up.
    source
    src/omm/onboarding.py:276-278
  3. Couldn't enable tab-completion automatically. Run `omm --install-completion` to set it up manually.
    why
    Enabling tab-completion writes to your shell's config, which can fail for reasons specific to that shell or its config file's permissions.
    what to do
    Run omm --install-completion yourself to see the underlying error, or set it up manually.
    source
    src/omm/onboarding.py:396-397

Still stuck? Open an issue with the exact message you saw.

All commands