@stackmate/cli v0.1.4

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @stackmate/cli
$ stackmate COMMAND
running command...
$ stackmate (--version)
@stackmate/cli/0.1.4 linux-x64 node-v18.12.0
$ stackmate --help [COMMAND]
USAGE
  $ stackmate COMMAND
...

Commands

• stackmate copy STAGE TARGET
• stackmate help [COMMAND]
• stackmate init
• stackmate plugins
• stackmate plugins:install PLUGIN...
• stackmate plugins:inspect PLUGIN...
• stackmate plugins:install PLUGIN...
• stackmate plugins:link PLUGIN
• stackmate plugins:uninstall PLUGIN...
• stackmate plugins:uninstall PLUGIN...
• stackmate plugins:uninstall PLUGIN...
• stackmate plugins update
• stackmate synth STAGE OPERATION

stackmate copy STAGE TARGET

Copies a stage to anoyther.

USAGE
  $ stackmate copy [STAGE] [TARGET] [--full] [--skip <value>]

ARGUMENTS
  STAGE   The stage to synthesize
  TARGET  The target stage to copy

FLAGS
  --full          Copy the entire stage with its services, not just ad a copy statement
  --skip=<value>  The comma separated service names to skip (should exist in the source stage)

See code: dist/commands/copy.ts

stackmate help [COMMAND]

Display help for stackmate.

USAGE
  $ stackmate help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for stackmate.

See code: @oclif/plugin-help

stackmate init

Generates the stackmate configuration file.

USAGE
  $ stackmate init -w <value> [-n <value>] [-p <value>] [-r <value>] [--state <value>] [--secrets <value>]
    [-s <value>]

FLAGS
  -n, --name=<value>
  -p, --provider=<value>  [default: aws]
  -r, --region=<value>    [default: eu-central-1]
  -s, --stages=<value>    [default: production]
  -w, --services=<value>  (required)
  --secrets=<value>       [default: aws]
  --state=<value>         [default: aws]

See code: dist/commands/init.ts

stackmate plugins

List installed plugins.

USAGE
  $ stackmate plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ stackmate plugins

See code: @oclif/plugin-plugins

stackmate plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ stackmate plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  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
  $ stackmate plugins add

EXAMPLES
  $ stackmate plugins:install myplugin 

  $ stackmate plugins:install https://github.com/someuser/someplugin

  $ stackmate plugins:install someuser/someplugin

stackmate plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ stackmate plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ stackmate plugins:inspect myplugin

stackmate plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ stackmate plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  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
  $ stackmate plugins add

EXAMPLES
  $ stackmate plugins:install myplugin 

  $ stackmate plugins:install https://github.com/someuser/someplugin

  $ stackmate plugins:install someuser/someplugin

stackmate plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ stackmate plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  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.


EXAMPLES
  $ stackmate plugins:link myplugin

stackmate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ stackmate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ stackmate plugins unlink
  $ stackmate plugins remove

stackmate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ stackmate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ stackmate plugins unlink
  $ stackmate plugins remove

stackmate plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ stackmate plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ stackmate plugins unlink
  $ stackmate plugins remove

stackmate plugins update

Update installed plugins.

USAGE
  $ stackmate plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

stackmate synth STAGE OPERATION

Synthesizes the stack for a stage.

USAGE
  $ stackmate synth [STAGE] [OPERATION] [--output <value>]

ARGUMENTS
  STAGE      The stage to synthesize
  OPERATION  (deployment|destruction|setup) The operation to run

FLAGS
  --output=<value>  [default: .stackmate] The path to output the files (relative, by default: ".stackmate" inside the
                    current one)

See code: dist/commands/synth.ts