Skip to main content
Version: latest


You start the Palette CLI with a single command, palette. The CLI accepts various subcommands such as pde, help, and more. The Palette CLI will return a non-zero exit status during error scenarios. You can use the CLI flags -h and --help to learn more about each subcommand.

The following list contains all the supported Palette CLI subcommands. Click on a subcommand to learn more about it.

  • completion - Generate the autocompletion script for the specified shell.

  • help - Help with any command.

  • docs - Start the Palette documentation site in your local environment for an offline experience.

  • ec - Palette Enterprise Cluster installation & pre-validation.

  • fips-validate - Validate the FIPS compliance of your Kubernetes clusters.

  • import - Import clusters into Palette.

  • login - Login to Palette.

  • pcg - Private Cloud Gateway installation & pre-validation.

  • pde - Palette Developer Experience.

  • project - Manage Palette Projects.

  • validator - Deploy a kind cluster and install the Validator framework to validate your environment is ready for Palette.

Global Flags

Palette CLI supports the following global flags.

Short FlagLong FlagDescriptionType
-c--configConfig file location.string
-h--helpHelp with any command.N/A
-l--log-levelLog level. Allowed values: panic fatal error warn info debug trace (default info)string
-w--workspaceWorkspace location for staging runtime configurations and logs (default $HOME/.palette)string