@nitric/cli

CLI tool for nitric applications

• @nitric/cli
• Usage
• Commands

Usage

$ npm install -g @nitric/cli
$ nitric COMMAND
running command...
$ nitric (-v|--version|version)
@nitric/cli/0.1.0 linux-x64 node-v14.18.1
$ nitric --help [COMMAND]
USAGE
  $ nitric COMMAND
...

Commands

• nitric build [DIRECTORY]
• nitric doctor
• nitric help [COMMAND]
• nitric make:stack [NAME] [TEMPLATE]
• nitric plugins
• nitric plugins:inspect PLUGIN...
• nitric plugins:install PLUGIN...
• nitric plugins:link PLUGIN
• nitric plugins:uninstall PLUGIN...
• nitric plugins:update
• nitric run [DIRECTORY]

nitric build [DIRECTORY]

build a project

USAGE
  $ nitric build [DIRECTORY]

ARGUMENTS
  DIRECTORY  The project directory to build from

OPTIONS
  -h, --help                    show CLI help
  -p, --provider=(dev|gcp|aws)  the targeted provider for this build
  --ci
  --file=file                   the stack definition file (default: ./nitric.yaml)

EXAMPLE
  $ nitric build .

See code: src/commands/build.ts

nitric doctor

check environment for config and prerequisite software

USAGE
  $ nitric doctor

OPTIONS
  -h, --help  show CLI help
  --ci

EXAMPLE
  $ nitric doctor

See code: src/commands/doctor.ts

nitric help [COMMAND]

display help for nitric

USAGE
  $ nitric help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

nitric make:stack [NAME] [TEMPLATE]

Creates a new Nitric stack

USAGE
  $ nitric make:stack [NAME] [TEMPLATE]

ARGUMENTS
  NAME      the name of the new stack to create
  TEMPLATE  Stack template

OPTIONS
  -f, --force  force the stack to be created, even in a folder with existing contents.
  -h, --help   show CLI help
  --ci

EXAMPLE
  $ nitric make:stack

See code: src/commands/make/stack.ts

nitric plugins

list installed plugins

USAGE
  $ nitric plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ nitric plugins

See code: @oclif/plugin-plugins

nitric plugins:inspect PLUGIN...

displays installation properties of a plugin

USAGE
  $ nitric plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] plugin to inspect

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

EXAMPLE
  $ nitric plugins:inspect myplugin

See code: @oclif/plugin-plugins

nitric plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ nitric plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ nitric plugins:add

EXAMPLES
  $ nitric plugins:install myplugin 
  $ nitric plugins:install https://github.com/someuser/someplugin
  $ nitric plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

nitric plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ nitric plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ nitric plugins:link myplugin

See code: @oclif/plugin-plugins

nitric plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ nitric plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ nitric plugins:unlink
  $ nitric plugins:remove

See code: @oclif/plugin-plugins

nitric plugins:update

update installed plugins

USAGE
  $ nitric plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins

nitric run [DIRECTORY]

builds and runs a project locally for testing

USAGE
  $ nitric run [DIRECTORY]

ARGUMENTS
  DIRECTORY  The project directory to build from

OPTIONS
  -h, --help                    show CLI help
  -p, --provider=(dev|gcp|aws)  the targeted provider for this build
  --ci
  --file=file                   the stack definition file (default: ./nitric.yaml)

EXAMPLE
  $ nitric run

See code: src/commands/run.ts