• Apollo
    • Search documentation
    karat

    +

    K

    ReferenceApollo CLIapollo-cli entity aggregate [Experimental]

    apollo-cli entity aggregate [Experimental]

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

    Aggregate entities from all environments into a unified entity list

    Fetch entity data from all Apollo environments, transform entity IDs, and merge into a unified entity list.

    This command:

    1. Lists all environments in the Apollo space
    2. Fetches entities from each environment
    3. Saves per-environment YAML files to the output directory
    4. Transforms entity IDs to use a common target environment
    5. Merges entities with the same transformed ID, combining versions
    6. Sets the specified release channel on all merged entities
    7. Writes the unified entity list to all_entities.yaml

    The --generate-versions flag creates product-versions.yaml with all versions per product. The --generate-lowest flag creates lowest-versions.yaml with the lowest version per product.

    Example usage:

    Aggregate entities to output directory with STABLE release channel

    apollo-cli entity aggregate -r STABLE --output-dir ./aggregate-output

    Aggregate with version reports

    apollo-cli entity aggregate -r STABLE --output-dir ./aggregate-output --generate-versions --generate-lowest

    Copied!
    1
apollo-cli entity aggregate [flags]

    Flags

    FlagUse
    --generate-lowestGenerate lowest-versions.yaml with lowest version per product
    --generate-versionsGenerate product-versions.yaml with all versions per product
    -h, --helpHelp for aggregate
    --output-dirDirectory where artifacts are written
    -r, --release-channelRelease channel

    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", or "service-user" (default "auto"). If "auto" is specified, will use either the Bearer Token provided by "apollo-token" or a Bearer Token obtained by using "apollo-client-id" and "apollo-client-secret" to generate a token from Multipass depending on which values are set (but will error if both values 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.
    --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)
    --profileUse a specific profile from your configuration file
    --quietDo not print log output to stderr
    --space-idSpace ID to use for certain space-scoped commands

    See also