porter app - Porter

porter app contains commands for managing and interacting with your applications.

Prerequisites

You’ve logged in to the Porter CLI after running porter auth login
You’re connected to the correct project by running porter config set-project
You’re connected to the correct cluster by running porter config set-cluster

`porter app run`

Runs a command inside your application’s environment. By default, this spins up an ephemeral copy of your application that is deleted when the command completes. Usage:

porter app run [application] -- COMMAND [args...] [flags]

Options:

Flag	Description
`-e`	Connect to an existing replica instead of spinning up a new one (default: false). This will launch an interactive selector if there is more than one replica of your application running
`--job`	Name of the job to run (runs the job as defined and returns the job run ID without waiting)
`--wait`	Wait for the command to complete before exiting for non-interactive mode (default: false)
`--allow-concurrent`	Allow concurrent job runs when using `--job` (overrides job config if concurrency is disabled)
`--cpu`	CPU allocation in millicores (1000 millicores = 1 vCPU)
`--ram`	RAM allocation in Mi (1024 Mi = 1 GB)
`-v`	Print verbose output

The --cpu and --ram flags aren’t applicable when used with the -e flag as they require spinning up an ephemeral replica of your application.

porter app run my-app -- bash

porter app run my-app -e -- bash

porter app run my-app --job my-job

porter app run my-app --job my-job --wait

porter app run my-app --job my-job --allow-concurrent

porter app run my-app -- python manage.py migrate

porter app run my-app --cpu 500 --ram 512 -- python heavy_script.py

In these examples, we use bash and python, but those commands need to actually be present within the container to run. With very lightweight containers, you may find that none of these are available. If you run into trouble here, feel free to reach out to the support team.

`porter app run cleanup`

Delete any lingering ephemeral replicas that were created with porter app run. Usage:

porter app run cleanup

`porter app logs`

Streams the latest logs for an application. Usage:

porter app logs [application] [flags]

Options:

Flag	Description
`--service`	The name of the service to get logs for
`--search`	Search for a specific string in the logs
`--revision`	The revision number to get logs for (default: -1, no filter applied)

Historical Log Options:

Flag	Description
`--since`	Lookback period from the current time to get historical logs (e.g., `12h`, `30m`)
`--from`	Start time (UTC) for historical logs (format: `2021-01-01T00:00:00Z`)
`--to`	End time (UTC) for historical logs (format: `2021-01-01T00:00:00Z`)
`--limit`	Number of lines of historical logs to return
`--newest-first`	Return newest historical logs first (default: true)

porter app logs my-app

porter app logs my-app --service web

porter app logs my-app --search "error"

porter app logs my-app --since 12h

porter app logs my-app --from 2025-01-15T10:00:00Z --to 2025-01-15T12:00:00Z

porter app logs my-app --since 24h --limit 500

By default, the command streams new logs. Setting --since or --from/--to switches to pulling historical logs.

`porter app build`

Builds a new version of the specified app. Attempts to use any build settings previously configured for the app, which can be overridden with flags. Usage:

porter app build [application] [flags]

Options:

Flag	Description
`--build-context`	Set the build context for the app
`--dockerfile`	Set the path to the Dockerfile when build method is `docker`
`--tag`	Set the image tag to use for the build
`--build-method`	Set the build method for the app (`docker` or `pack`)
`--builder`	Set the builder to use when build method is `pack`
`--attach-buildpacks`	Attach buildpacks to use when build method is `pack`
`--no-pull`	Do not pull the previous image before building
`--remote`	[EXPERIMENTAL] Build remotely using kpack in the cluster instead of locally
`--verbose`	Show verbose output during build (detailed logs, step timings)

porter app build my-app

porter app build my-app --build-context ./frontend --dockerfile ./frontend/Dockerfile

porter app build my-app --tag v1.2.3

porter app build my-app --build-method pack --builder heroku/builder:22 --attach-buildpacks heroku/nodejs

`porter app push`

