CLI commands for Canvas

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

Project asset	Command
Components	component
Compositions	composition
Categories	category
Data sources	datasource
Data types	datatype
Prompts	promts

Component commands#

note

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

Get component#

uniform canvas component get <id>

command
Fetch a component definition from the Uniform project.

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

List components#

uniform canvas component list

command
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 JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Pull component#

uniform canvas component pull <directory or file path>

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

If a directory path is specified, a separate file is created for each component.
If a file path is specified, all component definitions are saved in a single file.

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

tip

If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.

Push component#

uniform canvas component push <directory or file path>

command
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 components in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Remove component#

uniform canvas component remove <id>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Update component#

uniform canvas component update <filename>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Composition commands#

Get composition#

uniform canvas composition get <id>

command
Fetch a composition definition from the Uniform project.

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

List compositions#

uniform canvas composition list

command
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 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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Pull composition#

uniform canvas composition pull <directory or file path>

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

If a directory path is specified, a separate file is created for each composition.
If a file path is specified, all composition definitions are saved in a single file.

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

tip

Push composition#

uniform canvas composition push <directory or file path>

command
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 components in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
--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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

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">

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable `UNIFORM_API_KEY` is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable `UNIFORM_CLI_BASE_URL` is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): `HTTPS_PROXY`, `https_proxy`, `ALL_PROXY`, `all_proxy`. If no match is found, no proxy server is used.

Remove composition#

uniform canvas composition remove <id>

command
Delete a composition definition from the Uniform project.

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

Update composition#

uniform canvas composition update <filename>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Category commands#

Coming soon

Get category#

uniform canvas category get <id>

command Fetch a category from the Uniform project.

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

List of categories#

uniform canvas category list

command
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 JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Pull category#

uniform canvas category pull <directory or file path>

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

If a directory path is specified, a separate file is created for each category.
If a file path is specified, all categories are saved in a single file.

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

tip

Push category#

uniform canvas category push <directory or file path>

command
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 categories in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
-p, --project string	Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Remove category#

uniform canvas category remove <id>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Update category#

uniform canvas category update <filename>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Data source commands#

Get data source#

uniform canvas datasource get <id>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Remove data source#

uniform canvas datasource remove <id>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Update data source#

uniform canvas datasource update <dataSource>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Data type commands#

Get data type#

uniform canvas datatype get <id>

command
Fetch a data type definition from the Uniform project.

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

List data types#

uniform canvas datatype list

command
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 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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Pull data types#

uniform canvas datatype pull <directory or file path>

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

If a directory path is specified, a separate file is created for each composition.
If a file path is specified, all composition definitions are saved in a single file.

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

tip

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.

command
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 components in the Uniform project.
-d, --diff string (optional, default value: off)	Specifies which changes are written to stdout. If not specified, the environment variable UNIFORM_CLI_DIFF_MODE is used. If the environment variable isn't set, the default value is used. `off` - No changes are written. `update` - Only update changes are written. `on` - Update, create, and delete changes are written.
--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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

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>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Update data types#

uniform canvas datatype update <filename>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Prompt commands#

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>

command
Fetch a prompt from the Uniform project.

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

List prompts#

uniform canvas prompt list

command
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 JSON
-o, --filename string (optional)	File name for the output. If not specified the output is written to stdout.
-p, --project string	Uniform project id. If not specified, the environment variable UNIFORM_CLI_PROJECT_ID is used.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Pull prompt#

uniform canvas prompt pull <directory or file path>

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

If a directory path is specified, a separate file is created for each prompt.
If a file path is specified, all custom prompts and disabled built-in prompts are saved in a single file.

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

tip

Push prompt#

uniform canvas prompt push <directory or file path>

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

Remove prompt#

uniform canvas prompt remove <id>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

Update prompt#

uniform canvas prompt update <filename>

command
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.
--apiKey string	Uniform API key. If not specified, the environment variable UNIFORM_API_KEY is used.
--apiHost string (optional, default value: https://uniform.app)	Uniform host. If not specified, the environment variable UNIFORM_CLI_BASE_URL is used. If the environment variable isn't set, the default value is used.
--proxy string (optional)	Proxy server. If not specified, the following environment variables are used (with the first match being used): HTTPS_PROXY, https_proxy, ALL_PROXY, all_proxy. If no match is found, no proxy server is used.

On this page

Component commands#

Get component#

List components#

Pull component#

Push component#

Remove component#

Update component#

Composition commands#

Get composition#

List compositions#

Pull composition#

Push composition#

Publish composition#

Remove composition#

Update composition#

Category commands#

Get category#

List of categories#

Pull category#

Push category#

Remove category#

Update category#

Data source commands#

Get data source#

Remove data source#

Update data source#

Data type commands#

Get data type#

List data types#

Pull data types#

Push data types#

Remove data types#

Update data types#

Prompt commands#

Get prompt#

List prompts#

Pull prompt#

Push prompt#

Remove prompt#

Update prompt#