Canvas CLI commands

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

Project assetCommand
Assetsasset
Componentscomponent
Compositionscomposition
Component patternscomponent-pattern or pattern (legacy)
Composition patternscomposition-pattern
Categoriescategory
Content typescontenttype
Entriesentry
Entry patternsentry-pattern
Data sourcesdatasource
Data typesdatatype
Localeslocale
Promptsprompts
Preview URLspreview-url
Preview viewportspreview-viewport
Workflowsworkflow
uniform canvas asset get <id>

Fetch an asset from the Uniform project.

CommandOutput 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.

uniform canvas asset list

List assets from the Uniform project.

CommandOutput 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.

uniform canvas asset pull <directory or file path>

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

  • If a directory path is specified, a separate file is created for each asset.
  • If a file path is specified, all assets are saved in a single file.
CommandOutput 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.

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.

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.
CommandOutput 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.

uniform canvas asset remove <id>

Delete an asset from the Uniform project.

CommandOutput 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.

uniform canvas asset update <filename>

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

CommandOutput 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.

uniform canvas component get <id>

Fetch a component definition from the Uniform project.

CommandOutput 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.

uniform canvas component list

List component definitions from the Uniform project.

CommandOutput 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.

uniform canvas component pull <directory or file path>

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.
CommandOutput 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.

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.

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.
CommandOutput 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.

uniform canvas component remove <id>

Delete a component definition from the Uniform project.

CommandOutput 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.

uniform canvas component update <filename>

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

CommandOutput 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.

uniform canvas composition get <id>

Fetch a composition definition from the Uniform project.

CommandOutput 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.

uniform canvas composition list

List composition definitions from the Uniform project.

CommandOutput 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.

uniform canvas composition pull <directory or file path>

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.
CommandOutput 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.

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.
CommandOutput 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.

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.
CommandOutput 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.

uniform canvas composition remove <id>

Delete a composition definition from the Uniform project.

CommandOutput 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.

uniform canvas composition update <filename>

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

CommandOutput 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.

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

Fetch a component pattern from the Uniform project.

CommandOutput 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.
uniform canvas component-pattern list // or legacy uniform canvas pattern list

List component patterns from the Uniform project.

CommandOutput 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.

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 a directory path is specified, a separate file is created for each component pattern.
  • If a file path is specified, all component patterns are saved in a single file.
CommandOutput 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.

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.
CommandOutput 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.

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.
CommandOutput 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.

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.
CommandOutput 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.

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

Delete a component pattern from the Uniform project.

CommandOutput 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.

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.

CommandOutput 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.

note

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

uniform canvas composition-pattern get <id>

Fetch a composition pattern from the Uniform project.

CommandOutput 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.
uniform canvas composition-pattern list

List composition patterns from the Uniform project.

CommandOutput 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.

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

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

  • If a directory path is specified, a separate file is created for each composition pattern.
  • If a file path is specified, all composition patterns are saved in a single file.
CommandOutput 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.

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.
CommandOutput 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.

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.
CommandOutput 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.

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.
CommandOutput 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.

uniform canvas composition-pattern remove <id>

Delete a composition pattern from the Uniform project.

CommandOutput 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.

uniform canvas composition-pattern update <filename>

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

CommandOutput 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.

uniform canvas category get <id>

Fetch a category from the Uniform project.

CommandOutput 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.

uniform canvas category list

List of categories from the Uniform project.

CommandOutput 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.

uniform canvas category pull <directory or file path>

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.
CommandOutput 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.

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.

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.
CommandOutput 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.

uniform canvas category remove <id>

Delete a category from the Uniform project.

CommandOutput 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.

uniform canvas category update <filename>

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

CommandOutput 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.

note

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

uniform canvas contenttype get <id>

Fetch a content type from the Uniform project.

CommandOutput 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.

uniform canvas contenttype list

List content types from the Uniform project.

CommandOutput 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.

uniform canvas contenttype pull <directory or file path>

Pulls all content types to local files in a directory

  • If a directory path is specified, a separate file is created for each content type.
  • If a filename ending in yaml or json is used, a package file will be created instead of files in the directory.
