CLI Reference

An overview of the Plash CLI commands

plash_login

plash_login --help

usage: plash_login [-h]

Authenticate CLI with server and save config

options:
  -h, --help  show this help message and exit

plash_apps

plash_apps --help

usage: plash_apps [-h] [--verbose]

List your deployed apps (verbose shows status table: 1=running, 0=stopped)

options:
  -h, --help  show this help message and exit
  --verbose   (default: False)

plash_deploy

plash_deploy --help

usage: plash_deploy [-h] [--path PATH] [--name NAME] [--force_data]

Deploy app to production, ignores paths starting with '.', excludes data/ directory by default unless --force_data is
used.

options:
  -h, --help    show this help message and exit
  --path PATH   Path to project (default: .)
  --name NAME   Overrides the .plash file in project root if provided
  --force_data  Overwrite data/ directory during deployment (default: False)

Use –force_data carefully

The --force_data flag will completely replace your production data. Always backup before using on production applications.

plash_view

plash_view --help

usage: plash_view [-h] [--path PATH] [--name NAME]

Open your app in the browser

options:
  -h, --help   show this help message and exit
  --path PATH  Path to project directory (default: .)
  --name NAME  Overrides the .plash file in project root if provided

plash_start

plash_start --help

usage: plash_start [-h] [--path PATH] [--name NAME]

Access the '/start' endpoint for your app

options:
  -h, --help   show this help message and exit
  --path PATH  Path to project (default: .)
  --name NAME  Overrides the .plash file in project root if provided

plash_stop

plash_stop --help

usage: plash_stop [-h] [--path PATH] [--name NAME]

Access the '/stop' endpoint for your app

options:
  -h, --help   show this help message and exit
  --path PATH  Path to project (default: .)
  --name NAME  Overrides the .plash file in project root if provided

plash_logs

plash_logs --help

usage: plash_logs [-h] [--path PATH] [--name NAME] [--mode {build,app}] [--tail]

Prints the logs for your deployed app

options:
  -h, --help          show this help message and exit
  --path PATH         Path to project (default: .)
  --name NAME         Overrides the .plash file in project root if provided
  --mode {build,app}  Choose between build or app logs (default: build)
  --tail              Tail the logs (default: False)

plash_download

plash_download --help

usage: plash_download [-h] [--path PATH] [--name NAME] [--save_path SAVE_PATH]

Download your deployed app

options:
  -h, --help             show this help message and exit
  --path PATH            Path to project (default: .)
  --name NAME            Overrides the .plash file in project root if provided
  --save_path SAVE_PATH  Save path (optional) (default: download)

plash_delete

plash_delete --help

usage: plash_delete [-h] [--path PATH] [--name NAME] [--force]

Delete your deployed app

options:
  -h, --help   show this help message and exit
  --path PATH  Path to project (default: .)
  --name NAME  Overrides the .plash file in project root if provided
  --force      Skip confirmation prompt (default: False)