Skip to main content

Matano CLI reference

Commands

matano autocomplete [SHELL]

display autocomplete installation instructions

USAGE
$ matano autocomplete [SHELL] [-r]

ARGUMENTS
SHELL shell type

FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)

DESCRIPTION
display autocomplete installation instructions

EXAMPLES
$ matano autocomplete

$ matano autocomplete bash

$ matano autocomplete zsh

$ matano autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

matano deploy

Deploys matano.

USAGE
$ matano deploy [--debug] [-p <value>] [--user-directory <value>]

FLAGS
-p, --profile=<value> AWS Profile to use for credentials.
--debug View debug information.
--user-directory=<value> Matano user directory to use.

DESCRIPTION
Deploys matano.

EXAMPLES
$ matano deploy

$ matano deploy --profile prod

$ matano deploy --profile prod --user-directory matano-directory

See code: dist/commands/deploy.ts

matano diff

Shows differences in your Matano deployment.

USAGE
$ matano diff [--debug] [-p <value>] [--user-directory <value>]

FLAGS
-p, --profile=<value> AWS Profile to use for credentials.
--debug View debug information.
--user-directory=<value> Matano user directory to use.

DESCRIPTION
Shows differences in your Matano deployment.

EXAMPLES
$ matano diff

$ matano diff --profile prod

$ matano diff --profile prod --user-directory matano-directory

See code: dist/commands/diff.ts

matano generate:matano-dir DIRECTORY-NAME

Generates a sample Matano directory to get started.

USAGE
$ matano generate:matano-dir [DIRECTORY-NAME]

ARGUMENTS
DIRECTORY-NAME The name of the directory to create

DESCRIPTION
Generates a sample Matano directory to get started.

EXAMPLES
$ matano generate:matano-dir

See code: dist/commands/generate/matano-dir.ts

matano help [COMMAND]

Display help for matano.

USAGE
$ matano 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 matano.

See code: @oclif/plugin-help

matano info

Retrieves information about your Matano deployment in structured format.

USAGE
$ matano info [--debug] [-p <value>] [--user-directory <value>] [--output csv|json|yaml | | ]

FLAGS
-p, --profile=<value> AWS Profile to use for credentials.
--debug View debug information.
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--user-directory=<value> Matano user directory to use.

DESCRIPTION
Retrieves information about your Matano deployment in structured format.

EXAMPLES
$ matano info

$ matano info --profile prod

$ matano info --output json

See code: dist/commands/info.ts

matano init

Wizard to get started with Matano. Creates resources, initializes your account, and deploys Matano.

USAGE
$ matano init [--debug] [-p <value>]

FLAGS
-p, --profile=<value> AWS Profile to use for credentials.
--debug View debug information.

DESCRIPTION
Wizard to get started with Matano. Creates resources, initializes your account, and deploys Matano.

EXAMPLES
$ matano init

$ matano init --profile prod

See code: dist/commands/init.ts

matano refresh-context

Refreshes Matano context.

USAGE
$ matano refresh-context [--debug] [-p <value>] [-a <value>] [-r <value>] [--user-directory <value>]

FLAGS
-a, --account=<value> AWS Account to deploy to.
-p, --profile=<value> AWS Profile to use for credentials.
-r, --region=<value> AWS Region to deploy to.
--debug View debug information.
--user-directory=<value> Matano user directory to use.

DESCRIPTION
Refreshes Matano context.

EXAMPLES
$ matano refresh-context

$ matano refresh-context --profile prod

$ matano refresh-context --profile prod --user-directory my-matano-directory

$ matano refresh-context --profile prod --region eu-central-1 --account 12345678901

See code: dist/commands/refresh-context.ts