CLI commands for Canvas

Overview#

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

Project entity	Command
Assets	asset
Components	component
Compositions	composition
Component patterns	component-pattern or pattern (legacy)
Composition patterns	composition-pattern
Categories	category
Content types	contenttype
Entries	entry
Entry patterns	entry-pattern
Data sources	datasource
Data types	datatype
Labels	label
Locales	locale
Prompts (Legacy feature)	prompts
Preview URLs	preview-url
Preview viewports	preview-viewport
Workflows	workflow

Asset commands#

Get asset#

uniform canvas asset get <id>

Fetch an asset 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 asset#

uniform canvas asset list

List assets 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 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.

Pull asset#

uniform canvas asset pull <directory or file path>

Fetch all assets from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the assets to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all assets 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 asset#

uniform canvas asset push <directory or file path>

Insert or update all assets from local disk to the Uniform project.

If a directory path is specified, the assets defined in the files in the directory used.
If a file path is specified, the assets 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 asset#

uniform canvas asset remove <id>

Delete an asset from the Uniform project. Moves it to Trash.

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 asset#

uniform canvas asset update <filename>

Insert or update an asset 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.

Component commands#

Get component#

uniform canvas component get <id>

Fetch a component 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 components#

uniform canvas component list

List component 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 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.

Pull component#

uniform canvas component pull <directory or file path>

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

If you pass a directory, the CLI writes each of the components to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all components 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 component#

uniform canvas component push <directory or file path>

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

If a directory path is specified, the components defined in the files in the directory used.
If a file path is specified, the components 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 component#

uniform canvas component remove <id>

Delete a component 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 component#

uniform canvas component update <filename>

Insert or update a component 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.

Composition commands#

Get composition#

uniform canvas composition get <id>

Fetch a composition 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 compositions#

uniform canvas composition list

List composition 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the compositions that are in this state. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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 composition#

uniform canvas composition pull <directory or file path>

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

If you pass a directory, the CLI writes each of the compositions to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all compositions 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)
--state string (default value: preview)	Get the compositions that are in this state. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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 composition#

uniform canvas composition push <directory or file path>

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

If a directory path is specified, the compositions defined in the files in the directory used.
If a file path is specified, the components 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.
--state string (default value: preview)	Compositions are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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.

info

it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state switch for more information.

Publish composition#

uniform canvas composition publish <compositionId or "--all">

Publishes given composition.

If a compositionId is specified, then the specific composition will be published.
If "--all" param is specified instead - all compositions in the project will be published.

Command	Output details
--all boolean (optional)	If true, all compositions in the project will be published. Overrides "compositionId"
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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 composition#

uniform canvas composition remove <id>

Delete a composition from the Uniform project. Moves it to Trash.

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 composition#

uniform canvas composition update <filename>

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

Command	Output details
--state string (default value: preview)	Composition is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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.

Component pattern commands#

Get component pattern#

uniform canvas component-pattern get <id> // or legacy uniform canvas pattern get <id>

Fetch a component pattern 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.
--state string (optional, choices: "preview", "published", default value: "preview")	Component pattern state to fetch.

List component patterns#

uniform canvas component-pattern list // or legacy uniform canvas pattern list

List component patterns 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the component patterns that are in this state. `preview` `published` - Using this option without first pushing the draft component patterns will result in "orphan" component patterns and therefore isn't recommended.
-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 component pattern#

uniform canvas component-pattern pull <directory or file path> // or legacy uniform canvas pattern pull <directory or file path>

Fetch all component patterns from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the component patterns to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all component patterns 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)
--state string (default value: preview)	Get the component patterns that are in this state. `preview` `published` - Using this option without first pushing the draft component patterns will result in "orphan" component patterns and therefore isn't recommended.
-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 component pattern#

uniform canvas component-pattern push <directory or file path> // or legacy uniform canvas pattern push <directory or file path>

Insert or update all component patterns from local disk to the Uniform project.