Pushes the specified app to your default Porter registry. If no tag is specified, the latest commit SHA from the current branch will be used as the tag. Usage:

porter app push [application] [flags]

Options:

Flag	Description
`--tag`	Set the image tag to use for the push

porter app push my-app

porter app push my-app --tag v1.2.3

`porter app create`

Creates and deploys a new app in your project. If no flags are specified, you will be directed to a series of required prompts to configure the app. Usage:

porter app create [flags]

Options:

Flag	Short	Description
`--name`	`-n`	The name of the app
`--file`	`-f`	Path to porter.yaml
`--deploy-method`	`-m`	The deployment method for the app (`docker`, `repo`)
`--tag`		Set the image tag used for the application (overrides field in yaml)
`--image-repository`		Set the image repository to use for the app
`--attach-env-groups`		Attach environment groups to the app
`--build-context`		Set the build context for the app
`--build-method`		Set the build method for the app (`docker` or `pack`)
`--dockerfile`		Set the path to the Dockerfile when build method is `docker`
`--builder`		Set the builder to use when build method is `pack`
`--attach-buildpacks`		Attach buildpacks to use when build method is `pack`
`--remote`		[EXPERIMENTAL] Build remotely using kpack in the cluster instead of locally
`--verbose`		Show verbose output during build

porter app create

porter app create --name example-app

porter app create --name my-app -f porter.yaml

`porter app update`

Updates the specified app with the provided configuration. This command differs from porter apply in that it only updates the app, but does not attempt to build a new image. Usage:

porter app update [application] [flags]

Options:

Flag	Short	Description
`--file`	`-f`	Path to porter.yaml
`--tag`		Set the image tag used for the application (overrides field in yaml)
`--image-repository`		Set the image repository to use for the app
`--attach-env-groups`		Attach environment groups to the app
`--wait`	`-w`	Wait until an update has rolled out successfully, otherwise time out

porter app update my-app -f porter.yaml

porter app update my-app --tag v1.2.3

porter app update my-app -f porter.yaml --wait

This command differs from porter apply in that it only updates the app configuration without attempting to build a new image.

`porter app update-tag`

Updates the image tag for an application. This is functionally equivalent to running porter apply or porter app update with the --tag flag. Usage:

porter app update-tag [application] [flags]

Options:

Flag	Short	Description
`--tag`	`-t`	The specified tag to use (default: `latest`)
`--wait`	`-w`	Wait and be notified when an update is successful, otherwise time out

porter app update-tag my-app --tag abc123def

porter app update-tag my-app --tag v1.2.3 --wait

`porter app yaml`

Export the current Porter YAML configuration for an application. Useful for bootstrapping a porter.yaml file or inspecting the current configuration. Usage:

porter app yaml [application] [flags]

Options:

Flag	Description
`--helm-overrides`	Return only the helm overrides for the application

porter app yaml my-app

porter app yaml my-app --helm-overrides

Redirect the output to create a porter.yaml file: porter app yaml my-app > porter.yaml

`porter app list`

Lists all applications in the project. Usage:

porter app list

`porter app manifests`

Prints the Kubernetes manifests for an application. Usage:

porter app manifests [application]

porter app manifests my-app

`porter app rollback`

Rolls back an application to the last successful revision. Usage:

porter app rollback [application]

porter app rollback my-app

porter apply - Deploy an app using configuration-as-code
porter env - Manage environment variables

​Prerequisites

​porter app run

​porter app run cleanup

​porter app logs

​porter app build

​porter app push

​porter app create

​porter app update

​porter app update-tag

​porter app yaml

​porter app list

​porter app manifests

​porter app rollback

​Related Commands

Prerequisites

`porter app run`

`porter app run cleanup`

`porter app logs`

`porter app build`

`porter app push`

`porter app create`

`porter app update`

`porter app update-tag`

`porter app yaml`

`porter app list`

`porter app manifests`

`porter app rollback`

Related Commands