• Apollo
    • Search documentation
    karat

    +

    K

    ReferenceApollo CLIapollo-cli configure

    apollo-cli configure

    Updates configuration file that Apollo CLI references to authenticate and interact with Apollo.

    Updates the configuration file that Apollo CLI uses.

    By default, configures the current active profile. Use --profile to configure a specific profile. If the specified profile doesn't exist, it will be created.

    This command prompts interactively for configuration values. Press Enter to keep the current value, or enter '' (two single quotes) to clear a value.

    Copied!
    1
apollo-cli configure [flags]

    Flags

    FlagUse
    -h, --helpHelp for configure
    --profileConfigure a specific profile (default: current profile)

    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