10. Command line crash course
bin\nimby.exe shares the configuration with the GUI, so the two can be mixed freely. Run these in PowerShell from the bin folder, or add that folder to PATH; quote any path or URL containing spaces. Every command accepts --json.
nimby install
nimby install --mods "@cba_ws,@ace" --parallel 12 --mod-parallel 3
nimby install --optional "@jsrs_soundmod" --no-required
nimby install --progress json --on-error ask --control-stdin
nimby update --check
nimby update --check --deep
nimby repair
nimby verify "E:\Nimby\Community\@cba_ws"
nimby track --rebuild
nimby store info
nimby store prune
nimby stats --json
nimby status
nimby doctor
nimby launch --server "Example Public" --dry-runnimby config, nimby config set, nimby repo … and nimby migrate are shown in sections 3, 4 and 9; nimby inspect <url> --images prints a repository summary.
Flags worth knowing:
| Flag | Effect | |||
|---|---|---|---|---|
--mods LIST | Install these mods (comma separated, @name). | |||
--optional LIST | Install these optional mods. | |||
--no-required | Do not add the repository's required set behind your back. | |||
--parallel N | Concurrent file transfers per mod (1–32). | |||
--mod-parallel N | Mods installed at the same time (1–16). | |||
| `--on-error abort\ | retry\ | skip\ | ask` | What to do when a mod fails after the automatic retries; ask needs a control channel. |
--control-stdin | Read cancel, retry, skip, abort from stdin, one word per line. | |||
--progress json | One JSON event per line (resolving, plan, modStart, fileStart, fileProgress, file, modDone, retry, resumed, needsAction, skipped, cancelled, failed, done); cannot be combined with --json. | |||
--json | Print the final result as JSON. | |||
--no-workshop, --no-store | Ignore the Workshop cache or the store for this run. |
Exit codes: 0 success, 1 error, 3 cancelled (finished files kept), 4 finished with skipped mods. nimby verify and nimby publish exit with 2 when a folder does not match its manifest.