Search documentation
karat

+

K

apollo-cli terminal [Experimental]

This command is Experimental. To enable this command, run the apollo-cli configure command and enable V2 experimental commands.

Open an interactive terminal in an Apollo environment

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.

Example:

Connect to a specific environment

apollo-cli terminal --environment my-environment-id --space-id my-space

Use default environment from config

apollo-cli terminal

Use a specific terminal profile

apollo-cli terminal --profile ri.portal..terminal-profile.abc123

Copied!
1 apollo-cli terminal [flags]

Flags

FlagUse
-h, --helpHelp for terminal
--profileTerminal profile RID to use

Flags inherited from parent commands

FlagUse
--apollo-client-idClient ID to use for generating Bearer Token
--apollo-client-secretClient secret to use for generating Bearer Token
--apollo-tokenBearer Token to use for authenticated endpoints
--apollo-token-providerSpecifies 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-urlBase URL for Apollo that is used to derive the API endpoints
--debugEnable debug level logging
-e, --environmentEnvironment ID (including suffix) to use for environment-scoped commands
--http-timeoutTimeout in minutes for all apollo requests
-k, --insecure-skip-verifySkip verification of server certificate
-o, --outputOutput format (json,yaml,pretty)
--quietDo not print log output to stderr
--space-idSpace ID to use for certain space-scoped commands

See also