If a directory path is specified, the component patterns defined in the files in the directory used.
If a file path is specified, the components 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.
--state string (default value: preview)	Component patterns are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft component patterns will result in "orphan" component patterns and therefore isn't recommended.
-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.

info

it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state switch for more information.

Publish component pattern#

uniform canvas component-pattern publish <ids or "--all"> // or legacy uniform canvas pattern publish <ids or "--all">

Publishes given component patterns.

If a ids is specified, then the specific comma-separated component patterns will be published.
If "--all" param is specified instead - all component patterns in the project will be published.

Command	Output details
--all boolean (optional)	If true, all component patterns in the project will be published. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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.

Unpublish component pattern#

uniform canvas component-pattern publish <ids or "--all"> // or legacy uniform canvas pattern publish <ids or "--all">

Unpublish given component patterns.

If a ids is specified, then the specific comma-separated component patterns will be unpublished.
If "--all" param is specified instead - all component patterns in the project will be unpublished.

Command	Output details
--all boolean (optional)	If true, all component patterns in the project will be unpublished. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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 component pattern#

uniform canvas component-pattern remove <id> // or legacy uniform canvas pattern remove <id>

Delete a component pattern from the Uniform project. Moves it to Trash.

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 component pattern#

uniform canvas component-pattern update <filename> // or legacy uniform canvas pattern update <filename>

Insert or update a component pattern from a local file to the Uniform project.

Command	Output details
--state string (default value: preview)	Component pattern is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft component patterns will result in "orphan" component patterns and therefore isn't recommended.
-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.

Composition pattern commands#

note

Requires the @uniformdev/cli package in version v19.169.0 or higher.

Get composition pattern#

uniform canvas composition-pattern get <id>

Fetch a composition pattern 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.
--state string (optional, choices: "preview", "published", default value: "preview")	Composition pattern state to fetch.

List composition patterns#

uniform canvas composition-pattern list

List composition patterns 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the composition patterns that are in this state. `preview` `published` - Using this option without first pushing the draft composition patterns will result in "orphan" composition patterns and therefore isn't recommended.
-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 composition pattern#

uniform canvas composition-pattern pull <directory or file path>

Fetch all composition patterns from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the composition patterns to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all composition patterns 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)
--state string (default value: preview)	Get the composition patterns that are in this state. `preview` `published` - Using this option without first pushing the draft composition patterns will result in "orphan" composition patterns and therefore isn't recommended.
-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 composition pattern#

uniform canvas composition-pattern push <directory or file path>

Insert or update all composition patterns from local disk to the Uniform project.

If a directory path is specified, the composition patterns defined in the files in the directory used.
If a file path is specified, the components 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.	--state string (default value: preview)	Composition patterns are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft composition patterns will result in "orphan" composition patterns and therefore isn't recommended.
-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.

info

it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state switch for more information.

Publish composition pattern#

uniform canvas composition-pattern publish <ids or "--all">

Publishes given composition patterns.

If a ids is specified, then the specific comma-separated composition patterns will be published.
If "--all" param is specified instead - all composition patterns in the project will be published.

Command	Output details
--all boolean (optional)	If true, all composition patterns in the project will be published. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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.

Unpublish composition pattern#

uniform canvas composition-pattern publish <ids or "--all">

Unpublish given composition patterns.

If a ids is specified, then the specific comma-separated composition patterns will be unpublished.
If "--all" param is specified instead - all composition patterns in the project will be unpublished.

Command	Output details
--all boolean (optional)	If true, all composition patterns in the project will be unpublished. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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 composition pattern#

uniform canvas composition-pattern remove <id>

Delete a composition pattern from the Uniform project. Moves it to Trash.

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 composition pattern#

uniform canvas composition-pattern update <filename>

Insert or update a composition pattern from a local file to the Uniform project.

Command	Output details
--state string (default value: preview)	Composition pattern is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft composition patterns will result in "orphan" composition patterns and therefore isn't recommended.
-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.

Category commands#

Get category#

