This command is Experimental. To enable this command, run the apollo-cli configure command and enable V2 experimental commands.
Manage interactive terminals in Apollo environments
Connects to an Apollo environment and opens an interactive debug terminal.
The terminal runs in a debug pod in the target environment with kubectl pre-configured. You can run kubectl commands, shell scripts, and other debugging tools.
If no profile is specified, the default shell profile is used.
When --session-id is provided, attaches to an existing session instead of creating a new one.
Example:
apollo-cli terminal --environment my-environment-id --space-id my-space
apollo-cli terminal
apollo-cli terminal --profile ri.portal..terminal-profile.abc123
apollo-cli terminal --session-id my-session-id
Copied!1apollo-cli terminal [flags]
| Flag | Use |
|---|---|
-h, --help | Help for terminal |
--profile | Terminal profile RID to use |
--session-id | Attach to an existing terminal session instead of creating a new one |
| Flag | Use |
|---|---|
--apollo-client-id | Client ID to use for generating Bearer Token |
--apollo-client-secret | Client secret to use for generating Bearer Token |
--apollo-token | Bearer Token to use for authenticated endpoints |
--apollo-token-provider | Specifies how the Bearer Token used for authenticated Apollo endpoint calls is provided. Valid values are "auto", "static", "service-user", or "sso" (default "auto"). If "auto" is specified, the mode is picked from what is configured: "static" if "apollo-token" is set, "service-user" if "apollo-client-id" and "apollo-client-secret" are both set, otherwise "sso" (interactive browser login). Errors if both a bearer token AND (client id OR client secret) are set. If "static" is specified, the token provided by "apollo-token" is used. If "service-user" is specified, "apollo-client-id" and "apollo-client-secret" are used to generate a token from Multipass. If "sso" is specified, an interactive browser-based SSO login against Multipass is used (supports hardware keys like YubiKey); the resulting token is cached per profile and refreshed silently. The login flow is triggered automatically the first time a command needs a token and no valid cached token exists. |
--apollo-url | Base URL for Apollo that is used to derive the API endpoints |
--debug | Enable debug level logging |
-e, --environment | Environment ID (including suffix) to use for environment-scoped commands |
--http-timeout | Timeout in minutes for all apollo requests |
-k, --insecure-skip-verify | Skip verification of server certificate |
-o, --output | Output format (json,yaml,pretty) |
--quiet | Do not print log output to stderr |
--space-id | Space ID to use for certain space-scoped commands |