NIMBLE(1)

💅 NIMBLE(1) 💅

okay bestie, pull up a chair — this is the Nimble page from the User Commands manual, and it's honestly a lot, but we're getting through it together, no skips, no cap. 🫶 this is your girl's guide to the Nim Package Installer and she does. it. all.

---

✨ NAME ✨

nimble — the Nim Package Installer. that's the whole name section. she's concise, she's booked, she's iconic. 👑

---

🦋 SYNOPSIS 🦋

nimble [nimbleopts] COMMAND [cmdopts]

so it's nimble opts first, then the COMMAND, then that command's own opts. order girlies. 💫

---

🎀 DESCRIPTION 🎀

🧚 Commands 🧚

install

• [pkgname, ...] — installs a list of packages.
• -d, --depsOnly — only install dependencies. leave out pkgname and it installs deps for a local nimble package instead.
• -p, --passNim — forwards the flag you specify to the compiler.
• --noRebuild — don't rebuild binaries if they're already up-to-date. we love a lazy queen who respects her own time. 💅

develop

• [pkgname, ...] — clones a list of packages for development. adds them to a develop file if one is specified, or to nimble.develop if not specified and executed in the package's directory.
• --withDependencies — also puts the dependencies of the packages in the list into develop mode — or of the current directory package if the list is empty.
• -p, --path path — specifies the path where the packages should be cloned.
• -a, --add path — adds a package at the given path to a specified develop file, or to nimble.develop if not specified and executed in the package's directory.
• -r, --removePath path — removes a package at the given path from a specified develop file, or from nimble.develop if not specified and executed in the package's directory.
• -n, --removeName name — removes a package with the given name from a specified develop file, or from nimble.develop if not specified and executed in the package's directory.
• -i, --include file — includes a develop file into a specified develop file, or to nimble.develop if not specified and executed in the package's directory.
• -e, --exclude file — excludes a develop file from a specified develop file, or from nimble.develop if not specified and executed in the package's directory.

check

• verifies the validity of a package in the current working directory. vibe check, but for your package. ✅

init

• [pkgname] — initializes a new Nimble project in the current directory, or, if a name is provided, in a new directory of the same name.
  • --git, --hg — creates a git/hg repo in the new nimble project.

publish

• publishes a package on nim-lang/packages. the current working directory needs to be the top level directory of the Nimble package. main character moment only works from the top level, bestie. 👑

uninstall

• [pkgname, ...] — uninstalls a list of packages.
• -i, --inclDeps — uninstalls the package and its dependent package(s).

build

• [opts, ...] [bin] — builds a package. passes options to the Nim compiler.

clean

• clean build artifacts. the digital equivalent of clearing out your saved tiktoks. 🧹

guide

• opens the Nimble User Guide in your preferred browser. study session, babes. 📖

add

• adds packages to your project's dependencies.

run

• [opts, ...] [bin] — builds and runs a package. the binary needs to be specified after any compilation options if there are several binaries defined. any flags after the binary or after the -- arg are passed to the binary when it is run.

c, cc, js

• [opts, ...] f.nim — builds a file inside a package. passes options to the Nim compiler.

test

• compiles and executes tests.
• -c, --continue — don't stop execution on a failed test. keep going, we believe in you. 😭
• [opts, ...] — passes options to the Nim compiler.

doc, doc2

• [opts, ...] f.nim — builds documentation for a file inside a package. passes options to the Nim compiler.

refresh

• [url] — refreshes the package list. a package list URL can be optionally specified.

search

• pkg/tag — searches for a specified package. the search is performed by tag and by name.
• --ver, --version — queries the remote server for the package version.

list

• lists all packages.
• -i, --installed — lists all installed packages.
• --ver, --version — also display versions for packages.
• -n, --nimbinaries — lists all installed packages.

tasks

• lists the tasks specified in the Nimble package's Nimble file.

path

• pkgname ... — shows the absolute path to the installed packages specified.

dump

• [pkgname] — outputs Nimble package information for external tools. the argument can be a .nimble file, a project directory, or the name of an installed package.
• --ini, --json — selects the output format (the default is --ini). only applicable to package information.
• --collect — collects all the packages in the dependency tree of the given package and shows the result in the console.
• --solve — solves the dependency tree of the given package and shows the result in the console.

lock

• generates or updates a package lock file. 🔒

upgrade

• [pkgname, ...] — upgrades a list of packages in the lock file.

deps

• outputs dependencies for the current package.
• --tree — outputs the dependency tree.
• --inverted — outputs the inverted (reversed) dependency tree.
• --format type — specify the output format. json is the only supported format. only some commands support it.

sync

• synchronizes develop mode dependencies with the content of the lock file.
• -l, --listOnly — only lists the packages which are not synced, without actually performing the sync operation.

setup

• creates the nimble.paths file containing file system paths to the dependencies. also includes the paths file in the config.nims file to make them available for the compiler.

shell

• creates a new shell with PATH modified to contain the bin folders of the dependencies.

shellenv

• similar to the shell command, but it returns the script to run in order to alter the environment. this is intended to be used in scripts.

---

🌈 Nimble Options 🌈

• -h, --help — print this help message.
• -v, --version — print version information.
• -y, --accept — accept all interactive prompts. yes girl say yes. 💖
• -n, --reject — reject all interactive prompts.
• -l, --localdeps — run in project local dependency mode.
• -g, --global — run in global dependency mode.
• --resolver:minver|maxver — pick the lowest (minver) or newest (maxver, default) version satisfying each requirement.
• -p, --package — for which package in the dependency tree the command should be executed. if not provided, by default it applies to the current directory package. for now, it is used only by the run action and it is ignored by others.
• -t, --tarballs — enable downloading of packages as tarballs when working with GitHub repositories.
• --ver — query the remote server for package version information when searching or listing packages.
• --nimbleDir:dirname — set the Nimble directory.
• --nim:path — use the specified path for the Nim compiler.
• --silent — hide all Nimble and Nim output.
• --info — show some informative output.
• --verbose — show extra non-debugging output.
• --debug — show all output including debug messages.
• --offline — don't use network.
• --noColor — don't colorise output.
• --noSslCheck — don't check SSL certificates.
• --lockFile — override the lock file name.
• --noLockfile — ignore the lock file if present.
• --developFile — specifies the name of the develop file which is to be manipulated. if not present, creates it.
• --useSystemNim — use system nim and ignore nim from the lock file if any.
• --requires — add extra packages to the dependency resolution. uses the same syntax as the Nimble file. example: nimble install --requires "pkg1; pkg2 >= 1.2".
• --disableNimBinaries — disable the use of nim precompiled binaries. note: in some platforms precompiled binaries are not available, but the flag can still be used to avoid compiling the Nim version once and reusing it.
• --maximumTaggedVersions — maximum number of tags to check for a package when discovering versions for the SAT solver. 0 means all.
• --parser:declarative|nimvm — use the declarative parser or the nimvm parser (default).
• --features — activate features. only used when using the declarative parser.
• --ignoreSubmodules — ignore submodules when cloning a repository.
• --sync — disable parallel downloads and version discovery.

---

for more information read the GitHub readme: https://github.com/nim-lang/nimble#readme

ngl bestie, that was a lot of options, and we read every single one. not me being thorough. 💀

---

that's the whole page, you made it! 🎉 this was nimble 2.2.12, dated September 2026, and it's filed under NIMBLE(1) in the User Commands manual. go forth and install something iconic. 💜✨