.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH NIMBLE "1" "March 2024" "nimble 1.6.14-1+b1" "User Commands"
.SH NAME
nimble \- Nim Package Installer
.SH SYNOPSIS
.B nimble
[\fI\,nimbleopts\/\fR] \fI\,COMMAND \/\fR[\fI\,cmdopts\/\fR]
.SH DESCRIPTION
.SS "Commands:"
.TP
install
[pkgname, ...]     Installs a list of packages.
[\-d, \fB\-\-depsOnly]\fR   Installs only dependencies of the package.
[opts, ...]        Passes options to the Nim compiler.
.TP
develop
[pkgname, ...]     Clones a list of packages for development.
.TP
Symlinks the cloned packages or any package
in the current working directory.
.TP
check
Verifies the validity of a package in the
current working directory.
.TP
init
[pkgname]          Initializes a new Nimble project in the
.TP
current directory or if a name is provided a
new directory of the same name.
.TP
[\-\-git, \fB\-\-hg]\fR
Creates a git/hg repo in the new nimble project.
.TP
publish
Publishes a package on nim\-lang/packages.
The current working directory needs to be the
toplevel directory of the Nimble package.
.TP
uninstall
[pkgname, ...]     Uninstalls a list of packages.
[\-i, \fB\-\-inclDeps]\fR   Uninstalls package and dependent package(s).
.TP
build
[opts, ...] [bin]  Builds a package. Passes options to the Nim
.IP
compiler.
.TP
run
[opts, ...] [bin]  Builds and runs a package.
.TP
Binary needs to be specified after any
compilation options if there are several
binaries defined. Any flags after the binary
or \fB\-\-\fR arg are passed to the binary when it is run.
.TP
c, cc, js
[opts, ...] f.nim  Builds a file inside a package. Passes options
.IP
to the Nim compiler.
.TP
test
Compiles and executes tests.
.TP
[\-c, \fB\-\-continue]\fR
Don't stop execution on a failed test.
.TP
[opts, ...]
Passes options to the Nim compiler.
.TP
doc, doc2
[opts, ...] f.nim  Builds documentation for a file inside a
.IP
package. Passes options to the Nim compiler.
.TP
refresh
[url]              Refreshes the package list. A package list URL
.IP
can be optionally specified.
.TP
search
pkg/tag            Searches for a specified package. Search is
.IP
performed by tag and by name.
.TP
[\-\-ver]
Queries remote server for package version.
.TP
list
Lists all packages.
.TP
[\-\-ver]
Queries remote server for package version.
.TP
[\-i, \fB\-\-installed]\fR
Lists all installed packages.
.TP
tasks
Lists the tasks specified in the Nimble
package's Nimble file.
.TP
path
pkgname ...        Shows absolute path to the installed packages
.IP
specified.
.TP
dump
[pkgname]          Outputs Nimble package information for
.TP
external tools. The argument can be a
\&.nimble file, a project directory or
the name of an installed package.
.TP
[\-\-ini, \fB\-\-json]\fR
Selects the output format (the default is \fB\-\-ini\fR).
.SS "Nimble Options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Print this help message.
.TP
\fB\-v\fR, \fB\-\-version\fR
Print version information.
.TP
\fB\-y\fR, \fB\-\-accept\fR
Accept all interactive prompts.
.TP
\fB\-n\fR, \fB\-\-reject\fR
Reject all interactive prompts.
.TP
\fB\-l\fR, \fB\-\-localdeps\fR
Run in project local dependency mode
.TP
\fB\-\-ver\fR
Query remote server for package version
information when searching or listing packages.
.TP
\fB\-\-nimbleDir\fR:dirname
Set the Nimble directory.
.TP
\fB\-\-nim\fR:path
Use specified path for Nim compiler
.TP
\fB\-\-silent\fR
Hide all Nimble and Nim output
.TP
\fB\-\-verbose\fR
Show all non\-debug output.
.TP
\fB\-\-debug\fR
Show all output including debug messages.
.TP
\fB\-\-noColor\fR
Don't colorise output.
.TP
\fB\-\-noSSLCheck\fR
Don't check SSL certificates.
.SS "For more information read the Github readme:"
.IP
https://github.com/nim\-lang/nimble#readme
.SH "REPORTING BUGS"
https://github.com/nim-lang/Nim/issues
.SH "SEE ALSO"
The nim-doc package.