v0.11.0

CLI Reference

Last updated


This page lists every podrun command and flag.

Syntax


  1. podrun <command> [flags] [args...]

On startup the CLI checks and installs dependencies, checks environment variables, parses arguments, and tests the SSH connection; any failure aborts.

Commands


CommandDescription
upSync, rewrite compose, clear old containers and start, report the deployment
cleardown -v, down --rmi all, then delete the remote project folder via podman run --privileged alpine
downForward as remote podman compose down and mark the deployment as removed
psForward as podman compose ps
logsForward as podman compose logs; -f means follow
restartForward as podman compose restart
execForward as podman compose exec
buildForward as podman compose build
domain / deploy / export / info / clone[Unfinished] See Implementation Status

Any other command returns unsupported command.

Flags


FlagDescription
-d, --detachRun in the background; also forwarded to podman compose
--folder=<path>, --folder <path>Local project folder; defaults to the current directory
./<dir>, /<dir>Positional local project folder (must exist)
-f <file>Compose file; only the file name is forwarded. Means follow under logs. Multiple -f flags are not supported
-u <uid>, -u=<uid>Override the deployment UID
--output=<dir>, --output <dir>, -o <dir>Consumed by the parser and not forwarded; the remote folder is always derived from the local path (see Core Concepts)
--type=<target>, --type <target>[Unfinished] Runtime target; defaults to podman. k3s is only stored in the record's target field and still runs through Podman Compose

Unrecognized arguments are added to the forwarded list and passed to podman compose as-is.

Examples


  1. podrun up -d
  2. podrun up -d --folder=/path/to/project
  3. podrun up -d -f ./services/api/docker-compose.yml
  4. podrun logs -f
  5. podrun exec web sh
  6. podrun clear
中文