uniform canvas category get <id>

Fetch a category 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 of categories#

uniform canvas category list

List of categories 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 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.

Pull category#

uniform canvas category pull <directory or file path>

Fetch all categories from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the categories to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all categories 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 category#

uniform canvas category push <directory or file path>

Insert or update all categories from local disk to the Uniform project.

If a directory path is specified, the categories in the files in the directory used.
If a file path is specified, the categories 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 category#

uniform canvas category remove <id>

Delete a category 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 category#

uniform canvas category update <filename>

Insert or update a category 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.

Content type commands#

note

The commands in this section require the package @uniformdev/canvas.

Get content type#

uniform canvas contenttype get <id>

Fetch a content type 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 content types#

uniform canvas contenttype list

List content types 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 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.

Pull content types#

uniform canvas contenttype pull <directory or file path>

Pulls all content types to local files in a directory

If you pass a directory, the CLI writes each of the content types to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all content types 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 content types#

uniform canvas contenttype push <directory or file path>

Pushes all content types from files in a directory to Uniform

If a directory path is specified, the content types that are defined in the files in the directory used.
If a file path is specified, the content types 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 content type#

uniform canvas contenttype remove <id>

Delete a content type 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 content type#

uniform canvas contenttype update <filename>

Insert or update a content type 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.

Entry commands#

Get entry#

uniform canvas entry get <id>

Fetch an entry 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.
--resolveData boolean (optional, default value: false)	Resolve all data resources used by the entry
--resolutionDepth integer (optional, default value: 1)	Controls how many levels deep content references should be resolved.

List entries#

uniform canvas entry list

List entries 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the entries that are in this state. `preview` `published` - Using this option without first pushing the draft entries will result in "orphan" entries and therefore isn't recommended.
-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 entries#

uniform canvas entry pull <directory or file path>

Fetch all entries from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the entries to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all entries 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)
--state string (default value: preview)	Get the entries that are in this state. `preview` `published` - Using this option without first pushing the draft entries will result in "orphan" entries and therefore isn't recommended.
-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 entries#

uniform canvas entry push <directory or file path>

Insert or update all entries from local disk to the Uniform project.

If a directory path is specified, the entries defined in the files in the directory used.
If a file path is specified, the components 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.
--state string (default value: preview)	Entries are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft entries will result in "orphan" entries and therefore isn't recommended.
-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 entry#

uniform canvas entry publish <entryId or "--all">

Publishes given entry.

If a entryId is specified, then the specific entry will be published.
If "--all" param is specified instead - all entries in the project will be published.

Command	Output details
--all boolean (optional)	If true, all entries in the project will be published. Overrides "entryId"
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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.

Unpublish entry#

uniform canvas entry unpublish <entryId or "--all">

Unpublishes given entry.

If an entryId is specified, that specific entry will be unpublished.
If "--all" param is specified instead - all entries in the project will be unpublished.

Command	Output details
--all boolean (optional)	If true, all entries in the project will be unpublished. Overrides "entryId".
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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 entry#

uniform canvas entry remove <id>

Delete an entry from the Uniform project. Moves it to Trash.

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 entry#

uniform canvas entry update <filename>

Insert or update a entry from a local file to the Uniform project.

Command	Output details
--state string (default value: preview)	Entry is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft entries will result in "orphan" entries and therefore isn't recommended.
-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.

Entry pattern commands#

note

Requires the @uniformdev/cli package in version v19.146.2 or higher.

Get entry pattern#

uniform canvas entry-pattern get <id>

Fetch a entry pattern 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.
--state string (optional, choices: "preview", "published", default value: "preview")	Entry pattern state to fetch.

List entry patterns#

uniform canvas entry-pattern list

List entry patterns 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the entry patterns that are in this state. `preview` `published` - Using this option without first pushing the draft entry patterns will result in "orphan" entry patterns and therefore isn't recommended.
-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 entry pattern#

uniform canvas entry-pattern pull <directory or file path>

