ommv0.2.148

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 or to re-check your hardware summary. It takes no arguments — its main steps are a hardware summary and a checklist of runners (already-installed ones shown but not selectable). It needs a real terminal; running it with no TTY attached fails immediately instead of hanging.

02 / 06

Options

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

  • --json—Default: off

    Accepted as a global flag, but setup has no JSON output mode; omm prints a warning and ignores it.

  • --yes, -y—Default: off

    Accepted as a global flag, but setup has no confirmation prompt to skip; omm prints a warning and ignores it.

  • --quiet, -q—Default: off

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

  • --no-color—Default: off

    Disable colored terminal output.

  • --help—Default: off

    Print setup's usage and options, then exit.

03 / 06

Examples

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

The full wizard: hardware summary followed by the runner checklist.

$ omm setup

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

$ omm setup --quiet

Plain-text output without terminal colors — useful for limited terminals and logs.

$ omm setup --no-color

04 / 06

Recorded CLI run

Command recorded in this video

omm setup --no-color

exit code: 1 · outcome: cancelled

Cancelled by the recorded keyboard input before any install, model run, benchmark, or upload.

Open the exact real-process transcript (.txt)

Extended documented terminal example

Real omm setup capture, 2026-08-24, this dev machine — the banner and hardware table print via console.print and are captured verbatim. The runner checklist that follows is drawn directly to the terminal by questionary (the same reason recommend's picker rows never appear in plain captured output), so it isn't reproduced here.

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:220-225
  2. AnythingLLM isn't auto-installable yet. Install it yourself, then re-run `omm setup` or `omm link`. See https://github.com/omm-hippo/omm/wiki/Compatible-Programs
    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:257-262
  3. Only 3.2 GB is free on the drive holding omm's home. Models and runners install there - set OMM_HOME to a roomier drive (e.g. `OMM_HOME=D:\omm`, see README) before installing anything.
    why
    The drive that holds OMM_HOME has less than 10 GB free, which is too tight for installing typical model files and runners safely.
    what to do
    Free space there or point OMM_HOME at a roomier drive before installing anything.
    source
    src/omm/onboarding.py:86-91

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