Search documentation
karat

+

K

apollo-cli

The Apollo CLI provides a flexible way to interact with Apollo. It can be used to manually publish new Product Releases and as an alternative to the UI for retrieving Apollo metadata (such as which Environments and Products are currently managed by Apollo).

The CLI is supported on Linux, MacOS (Darwin), and Windows.

Installation

To install the Apollo CLI, follow the instructions provided in the Apollo CLI getting started guide.

Flags

FlagUse
-h, --helpShow apollo-cli help menu

Commands

CommandUse
add-unmanaged-serviceRegisters an unmanaged service in Apollo
configureOne-time setup command to enter information needed by the CLI to interact with Apollo
create-moduleCreates a new Module
get-central-namespaceGets the Central Namespace
get-installationsGets the Installations for the specified environment(s)
get-product-releasesGets all Releases for the specified Products as a map from Apache Maven coordinate to Product Release
get-product-versionsGets all versions for the specified Product
list-environmentsLists all Environments managed by Apollo
list-namespacesLists all Namespaces
list-productsLists all existing Product IDs in Apollo
moduleManage Modules
publishPublishes a new Product Release to Apollo

Experimental commands

The following commands are Experimental.

You can enable Experimental commands by running the apollo-cli configure command. When prompted, enter enabled for V2 experimental commands.

CommandUse
entityManage Helm chart Entities
environmentManage Apollo Environments
product-releaseManage Product Releases