omm scan
Print a summary of this machine's hardware, which local AI runners it detects, and every model omm knows about.
01 / 07
Overview
Reach for scan any time you want a snapshot of what this machine can run and what's already on it. The report itself is observational, but scan may correct stale link records when a runner has been removed; it also nudges you toward omm link or omm import when it notices something those would fix.
02 / 07
Options
Every flag this command accepts, and what it defaults to when you leave it out.
--json—Default: offPrint the same report as structured JSON instead of tables.
03 / 07
Examples
From a plain search to something you'd put in a script.
The full hardware, runner, and model report.
$ omm scanMachine-readable — the same fields, as JSON.
$ omm scan --jsonSkip the two hint lines at the end, if any would otherwise print.
$ omm scan --quiet04 / 07
A real run
Real omm scan capture, 2026-08-24, this dev machine.
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.
Some omm-hub models aren't linked into an installed engine yet. Run: omm link- why
- A model in the omm hub exists but isn't symlinked into a runner that's now installed on this machine — usually because the runner was installed after the model was.
- what to do
- Run omm link to repair every model's links in one pass.
- source
- src/omm/cli.py:1059-1064
Found model file(s) outside the omm hub. Run: omm import- why
- scan found .gguf files sitting in a runner's own model directory that were never installed through omm, so it doesn't manage or dedupe them yet.
- what to do
- Run omm import to adopt them into the hub, or ignore the note if you'd rather manage them yourself.
- source
- src/omm/cli.py:1065-1069
Still stuck? Open an issue with the exact message you saw.
07 / 07
CLI reference
Exactly what omm scan --help prints, exported from the CLI source.
Usage
omm scan [OPTIONS]Options
--detailsDefault: —Also show OS, CPU, and GPU identity.
Shared flags
Every omm command also accepts --json, --no-color, --quiet, -q, --yes, -y, so they are listed here once instead of on each command.
Exported from omm 0.3.101.
All commands
- omm searchFind a model across the curated catalog, HuggingFace and ModelScope.
- omm installDownload a model into the hub and link it into every installed runner.
- omm runChat with an installed model — in the terminal for Ollama, or by opening the app for GUI runners.
- omm recommendGet a model suggestion ranked for this machine's hardware, with an offer to install it.
- omm contributeBenchmark models in a loop, uploading telemetry to improve recommend for hardware like yours.
- omm setupRe-run the hardware scan and runner-install checklist, any time.
- omm tuneGet recommended context length, GPU offload, threads, and batch size for a model.
- omm fitSee whether a model fits this machine's free memory right now, installed or not.
- omm helpShow omm's own command summary, or the full reference with --all.
- omm importAdopt .gguf files sitting in other apps' model directories into the omm hub.
- omm uninstallRemove a model and clean up its symlinks and manifests. Alias: rm.
- omm listShow every model omm has installed and which runners each is linked into. Alias: ls.
- omm infoShow full detail — repo, version, size, links, run commands — for one installed model.
- omm upgradeRefresh installed models against their source — only re-downloads what's actually changed. Alias: up.
- omm linkRe-verify and repair every installed model's runner links, or link into a custom directory.
- omm cleanupClean up leftover partial downloads and broken runner symlinks in one pass — no flags needed.
- omm verifyProve that an installed model actually loads and generates text on this machine.
- omm benchmarkLocal quality and speed smoke evidence for one or more installed models.
- omm updateReinstall omm from the latest source and refresh its recommendation data.
- omm settingView or change omm's settings — telemetry, outbound data, theme, update channel, and more.
- omm doctorDiagnose the omm install and Ollama links, read-only — no flags needed.
- omm engine installInstall one local AI runner program directly, skipping the setup checklist.
- omm logRead the local run log: what omm ran, when, and whether it worked.
- README — UsageEvery omm command, one line each.