Skip to main content
Global options are commonly available to use with multiple Openlayer CLI commands.

​
API key

The --api-key option can be used to provide an Openlayer API key when running Openlayer CLI commands. For example, to push without having to run openlayer login:

​
Debug

The --debug option can be used to provide a more verbose output when running Openlayer CLI commands.

​
Profile name

The --profile-name option can be used to specify the profile name to read from for config (default "default").

​
Environment variables

The CLI also reads configuration from environment variables. They are the simplest way to configure the CLI in CI/CD and other non-interactive environments, because they replace openlayer login and openlayer link entirely:

​
Output mode

The --output-mode option controls how the CLI formats its output. It accepts terminal (the default, with colors and interactive progress) or ci (plain output suited for CI logs).
ci is also a no-prompt guard: in this mode the CLI never asks for input. A command that would otherwise prompt fails with an error telling you to pass the value as a flag or environment variable, rather than hanging on a missing terminal. That makes the commands that used to be terminal-only usable in automation:
  • openlayer login signs in from --api-key or OPENLAYER_API_KEY. An explicitly supplied key is enough on its own — you do not have to pass --output-mode ci for this.
  • openlayer link links to the project named by --project. --output-mode ci implies its --yes flag.
  • openlayer init runs the whole setup flow from flags.

​
Version

The --version option can be used to verify the version of Openlayer CLI being used.