CLI commands for Context

The commands in this section allow you to manage project entities that involve Uniform's classification and personalization features. This includes:

Project entity	Command	More information
Aggregates	aggregate	Capabilities
Enrichments	enrichment	Capabilities
Manifest	manifest	Capabilities
Quirks	quirk	Capabilities
Signals	signal	Capabilities
Tests	test	Capabilities

Aggregates#

Get aggregate#

uniform context aggregate get <id>

command
Fetch an aggregate definition from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

List aggregates#

uniform context aggregate list

command
List aggregate definitions from the Uniform project.

Command	Output details
--offset integer (optional)	Number of rows to skip before fetching.
limit integer (optional, default value: 20)	Number of rows to fetch.
-f, --format string (optional, default value: YAML)	Format for the output. YAML JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Pull aggregate#

uniform context aggregate pull <directory or file path>

command Fetch all aggregate definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the aggregates to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all aggregates to a single file.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Push aggregate#

uniform context aggregate push <directory or file path>

command Insert or update all aggregate definitions from local disk to the Uniform project.

If a directory path is specified, the aggregates defined in the files in the directory used.
If a file path is specified, the aggregates in the file are used.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove aggregate#

uniform context aggregate remove <id>

command Delete an aggregate definition from the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Update aggregate#

uniform context aggregate update <filename>

command Insert or update an aggregate definition from a local file to the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Enrichments#

Get enrichment#

uniform context enrichment get <id>

command
Fetch an enrichment definition from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

List enrichments#

uniform context enrichment list

command
List enrichment definitions from the Uniform project.

Command	Output details
--offset integer (optional)	Number of rows to skip before fetching.
limit integer (optional, default value: 20)	Number of rows to fetch.
-f, --format string (optional, default value: YAML)	Format for the output. YAML JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Pull enrichment#

uniform context enrichment pull <directory or file path>

command Fetch all enrichment definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the enrichments to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all enrichments to a single file.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Push enrichment#

uniform context enrichment push <directory or file path>

command Insert or update all enrichment definitions from local disk to the Uniform project.

If a directory path is specified, the enrichment defined in the files in the directory used.
If a file path is specified, the enrichment in the file are used.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove enrichment#

uniform context enrichment remove <id>

command Delete an enrichment definition from the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Manifests#

Get manifest#

uniform context manifest get -o <path> # or: uniform context manifest download -o <path>

command Download the Uniform Context manifest for the project. The output path is required; use -o or --output. You can use the download (or dl) alias instead of get.

Command	Output details
-o, --output string (required)	Path to write the manifest file to. Defaults to `UNIFORM_MANIFEST_PATH` if set.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Publish manifest#

uniform context manifest publish

command Publish the manifest for the Uniform project.

-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Quirks#

Get quirk#

uniform context quirk get <id>

command
Fetch a quirk definition from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

List quirks#

uniform context quirk list

command
List quirk definitions from the Uniform project.

Command	Output details
--offset integer (optional)	Number of rows to skip before fetching.
limit integer (optional, default value: 20)	Number of rows to fetch.
-f, --format string (optional, default value: YAML)	Format for the output. YAML JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Pull quirk#

uniform context quirk pull <directory or file path>

command Fetch all quirk definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the quirks to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all quirks to a single file.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Push quirk#

uniform context quirk push <directory or file path>

command Insert or update all quirk definitions from local disk to the Uniform project.

If a directory path is specified, the quirks defined in the files in the directory used.
If a file path is specified, the quirks in the file are used.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove quirk#

uniform context quirk remove <id>

command Delete a quirk definition from the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Update quirk#

uniform context quirk update <filename>

command Insert or update a quirk definition from a local file to the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Signals#

Get signal#

uniform context signal get <id>

command
Fetch a signal definition from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

List signals#

uniform context signal list

command
List signal definitions from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output. YAML JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Pull signal#

uniform context signal pull <directory or file path>

command Fetch all signal definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the signals to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all signals to a single file.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Push signal#

uniform context signal push <directory or file path>

command Insert or update all signal definitions from local disk to the Uniform project.

If a directory path is specified, the signals defined in the files in the directory used.
If a file path is specified, the signals in the file are used.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove signal#

uniform context signal remove <id>

command Delete a signal definition from the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Update signal#

uniform context signal update <filename>

command Insert or update a signal definition from a local file to the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Tests#

Get test#

uniform context test get <id>

command
Fetch a test definition from the Uniform project.

Command	Output details
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

List tests#

uniform context test list

command
List test definitions from the Uniform project.

Command	Output details
--offset integer (optional)	Number of rows to skip before fetching.
limit integer (optional, default value: 20)	Number of rows to fetch.
-f, --format string (optional, default value: YAML)	Format for the output. YAML JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Pull test#

uniform context test pull <directory or file path>

command Fetch all test definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the tests to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all tests to a single file.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-f, --format string (optional, default value: YAML)	Format for the output (YAML or JSON)
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Push test#

uniform context test push <directory or file path>

command Insert or update all test definitions from local disk to the Uniform project.

If a directory path is specified, the tests defined in the files in the directory used.
If a file path is specified, the tests in the file are used.

Command	Output details
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-m, --mode string (optional, default value: mirror)	Specifies what kind of changes can be made. `create` - Create new files but don't update existing files. `createOrUpdate` - Create new files and update existing files but delete no files. `mirror` - Create new files, update existing files, and delete files that don't match existing objects in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove test#

uniform context test remove <id>

command Delete a test definition from the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Update test#

uniform context test update <filename>

command Insert or update a test definition from a local file to the Uniform project.

Command	Output details
-p, --project string	Uniform project id. If not specified, the environment variable `UNIFORM_CLI_PROJECT_ID` is used.
-f, --format string (optional, default value: YAML)	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.