omm install

01 / 07

Overview

Reach for install once search or list has given you a name, a repo reference, or a numeric index. install checks the model against this machine's predicted memory budget before downloading anything, links the finished file into every runner installed on this system, and prints the exact commands to run or uninstall it. A name that resolves to more than one quantization or more than one provider drops into an interactive picker instead of guessing.

02 / 07

Options

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

• <name>—Default: required

  A curated name, a numeric index from the last search or list run, an 'org/repo:file.gguf' reference (optionally prefixed hf: or ms:), or a direct URL.

• --skip-unfit—Default: off

  If this hardware is predicted not to run the model, skip it instead of asking. Exits 0 with skipped_unfit set — for scripting.

• --upload / --no-upload—Default: current upload policy

  Send (or skip sending) this machine's benchmark result to the telemetry server without asking. Left unset, the current omm setting upload policy decides.

• --force—Default: off

  Re-download even if this model is already installed.

• --verify-runtime / --no-verify-runtime—Default: asks first

  Run (or skip) a short local load/generation check after linking. Left unset, install asks before loading a model that isn't already running.

03 / 07

Examples

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

$ omm install mistral-7b-instruct-q4

$ omm install mistral-7b-instruct-q4 --skip-unfit

$ omm install 1

$ omm install mistral-7b-instruct-q4 --no-upload

$ omm install mistral-7b-instruct-q4 --force

04 / 07

A real run

$ 

05 / 07

Related commands

• omm searchFind the exact name, reference, or index to install.
• omm runJust installed something? run starts chatting with it.

06 / 07

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. Unknown model 'zzzz-totally-fake-model-name-xyz'. Use a curated name (tinyllama-1.1b-q4, llama3.1-8b-instruct-q4, mistral-7b-instruct-q4), an 'org/repo:file.gguf' ref (optionally prefixed 'hf:' or 'ms:'), or a direct URL.

   why

   This name doesn't match anything in the curated catalog, and it isn't a repo reference or URL install recognizes either.

   what to do

   Try omm search first to find the exact name or reference, or pass an 'org/repo:file.gguf' reference directly.

   source

   src/omm/hub.py:371

2. Not enough disk space: /Users/you/.omm/models needs up to 5.2 GiB (central model download) but only 3.1 GiB is free.

   why

   install checks free space before downloading — the central model file, plus whatever a runner needs to copy or link it, plus a safety margin.

   what to do

   Free up space on the reported volume, or point OMM_HOME at a roomier drive before installing.

   source

   src/omm/cli.py:3477-3488

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

07 / 07

CLI reference

omm install [OPTIONS] {model_name}