Manual Page Search Parameters
NIMBUS(1) General Commands Manual NIMBUS(1)

nimbus — a Nim build system

nimbus [--debug] [--binDir:path] [--nimbleDir:path] [--nim:path] [--nimcache:path] [--url:url] [nim opts...] sourceDir [buildDir]

The nimbus meta-build system generates files for the Ninja build system from Nimble projects.

The arguments are as follows:

sourceDir
Source directory, location where package's file is placed.
buildDir
Build directory, location where all generated files should be placed. If this argument is omitted, the current directory is used instead.

Note that the build directory must be different from the source directory. nimbus does not support building inside the source directory and attempting to do that leads to an error.

:path
Set the executable directory, where project's binaries will be installed.
Show debugging information.
:path
Set the Nimble directory, where project's sources will be installed.
:path
Set the Nim executable.
:path
Set the Nim cache base directory. Caches for individual targets will be created there.
:url
If this options is set, nimbus will generate and install a nimblemeta.json file. Some packages specify their dependencies using URLs and nimbus is unable to find them unless such metadata file exists.

All unrecognized flags are passed to the Nim compiler.

nimbus will create a ninja target for each task defined in the .nimble file.

If no tasks named "test" exist, nimbus generates a tester script that can be invoked via ‘ninja test’. It will compile and run all Nim files in the tests directory beginning with "t" in their filename.

This behavior is compatible with nimble.

nimbus generates an installer script that can be invoked via ‘ninja install’. It installs both sources and binaries (if any).

If any of the installDirs, installFiles, installExt variables are present in the .nimble file, nimbus operates in the whitelist mode. Please refer the to the nimble documentation for more information.

A variable prepended to each installed target file.

The nimbus meta-build system generates the following files:

build.ninja
Build file for a ninja-compatible build system.
installer.nims
Script for installing packages.
nimblemeta.json
Metadata file that contains package URL.
querytool.nims
Script for extracting metadata from .nimble files.
tester.nims
Script for running Nimble-style tests.

The nimbus utility exits 0 on success, and >0 if an error occurs.

Build and install a project:

mkdir build
cd build
nimbus ..
ninja
sudo ninja install

txt2deps(1)


Anna <cyber@sysrq.in>
Nimble Authors

July 2, 2022 .