npm package: @promptly/cli
Description: [![Build](https://img.shields.io/circleci/token/1effe505a8378d0fe9755c30db6d9fc3aa036f4a/project/github/promptworks/promptly/dev.svg)](https://circleci.com/gh/promptworks/promptly) [![Version](https://img.shields.io/npm/v/promptly.svg)](https://npmjs.org/
Author: Ray Zane
Latest version: 1.0.0-beta.3

# promptly

[![Build](https://img.shields.io/circleci/token/1effe505a8378d0fe9755c30db6d9fc3aa036f4a/project/github/promptworks/promptly/dev.svg)](https://circleci.com/gh/promptworks/promptly)
[![Version](https://img.shields.io/npm/v/promptly.svg)](https://npmjs.org/package/promptly)
[![Downloads/week](https://img.shields.io/npm/dw/@promptly/cli.svg)](https://npmjs.org/package/@promptly/cli)
[![License](https://img.shields.io/npm/l/promptly.svg)](https://github.com/promptworks/promptly/blob/master/package.json)

<!-- toc -->
* [promptly](#promptly)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @promptly/cli
$ promptly COMMAND
running command...
$ promptly (-v|--version|version)
@promptly/cli/1.0.0-beta.2 darwin-x64 node-v10.15.0
$ promptly --help [COMMAND]
USAGE
  $ promptly COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`promptly configmaps [NAME]`](#promptly-configmaps-name)
* [`promptly configmap:set NAME KEY=VALUE...`](#promptly-configmapset-name-keyvalue)
* [`promptly configmaps:set NAME KEY...`](#promptly-configmapsset-name-key)
* [`promptly context`](#promptly-context)
* [`promptly deploy`](#promptly-deploy)
* [`promptly help [COMMAND]`](#promptly-help-command)
* [`promptly init`](#promptly-init)
* [`promptly logs`](#promptly-logs)
* [`promptly pods`](#promptly-pods)
* [`promptly secrets:get NAME KEY...`](#promptly-secretsget-name-key)
* [`promptly secrets [NAME]`](#promptly-secrets-name)
* [`promptly secret:set NAME KEY=VALUE...`](#promptly-secretset-name-keyvalue)
* [`promptly secrets:set NAME KEY...`](#promptly-secretsset-name-key)
* [`promptly shell [POD]`](#promptly-shell-pod)
* [`promptly show`](#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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/oclif/plugin-help/blob/v2.1.6/src/commands/help.ts)_

## `promptly init`

create a new project

```
USAGE
  $ promptly init

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

_See code: [lib/commands/init.js](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/lib/commands/logs.js)_

## `promptly pods`

show running pods

```
USAGE
  $ promptly pods

OPTIONS
  -h, --help  show CLI help
```

_See code: [lib/commands/pods.js](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/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](https://github.com/promptworks/promptly/blob/v1.0.0-beta.2/lib/commands/show.js)_
<!-- commandsstop -->