Commands
Context CLI commands
The commands in this section allow you to manage project assets that involve Uniform's classification and personalization features. This includes:
| Project asset | Command | More information |
|---|---|---|
| Aggregates | aggregate | Capabilities |
| Enrichments | enrichment | Capabilities |
| Manifest | manifest | Capabilities |
| Quirks | quirk | Capabilities |
| Signals | signal | Capabilities |
| Tests | test | Capabilities |
Aggregates#
Get aggregate#
command
Fetch a aggregate definition 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command Fetch all aggregate definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each aggregate.
- If a file path is specified, all aggregate definitions are saved in 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 components 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 JSON |
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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. |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push aggregate#
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 components 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. |
| --apiKey string | 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#
command Delete a 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. |
| --apiKey string | 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#
command Insert or update a 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. |
| --apiKey string | 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#
command
Fetch an enrichment definition 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command Fetch all enrichment definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each enrichment.
- If a file path is specified, all enrichment definitions are saved in 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 components 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 JSON |
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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. |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push enrichment#
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 components 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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 enrichment#
command Insert or update an enrichment 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. |
| --apiKey string | 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#
command Fetch the manifest for the Uniform project.
| Command | Output details |
|---|---|
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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#
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. |
|---|---|
| --apiKey string | 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#
command
Fetch a quirk definition 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command Fetch all quirk definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each quirk.
- If a file path is specified, all quirk definitions are saved in 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 components 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 JSON |
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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. |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push quirk#
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 components 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command
Fetch a signal definition 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. |
| --apiKey string | 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#
command
List signal 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. |
| --apiKey string | 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#
command Fetch all signal definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each signal.
- If a file path is specified, all signal definitions are saved in 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 components 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 JSON |
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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. |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push signal#
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 components 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command
Fetch a test definition 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command Fetch all test definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each test.
- If a file path is specified, all test definitions are saved in 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 components 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 JSON |
| -p, --project string | Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used. |
| --apiKey string | 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. |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push test#
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 components 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. |
| --apiKey string | 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#
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. |
| --apiKey string | 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#
command Insert or update a 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. |
| --apiKey string | 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. |