CLI

tip

Additional commands are available when you install additional npm packages.

Authentication

When using the Uniform CLI to communicate with Uniform, there are several values that always must be specified in order for the CLI to know how to connect to Uniform.

Each of these values can be specified using either a CLI switch or an environment variable. The CLI switch has priority if both are specified.

Value	CLI switch	Environment variable	Notes
API key	--apiKey	UNIFORM_API_KEY	These give granular permissions to the API so you can lock down what the CLI is allow to do. For example, in a CI/CD scenario you only need permission to read from Uniform, while in a development scenario you might need permission to read and write.
Project ID	--project	UNIFORM_CLI_PROJECT_ID	Specifies which Uniform project the CLI command affects.
API host	--apiHost	UNIFORM_CLI_BASE_URL	This value specifies the Uniform endpoint the CLI connects to. This is an optional value. If neither the CLI switch nor the environment variable is set, https://uniform.app is used.
Proxy	--proxy	HTTPS_PROXY https_proxy ALL_PROXY all_proxy	This value specifies the proxy server the CLI uses to make network calls. This is an optional value. If neither the CLI switch nor any of the environment variables set, no proxy server is used. The environment variables are evaluated in the order listed in this table. The first variable with a value is used.

Show help

－ undefined

uniform --help

command

Shows help for CLI commands.

Show version

－ undefined

uniform --version

command

Shows the CLI version number.