mfahampshire
a70e68c7bd
* Smolmix documentation * Add smolmix docs: landing page, tutorials, and developer page links * Add Exit Gateway services page (NR vs IPR) and link from existing docs * Update auto-generated command and API outputs * Reorg of tutorials and architecture pages * License information + remove TODO from docs.rs visibile comment + reorg readme * Add versions file for doc-wide versioning * Relative -> absolute links * Relative -> absolute links * Update license + add old tutorial code as examples * Streamline smolmix docs * Clippy * Clean up doc comments * Last pass * Add larger file download to list * set new versions * Clippy * Remove blake pin from docs + add version range to root Cargo.toml * Format example logging * Remove crate blocked component * Loose whitespace * Add doc verification script for inline mdx * Formatting * Components regen * Reorg + tighten text * Voicing cohesion pass + remove bloated examples * Voicing cont. * Reduce max download size * Small suggested clarifications * Max/docs voicing consistency (#6769) * Reduce max download size * voicing consistency across docs * New landing order w smolmix * Tweaks * Final tweaks
18 lines
864 B
Markdown
18 lines
864 B
Markdown
```sh
|
|
Usage: nym-api [OPTIONS] <COMMAND>
|
|
|
|
Commands:
|
|
init Initialise a Nym Api instance with persistent config.toml file
|
|
run Run the Nym Api with provided configuration optionally overriding set parameters
|
|
build-info Show build information of this binary
|
|
help Print this message or the help of the given subcommand(s)
|
|
|
|
Options:
|
|
-c, --config-env-file <CONFIG_ENV_FILE> Path pointing to an env file that configures the Nym API [env:
|
|
NYMAPI_CONFIG_ENV_FILE_ARG=]
|
|
--no-banner A no-op flag included for consistency with other binaries (and compatibility with
|
|
nymvisor, oops) [env: NYMAPI_NO_BANNER_ARG=]
|
|
-h, --help Print help
|
|
-V, --version Print version
|
|
```
|