Fetch all entry patterns from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the entry patterns to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all entry patterns 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)
--state string (default value: preview)	Get the entry patterns that are in this state. `preview` `published` - Using this option without first pushing the draft entry patterns will result in "orphan" entry patterns and therefore isn't recommended.
-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 entry pattern#

uniform canvas entry-pattern push <directory or file path>

Insert or update all entry patterns from local disk to the Uniform project.

If a directory path is specified, the entry patterns defined in the files in the directory used.
If a file path is specified, the entry patterns 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.
--state string (default value: preview)	Entry patterns are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft entry patterns will result in "orphan" entry patterns and therefore isn't recommended.
-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.

info

it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state switch for more information.

Publish entry pattern#

uniform canvas entry-pattern publish <ids or "--all">

Publishes given entry patterns.

If a ids is specified, then the specific comma-separated entry patterns will be published.
If "--all" param is specified instead - all entry patterns in the project will be published.

Command	Output details
--all boolean (optional)	If true, all entry patterns in the project will be published. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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.

Unpublish entry pattern#

uniform canvas entry-pattern publish <ids or "--all">

Unpublish given entry patterns.

If a ids is specified, then the specific comma-separated entry patterns will be unpublished.
If "--all" param is specified instead - all entry patterns in the project will be unpublished.

Command	Output details
--all boolean (optional)	If true, all entry patterns in the project will be unpublished. Overrides `ids`
-w, --what-if boolean (optional)	If true, reports what would be done but changes no files.
-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 entry pattern#

uniform canvas entry-pattern remove <id>

Delete an entry pattern from the Uniform project. Moves it to Trash.

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 entry pattern#

uniform canvas entry-pattern update <filename>

Insert or update a entry pattern from a local file to the Uniform project.

Command	Output details
--state string (default value: preview)	Entry pattern is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft entry patterns will result in "orphan" entry patterns and therefore isn't recommended.
-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.

Data source commands#

Get data source#

uniform canvas datasource get <id>

Fetch a data source definition from the Uniform project. Because the data source may contain secrets, the value is only written to stdout.

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.

Remove data source#

uniform canvas datasource remove <id>

Delete a data source 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 data source#

uniform canvas datasource update <dataSource>

Insert or update a data source using its JSON definition. The JSON can be fetched using the get command.

example

uniform canvas datasource update --integrationType canvas '{"id": "pokeapi", "displayName": "Pokéapi", "connectorType": "genericrestapi", "baseUrl": "https://pokeapi.co/api/v2"}'

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.

Data type commands#

Get data type#

uniform canvas datatype get <id>

Fetch a data type 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 data types#

uniform canvas datatype list

List data type 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 or JSON)
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
--state string (default value: preview)	Get the compositions that are in this state. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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 data types#

uniform canvas datatype pull <directory or file path>

Fetch all data type definitions from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the data types to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all data types 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)
--state string (default value: preview)	Get the compositions that are in this state. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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 data types#

uniform canvas datatype push <directory or file path>

note

Data sources referred to in your data types must be created manually before a push can succeed. Data sources cannot be serialized because they contain secrets.

Insert or update all data type definitions from local disk to the Uniform project.

If a directory path is specified, the compositions defined in the files in the directory used.
If a file path is specified, the components 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.
--state string (default value: preview)	Compositions are set to this state after being pushed. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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.

info

it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state switch for more information.

Remove data types#

uniform canvas datatype remove <id>

Delete a data type 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 data types#

uniform canvas datatype update <filename>

Insert or update a data type definition from a local file to the Uniform project.

Command	Output details
--state string (default value: preview)	Data type is set to this state after being updated. `preview` `published` - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended.
-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.

Label commands#

The commands in this section allow you to manage labels through the canvas label command group.

Minimum CLI version

Label commands require @uniformdev/cli version 20.51.1 or higher.

Pull label#

uniform canvas label pull <directory or file path>

Fetch all labels from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the labels to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all labels 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 label#

