README.md

@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.0.16 linux-x64 node-v12.13.1
$ nitric --help [COMMAND]
USAGE
  $ nitric COMMAND
...

Commands

• nitric build [DIRECTORY]
• nitric create [NAME]
• nitric help [COMMAND]
• nitric make:function [TEMPLATE] [NAME]
• nitric make:project NAME
• nitric plugins
• nitric plugins:install PLUGIN...
• nitric plugins:link PLUGIN
• nitric plugins:uninstall PLUGIN...
• nitric plugins:update
• nitric run [DIRECTORY]

nitric build [DIRECTORY]

Builds a project

USAGE
  $ nitric build [DIRECTORY]

OPTIONS
  -h, --help                      show CLI help
  -p, --provider=(local|gcp|aws)
  --file=file

EXAMPLE
  $ nitric build .

See code: src/commands/build.ts

nitric create [NAME]

Creates a new project

USAGE
  $ nitric create [NAME]

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ nitric create my-project

See code: src/commands/create.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:function [TEMPLATE] [NAME]

Builds a nitric function

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

ARGUMENTS
  TEMPLATE  Function template
  NAME      Function name

OPTIONS
  -d, --directory=directory  directory where the new function should be made
  -f, --file=file            nitric project YAML file
  -h, --help                 show CLI help

EXAMPLE
  $ nitric make:function .

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

nitric make:project NAME

Creates a new Nitric project

USAGE
  $ nitric make:project NAME

ARGUMENTS
  NAME  the name of the new project to create

OPTIONS
  -h, --help  show CLI help
  --force

EXAMPLE
  $ nitric make:function .

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

nitric plugins

list installed plugins

USAGE
  $ nitric plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ nitric plugins

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

USAGE
  $ nitric run [DIRECTORY]

OPTIONS
  -h, --help                      show CLI help
  -p, --provider=(local|gcp|aws)
  --file=file
  --portStart=portStart

EXAMPLE
  $ nitric run .

See code: src/commands/run.ts