CommandOutput 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.

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.
CommandOutput 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.

uniform canvas contenttype remove <id>

Delete a content type from the Uniform project.

CommandOutput 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.

uniform canvas contenttype update <filename>

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

CommandOutput 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.

CommandOutput 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.
uniform canvas entry list

List entries from the Uniform project.

CommandOutput 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.

uniform canvas entry pull <directory or file path>

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

  • If a directory path is specified, a separate file is created for each entry.
  • If a file path is specified, all entries are saved in a single file.
CommandOutput 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.

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.
CommandOutput 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.
CommandOutput 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.
CommandOutput 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 a entry definition from the Uniform project.

CommandOutput 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.

CommandOutput 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.

CommandOutput 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.

CommandOutput 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 a directory path is specified, a separate file is created for each entry pattern.
  • If a file path is specified, all entry patterns are saved in a single file.
CommandOutput 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.
CommandOutput 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.
CommandOutput 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.
CommandOutput 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 a entry pattern from the Uniform project.

CommandOutput 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.

CommandOutput 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.

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.

CommandOutput 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.

uniform canvas datasource remove <id>

Delete a data source from the Uniform project.

CommandOutput 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.

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"}'
CommandOutput 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.

uniform canvas datatype get <id>

Fetch a data type definition from the Uniform project.

CommandOutput 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.

uniform canvas datatype list

List data type definitions from the Uniform project.

CommandOutput 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.

uniform canvas datatype pull <directory or file path>

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.
CommandOutput 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.

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.

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.
CommandOutput 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.

uniform canvas datatype remove <id>

Delete a data type definition from the Uniform project.

CommandOutput 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.

uniform canvas datatype update <filename>

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

CommandOutput 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.

uniform canvas locale pull <directory or file path>

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

  • If a directory path is specified, a separate file is created for each locale.
  • If a file path is specified, all locales are saved in a single file.
CommandOutput 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.

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.

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.
CommandOutput 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.

info

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

At present, built-in prompts cannot be serialized.

uniform canvas prompt get <id>

Fetch a prompt from the Uniform project.

CommandOutput 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.

uniform canvas prompt list

List prompts in the Uniform project.

CommandOutput 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.

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 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.
CommandOutput 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.

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.

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.
CommandOutput 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.

uniform canvas prompt remove <id>

Delete a prompt from the Uniform project.

CommandOutput 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.

uniform canvas prompt update <filename>

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

CommandOutput 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.

uniform canvas preview-url get <id>

Fetch a preview url from the Uniform project.

CommandOutput 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.

uniform canvas preview-url list

List the preview URLs for the Uniform project.

CommandOutput 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.

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

Pulls all preview urls to local files in a directory

  • If a directory path is specified, a separate file is created for each preview url.
  • If a filename ending in yaml or json is used a package file will be created instead of files in the directory.
CommandOutput 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.

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.
CommandOutput 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.

uniform canvas preview-url remove <id>

Remove a preview URL from the Uniform project.

CommandOutput 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.

uniform canvas preview-url update <filename>

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

CommandOutput 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.

!!!!!!

uniform canvas preview-viewport get <id>

Fetch a preview viewport from the Uniform project.

CommandOutput 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.

uniform canvas preview-viewport list

List the preview viewports for the Uniform project.

CommandOutput 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.

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

Pulls all preview urls to local files in a directory

  • If a directory path is specified, a separate file is created for each preview viewport.
  • If a filename ending in yaml or json is used a package file will be created instead of files in the directory.
CommandOutput 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.

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.
CommandOutput 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.

uniform canvas preview-viewport remove <id>

Remove a preview viewport from the Uniform project.

CommandOutput 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.

uniform canvas preview-viewport update <filename>

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

CommandOutput 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.

uniform canvas workflow pull <directory or file path>

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

  • If a directory path is specified, a separate file is created for each workflows.
  • If a file path is specified, all workflows are saved in a single file.
CommandOutput 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.

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.

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.
CommandOutput 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.