Installation

Installation with NPM

Installation via a Standalone binary

Usage

$npm install -g platformer-cli$platformer COMMANDrunning command...$platformer (-v|--version|version)platformer-cli/0.1.10 linux-x64 node-v14.15.1$platformer --help [COMMAND]USAGE  $ platformer COMMAND...

Commands

platformer apply FILEPATH

USAGE  $ platformer apply FILEPATHARGUMENTS  FILEPATH  Path to YAML fileOPTIONS  -A, --all                        Log out of all contexts  -E, --environment=environment    [default: do-development] Environment Name  -O, --organization=organization  [default: Platformer Developer Portal] Organization Name  -P, --project=project            [default: Temp Production] Project Name  -T, --target-ns=target-ns        Target namespace  -h, --help                       show CLI help  --save

platformer cluster:connect [CLUSTER]

USAGE  $ platformer cluster:connect [CLUSTER]ARGUMENTS  CLUSTER  (OPTIONAL) Name of the Kubernetes Cluster to connect to the Platformer Console (must be a cluster name in           your kubeconfig). If not provided, the CLI will enter an interactive mode to select a Cluster.OPTIONS  -O, --organization=organization  [default: Platformer Developer Portal] Organization Name  -P, --project=project            [default: Temp Production] Project Name  -h, --help                       show CLI helpEXAMPLES  $ platformer connect:cluster  $ platformer connect:cluster <cluster-name as listed in your kubeconfig>  $ platformer connect:cluster --organization <organization> --project <project> # override context defaults

platformer cluster:list

USAGE  $ platformer cluster:listOPTIONS  -O, --organization=organization  [default: Platformer Developer Portal] Organization Name  -P, --project=project            [default: Temp Production] Project Name  -h, --help                       show CLI help  -x, --extended                   show extra columns  --columns=columns                only show provided columns (comma-seperated)  --csv                            output is csv format  --filter=filter                  filter property by partial string matching, ex: name=default  --no-header                      hide table header from output  --no-truncate                    do not truncate output to fit screen

platformer context:add NAME

USAGE  $ platformer context:add NAMEARGUMENTS  NAME  Context name (must be unique)OPTIONS  -h, --help  show CLI help

platformer context:list

USAGE  $ platformer context:listOPTIONS  -h, --help         show CLI help  -x, --extended     show extra columns  --columns=columns  only show provided columns (comma-seperated)  --csv              output is csv format  --filter=filter    filter property by partial string matching, ex: name=default  --no-header        hide table header from output  --no-truncate      do not truncate output to fit screen

platformer context:remove NAME

USAGE  $ platformer context:remove NAMEARGUMENTS  NAME  Context name to removeOPTIONS  -h, --help  show CLI help

platformer help [COMMAND]

USAGE  $ platformer help [COMMAND]ARGUMENTS  COMMAND  command to show help forOPTIONS  --all  see all commands in CLI

platformer import

USAGE  $ platformer importOPTIONS  -A, --all                        Log out of all contexts  -C, --cluster=cluster            (required) Cluster Name  -E, --environment=environment    [default: do-development] Environment Name  -N, --namespace=namespace        (required) Namspace  -O, --organization=organization  [default: Platformer Developer Portal] Organization Name  -P, --project=project            [default: Temp Production] Project Name  -T, --target-ns=target-ns        Target namespace  -h, --help                       show CLI help  --save

platformer login

USAGE  $ platformer login

platformer logout

USAGE  $ platformer logoutOPTIONS  -A, --all                          Log out of all contexts  -h, --help                         show CLI help  --context=default|devx|devc|devx2  [default: devx2] Name of a specific context to log out from (defaults to current                                     context)

platformer select:cxt [NAME]

USAGE  $ platformer select:cxt [NAME]ARGUMENTS  NAME  (OPTIONAL) Context name. If not provided, the CLI will prompt an interactive selectionOPTIONS  -h, --help  show CLI helpALIASES  $ platformer select:context  $ platformer select:ctx

platformer select:env [ENVIRONMENT]

USAGE  $ platformer select:env [ENVIRONMENT]ARGUMENTS  ENVIRONMENT  (OPTIONAL) Name of the Environment to set in the current context. If not provided, the CLI will open an               interactive prompt to select an Environment.OPTIONS  -O, --organization=organization  [default: Platformer Developer Portal] Organization Name  -P, --project=project            [default: Temp Production] Project Name  -h, --help                       show CLI helpALIASES  $ platformer select:environment  $ platformer select:envEXAMPLES  $ platformer select:environment # interactive select  $ platformer select:env <environment-name>

platformer select:org [ORGANIZATION]

USAGE  $ platformer select:org [ORGANIZATION]ARGUMENTS  ORGANIZATION  (OPTIONAL) Name of the Organization to set in the current context. If not provided, the CLI will open an                interactive prompt to select an Organization.OPTIONS  -h, --help  show CLI helpALIASES  $ platformer select:organization  $ platformer select:org  $ platformer select:organisationEXAMPLES  $ platformer select:org # interactive select  $ platformer select:org <organization-name>

platformer select:proj [PROJECT]

USAGE  $ platformer select:proj [PROJECT]ARGUMENTS  PROJECT  (OPTIONAL) Name of the Project to set in the current context. If not provided, the CLI will open an           interactive prompt to select an Project.OPTIONS  -O, --organization=organization  [default: Platformer Developer Portal] organization name  -h, --help                       show CLI helpALIASES  $ platformer select:project  $ platformer select:projEXAMPLES  $ platformer select:project # interactive select  $ platformer select:project <project-name>