uniform canvas label push <directory or file path>

Insert or update all labels from local disk to the Uniform project.

If a directory path is specified, the labels defined in the files in the directory are used.
If a file path is specified, the labels 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.

Locale commands#

Pull locale#

uniform canvas locale pull <directory or file path>

Fetch all locales from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the locales to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all locales 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 locale#

uniform canvas locale push <directory or file path>

Insert or update all locales from local disk to the Uniform project.

If a directory path is specified, the locales defined in the files in the directory used.
If a file path is specified, the locales 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.

Prompt commands#

Legacy feature

AI prompts is a legacy feature that will continue working for existing projects but is not recommended for new implementations.

For a more flexible and powerful approach, use Scout for AI-assisted composition building, AI guidance to define context for your components and content types, and AI quick edits for rapid content updates.

AI prompts are likely to be deprecated in the future.

info

The commands in this section require the package @uniformdev/canvas.

At present, built-in prompts cannot be serialized.

Get prompt#

uniform canvas prompt get <id>

Fetch a prompt 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 prompts#

uniform canvas prompt list

List prompts in 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 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.

Pull prompt#

uniform canvas prompt pull <directory or file path>

Fetch all custom prompts and disabled built-in prompts from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the custom prompts and disabled built-in prompts to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all custom prompts and disabled built-in prompts 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 prompt#

uniform canvas prompt push <directory or file path>

Insert or update all custom prompts and disabled built-in prompts from local disk to the Uniform project.

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

Command	Output details
-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 prompt#

uniform canvas prompt remove <id>

Delete a prompt 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 prompt#

uniform canvas prompt update <filename>

Insert or update a prompt 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.

Preview URL commands#

Get preview URL#

uniform canvas preview-url get <id>

Fetch a preview url 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 preview URLs#

uniform canvas preview-url list

List the preview URLs for 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.

Pull preview URL#

uniform canvas preview-url pull <directory or file path>

Fetch all preview URLs from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the preview URLs to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all preview URLs 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 preview URLs#

uniform canvas preview-url push <directory or file path>

Pushes all preview urls from files in a directory to Uniform Canvas

If a directory path is specified, the preview urls defined in the files in the directory used.
If a file path is specified, the preview urls 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 preview URL#

uniform canvas preview-url remove <id>

Remove a preview URL 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.

Update preview URL#

uniform canvas preview-url update <filename>

Insert or update a preview url from a local file to 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.

!!!!!!

Preview viewport commands#

Get preview viewport#

uniform canvas preview-viewport get <id>

Fetch a preview viewport 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 preview viewports#

uniform canvas preview-viewport list

List the preview viewports for 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.

Pull preview viewports#

uniform canvas preview-viewport pull <directory or file path>

Fetch all preview viewports from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the preview viewports to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all preview viewports 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 preview viewports#

uniform canvas preview-viewport push <directory or file path>

Pushes all preview viewports from files in a directory to Uniform Canvas

If a directory path is specified, the preview viewports defined in the files in the directory are used.
If a file path is specified, the preview viewports 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 preview viewport#

uniform canvas preview-viewport remove <id>

Remove a preview viewport 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.

Update preview viewport#

uniform canvas preview-viewport update <filename>

Insert or update a preview viewport from a local file to 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.

Workflow commands#

Pull workflow#

uniform canvas workflow pull <directory or file path>

Fetch all workflows from the Uniform project and save them locally.

If you pass a directory, the CLI writes each of the workflows to its own file.
If you pass a file path ending in .yaml, .yml, or .json, the CLI writes all workflows 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 workflow#

note

In order to push workflows to a project, you must ensure;

The current token being used with the CLI has Team Admin permissions
The team for the project to which the workflows are being pushed already has roles created with the same public IDs as those specified in the workflows being created.

uniform canvas workflow push <directory or file path>

Insert or update all worlflows from local disk to the Uniform project.

If a directory path is specified, the workflows defined in the files in the directory used.
If a file path is specified, the workflows 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.