NIMBLE(1) User Commands NIMBLE(1)

nimble - Nim Package Installer

nimble [nimbleopts] COMMAND [cmdopts]

[pkgname, ...] Installs a list of packages. [-d, --depsOnly] Only install dependencies. Leave out pkgname
to install deps for a local nimble package.
[-p, --passNim]
Forward specified flag to compiler.
[--noRebuild ]
Don't rebuild binaries if they're up-to-date.
[pkgname, ...] Clones a list of packages for development.
to `nimble.develop` if not specified and executed in package's directory.
[--withDependencies]
Puts in develop mode also the dependencies of the packages in the list or of the current directory package if the list is empty.
[-p, --path path]
Specifies the path whether the packages should be cloned.
[-a, --add path]
Adds a package at given path to a specified develop file or to `nimble.develop` if not specified and executed in package's directory.
[-r, --removePath path]
Removes a package at given path from a specified develop file or from `nimble.develop` if not specified and executed in package's directory.
[-n, --removeName name]
Removes a package with a given name from a specified develop file or from `nimble.develop` if not specified and executed in 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 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 package's directory.
[-g, --global]
Creates an old style link file in the special `links` directory. It is read by Nim to be able to use global develop mode packages. Nimble uses it as a global develop file if a local one does not exist.
Verifies the validity of a package in the current working directory.
[pkgname] Initializes a new Nimble project in the
new directory of the same name.
[--git, --hg]
Creates a git/hg repo in the new nimble project.
Publishes a package on nim-lang/packages. The current working directory needs to be the top level directory of the Nimble package.
[pkgname, ...] Uninstalls a list of packages. [-i, --inclDeps] Uninstalls package and dependent package(s).
[opts, ...] [bin] Builds a package. Passes options to the Nim
compiler.
Clean build artifacts.
Open the Nimble User Guide in your preferred browser.
Adds packages to your project's dependencies.
[opts, ...] [bin] Builds and runs a package.
compilation options if there are several binaries defined. Any flags after the binary or -- arg are passed to the binary when it is run.
[opts, ...] f.nim Builds a file inside a package. Passes options
to the Nim compiler.
Compiles and executes tests.
[-c, --continue]
Don't stop execution on a failed test.
[opts, ...]
Passes options to the Nim compiler.
[opts, ...] f.nim Builds documentation for a file inside a
package. Passes options to the Nim compiler.
[url] Refreshes the package list. A package list URL
can be optionally specified.
pkg/tag Searches for a specified package. Search is
performed by tag and by name.
[--ver, --version] Queries remote server for package version.
Lists all packages.
[-i, --installed]
Lists all installed packages.
[--ver, --version] Also display versions for packages. [-n, --nimbinaries] Lists all installed packages.
Lists the tasks specified in the Nimble package's Nimble file.
pkgname ... Shows absolute path to the installed packages
specified.
[pkgname] Outputs Nimble package information for
.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.
Generates or updates a package lock file.
[pkgname, ...] Upgrades a list of packages in the lock file.
Outputs dependencies for current package.
[--tree]
Outputs dependency tree.
[--inverted]
Outputs inverted (reversed) dependency tree.
[--format type]
Specify the output format. Json is the only supported format. Only some commands support it.
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.
Creates `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.
Creates a new shell with PATH modified to contain the bin folders of the dependencies.
Similar to shell command but it returns the script to run in order to alter the environment. This is intended to be used in scripts.

Print this help message.
Print version information.
Accept all interactive prompts.
Reject all interactive prompts.
Run in project local dependency mode.
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.
Enable downloading of packages as tarballs when working with GitHub repositories.
Query remote server for package version information when searching or listing packages.
Set the Nimble directory.
Use specified path for Nim compiler.
Hide all Nimble and Nim output.
Show some informative output.
Show extra non-debugging output.
Show all output including debug messages.
Don't use network.
Don't colorise output.
Don't check SSL certificates.
Override the lock file name.
Ignore the lock file if present.
Specifies the name of the develop file which to be manipulated. If not present creates it.
Use system nim and ignore nim from the lock file if any.
Use the SAT solver (default) or the legacy for dependency resolution.
Add extra packages to the dependency resolution. Uses the same syntax as the Nimble file. Example: nimble install --requires "pkg1; pkg2 >= 1.2".
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 compile the Nim version once and reuse it.
Maximum number of tags to check for a package when discovering versions for the SAT solver. 0 means all.
Use the declarative parser or the nimvm parser (default).
Activate features. Only used when using the declarative parser.
Ignore submodules when cloning a repository.
Use the legacy code path (pre nimble 1.0.0)

https://github.com/nim-lang/nimble#readme
February 2026 nimble 2.2.8