@promptly/cli

promptly

• promptly
• Usage
• Commands

Usage

$ npm install -g @promptly/cli
$ promptly COMMAND
running command...
$ promptly (-v|--version|version)
@promptly/cli/1.0.0-beta.3 darwin-x64 node-v10.15.0
$ promptly --help [COMMAND]
USAGE
  $ promptly COMMAND
...

Commands

• promptly configmaps [NAME]
• promptly configmap:set NAME KEY=VALUE...
• promptly configmaps:set NAME KEY...
• promptly context
• promptly deploy
• promptly help [COMMAND]
• promptly init
• promptly logs
• promptly pods
• promptly secrets:get NAME KEY...
• promptly secrets [NAME]
• promptly secret:set NAME KEY=VALUE...
• promptly secrets:set NAME KEY...
• promptly shell [POD]
• promptly show

promptly configmaps [NAME]

list configmaps

USAGE
  $ promptly configmaps [NAME]

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

See code: lib/commands/configmaps/index.js

promptly configmap:set NAME KEY=VALUE...

set a configmap value

USAGE
  $ promptly configmap:set NAME KEY=VALUE...

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

EXAMPLES
  $ promptly configmap:set web RAILS_ENV=production

See code: lib/commands/configmaps/set.js

promptly configmaps:set NAME KEY...

remove a configmap value

USAGE
  $ promptly configmaps:set NAME KEY...

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

EXAMPLES
  $ promptly configmaps:unset web RAILS_ENV

See code: lib/commands/configmaps/unset.js

promptly context

switch kubernetes contexts

USAGE
  $ promptly context

OPTIONS
  -h, --help               show CLI help
  --force
  --kubeconfig=kubeconfig  path to a kubeconfig file

See code: lib/commands/context.js

promptly deploy

deploy your app

USAGE
  $ promptly deploy

OPTIONS
  -f, --file=file            path to a deployment plan
  -h, --help                 show CLI help
  -n, --namespace=namespace  the kubernetes namespace to use
  -s, --stage=stage          the function in your plan to run
  --context=context          the kubernetes context to use
  --kubeconfig=kubeconfig    path to a kubeconfig file
  --minikube                 optimize for minikube development
  --watch                    redeploy when files change

See code: lib/commands/deploy.js

promptly help [COMMAND]

display help for promptly

USAGE
  $ promptly help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

promptly init

create a new project

USAGE
  $ promptly init

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

See code: lib/commands/init.js

promptly logs

show logs

USAGE
  $ promptly logs

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|basic|json  (required) [default: pretty] output format
  --containers=containers         [default: .*] A regular expression of container names
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file
  --pods=pods                     [default: .*] A regular expression of pod names

See code: lib/commands/logs.js

promptly pods

show running pods

USAGE
  $ promptly pods

OPTIONS
  -h, --help  show CLI help

See code: lib/commands/pods.js

promptly secrets:get NAME KEY...

restart deployments

USAGE
  $ promptly secrets:get NAME KEY...

OPTIONS
  -h, --help                 show CLI help
  -n, --namespace=namespace  the kubernetes namespace to use
  --context=context          the kubernetes context to use
  --kubeconfig=kubeconfig    path to a kubeconfig file

See code: lib/commands/restart.js

promptly secrets [NAME]

list secrets

USAGE
  $ promptly secrets [NAME]

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

See code: lib/commands/secrets/index.js

promptly secret:set NAME KEY=VALUE...

set a secret value

USAGE
  $ promptly secret:set NAME KEY=VALUE...

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

EXAMPLES
  $ promptly secret:set web RAILS_ENV=production

See code: lib/commands/secrets/set.js

promptly secrets:set NAME KEY...

remove a secret value

USAGE
  $ promptly secrets:set NAME KEY...

OPTIONS
  -h, --help                      show CLI help
  -n, --namespace=namespace       the kubernetes namespace to use
  -o, --output=pretty|shell|json  (required) [default: pretty] output format
  --context=context               the kubernetes context to use
  --kubeconfig=kubeconfig         path to a kubeconfig file

EXAMPLES
  $ promptly secrets:unset web RAILS_ENV

See code: lib/commands/secrets/unset.js

promptly shell [POD]

connect to a running container

USAGE
  $ promptly shell [POD]

OPTIONS
  -c, --container=container  container name
  -h, --help                 show CLI help
  -n, --namespace=namespace  the kubernetes namespace to use
  --context=context          the kubernetes context to use
  --kubeconfig=kubeconfig    path to a kubeconfig file

See code: lib/commands/shell.js

promptly show

show objects

USAGE
  $ promptly show

OPTIONS
  -f, --file=file            path to a deployment plan
  -h, --help                 show CLI help
  -n, --namespace=namespace  the kubernetes namespace to use
  -s, --stage=stage          the function in your plan to run
  --context=context          the kubernetes context to use
  --kubeconfig=kubeconfig    path to a kubeconfig file

See code: lib/commands/show.js