Skip to main content

Documentation Index

Fetch the complete documentation index at: https://porter-mintlify-4369f078.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

porter config contains commands for managing local CLI configuration settings.

porter config

Display the current CLI configuration, including project, cluster, and authentication details. Usage:
porter config
Flags:
FlagDescription
--show-tokenDisplay the CLI authentication token in the output. By default, the token is hidden for security. Pass this flag to reveal the token value.
Configuration values can be overridden using flags or environment variables. See Basic Usage for details.

porter config set-project

Set the active project. This command shows a list of projects you have access to and lets you select one. Usage:
porter config set-project

porter config set-login-method

Select which browser-based login flow porter auth login uses. Usage:
porter config set-login-method v2
MethodWhen to use
v1 (default)CI/CD pipelines, scripts, and any environment that needs a long-lived token.
v2Developer machines where your organization requires session-bound credentials. Signs in through Porter SSO and stores a short-lived WorkOS access token that is refreshed automatically.
After switching, run porter auth login again to reauthenticate with the selected method.
The v2 flow is supported on Porter API hosts that have WorkOS configured. If your instance does not have WorkOS enabled, stay on v1.

porter config set-cluster

Set the active cluster. This command shows a list of clusters in the current project and lets you select one. Usage:
porter config set-cluster
Run porter cluster list first to see available clusters and their IDs.

Configuration File

Porter stores configuration in ~/.porter/config.json. You can also override settings using environment variables:
VariableDescription
PORTER_PROJECTOverride project ID
PORTER_CLUSTEROverride cluster ID
PORTER_TOKENOverride authentication token
PORTER_HOSTOverride API host