Commands

Every command of hivepaas, from its own help: hivepaas <command> --help says the same.

Command	What it does
hivepaas api	Call any endpoint of the API, with the context's URL and key
hivepaas app	An environment's apps
hivepaas backup	An app's data backups: snapshots of its volumes, and what restores them
hivepaas completion	Generate the autocompletion script for the specified shell
hivepaas compose	Docker Compose files: their services as apps
hivepaas config-file	Config files: files HivePaaS keeps, mounted into apps' containers
hivepaas context	The installations the CLI is logged in to
hivepaas cp	Copy a file or a directory into an app's container, or out of it
hivepaas deploy	Deploy an app, and wait for the result while following its logs
hivepaas domain	An app's domains
hivepaas env	An app's environment variables
hivepaas exec	Open a shell in an app's container
hivepaas function	Functions: code HivePaaS runs on a runtime, a handler answering one request
hivepaas job	An app's scheduled jobs: list them, run one now, turn one on or off
hivepaas link	Tie this directory to an app, so commands run in it need no flags
hivepaas login	Log in to an installation with an API key
hivepaas logout	Forget the current context, or the one --context names, and its key's secret
hivepaas logs	Show an app's logs, a deployment's or a task's
hivepaas open	Open an app's address in the browser
hivepaas preview	An app's previews: copies of it for a branch or a pull request
hivepaas project	Projects and their environments
hivepaas ps	List an app's replicas: where each runs, its state, and why one failed
hivepaas restart	Restart an app
hivepaas secret	Secrets: values kept hidden, given to apps as ${secrets.KEY} or as files
hivepaas status	What needs attention on the installation: apps not running, nodes down
hivepaas task	An app's tasks: its jobs' runs, and what else runs in the background for it
hivepaas template	The template store
hivepaas unlink	Remove this directory's link
hivepaas update	Install a newer release of this CLI
hivepaas version	The CLI's version and API level, and the current installation's
hivepaas whoami	Who the key acts as, on which installation

Global flags

Every command takes these:

Flag	Description
-a, --app string	app, by name, key or id
--context string	the installation to use, instead of the current one
--debug	log each request to stderr
-e, --env string	environment, by name
--no-color	no colors
-o, --output string	table, json or yaml (default: table)
-p, --project string	project, by name, key or id