Canvas CLI commands
Overview#
The commands in this section allow you to manage project assets that involve Uniform's composition features. This includes:
Project asset | Command |
---|---|
Assets | asset |
Components | component |
Compositions | composition |
Component patterns | component-pattern or pattern (legacy) |
Composition patterns | composition-pattern |
Categories | category |
Content types | contenttype |
Entries | entry |
Entry patterns | entry-pattern |
Data sources | datasource |
Data types | datatype |
Locales | locale |
Prompts | prompts |
Preview URLs | preview-url |
Preview viewports | preview-viewport |
Workflows | workflow |
Asset commands#
Get asset#
Fetch an asset from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List asset#
List assets from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull asset#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push asset#
Insert or update all assets from local disk to the Uniform project.
- If a directory path is specified, the assets defined in the files in the directory used.
- If a file path is specified, the assets in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove asset#
Delete an asset from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update asset#
Insert or update an asset from a local file to the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Component commands#
Get component#
Fetch a component definition from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List components#
List component definitions from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull component#
Fetch all component definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each component.
- If a file path is specified, all component definitions are saved in a single file.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push component#
Insert or update all component definitions from local disk to the Uniform project.
- If a directory path is specified, the components defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove component#
Delete a component definition from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update component#
Insert or update a component definition from a local file to the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Composition commands#
Get composition#
Fetch a composition definition from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List compositions#
List composition definitions from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull composition#
Fetch all composition definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each composition.
- If a file path is specified, all composition definitions are saved in a single file.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push composition#
Insert or update all composition definitions from local disk to the Uniform project.
- If a directory path is specified, the compositions defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
--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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
info
it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state
switch for more information.
Publish composition#
Publishes given composition.
- If a compositionId is specified, then the specific composition will be published.
- If "--all" param is specified instead - all compositions in the project will be published.
Command | Output details |
---|---|
--all boolean (optional) | If true, all compositions in the project will be published. Overrides "compositionId" |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove composition#
Delete a composition definition from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update composition#
Insert or update a composition definition from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Composition is set to this state after being updated.preview published - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Component pattern commands#
Get component pattern#
Fetch a component pattern from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
--state string (optional, choices: "preview", "published", default value: "preview") | Component pattern state to fetch. |
List component patterns#
List component patterns from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull component pattern#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push component pattern#
Insert or update all component patterns from local disk to the Uniform project.
- If a directory path is specified, the component patterns defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
--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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
info
it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state
switch for more information.
Publish component pattern#
Publishes given component patterns.
- If a
ids
is specified, then the specific comma-separated component patterns will be published. - If "--all" param is specified instead - all component patterns in the project will be published.
Command | Output details |
---|---|
--all boolean (optional) | If true, all component patterns in the project will be published. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Unpublish component pattern#
Unpublish given component patterns.
- If a
ids
is specified, then the specific comma-separated component patterns will be unpublished. - If "--all" param is specified instead - all component patterns in the project will be unpublished.
Command | Output details |
---|---|
--all boolean (optional) | If true, all component patterns in the project will be unpublished. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove component pattern#
Delete a component pattern from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update component pattern#
Insert or update a component pattern from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Component pattern is set to this state after being updated.preview published - Using this option without first pushing the draft component patterns will result in "orphan" component patterns and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Composition pattern commands#
note
Requires the @uniformdev/cli
package in version v19.169.0
or higher.
Get composition pattern#
Fetch a composition pattern from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
--state string (optional, choices: "preview", "published", default value: "preview") | Composition pattern state to fetch. |
List composition patterns#
List composition patterns from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull composition pattern#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push composition pattern#
Insert or update all composition patterns from local disk to the Uniform project.
- If a directory path is specified, the composition patterns defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details | ||
---|---|---|---|
-w, --what-if | If true, reports what would be done but changes no files. | ||
-m, --mode | Specifies what kind of changes can be made. | ||
-d, --diff | 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. | --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 | Uniform project id. If not specified, the environment variable | ||
-f, --format | Uniform API key. If not specified, the environment variable | ||
--apiHost | Uniform host. If not specified, the environment variable | ||
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
info
it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state
switch for more information.
Publish composition pattern#
Publishes given composition patterns.
- If a
ids
is specified, then the specific comma-separated composition patterns will be published. - If "--all" param is specified instead - all composition patterns in the project will be published.
Command | Output details |
---|---|
--all boolean (optional) | If true, all composition patterns in the project will be published. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Unpublish composition pattern#
Unpublish given composition patterns.
- If a
ids
is specified, then the specific comma-separated composition patterns will be unpublished. - If "--all" param is specified instead - all composition patterns in the project will be unpublished.
Command | Output details |
---|---|
--all boolean (optional) | If true, all composition patterns in the project will be unpublished. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove composition pattern#
Delete a composition pattern from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update composition pattern#
Insert or update a composition pattern from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Composition pattern is set to this state after being updated.preview published - Using this option without first pushing the draft composition patterns will result in "orphan" composition patterns and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Category commands#
Get category#
Fetch a category from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List of categories#
List of categories from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull category#
Fetch all categories from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each category.
- If a file path is specified, all categories are saved in a single file.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push category#
Insert or update all categories from local disk to the Uniform project.
- If a directory path is specified, the categories in the files in the directory used.
- If a file path is specified, the categories in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove category#
Delete a category from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update category#
Insert or update a category from a local file to the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Content type commands#
note
The commands in this section require the package @uniformdev/canvas
.
Get content type#
Fetch a content type from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List content types#
List content types from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull content types#
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
orjson
is used, a package file will be created instead of files in the directory.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push content types#
Pushes all content types from files in a directory to Uniform
- If a directory path is specified, the content types that are defined in the files in the directory used.
- If a file path is specified, the content types in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove content type#
Delete a content type from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update content type#
Insert or update a content type from a local file to the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Entry commands#
Get entry#
Fetch an entry from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
--resolveData boolean (optional, default value: false) | Resolve all data resources used by the entry |
--resolutionDepth integer (optional, default value: 1) | Controls how many levels deep content references should be resolved. |
List entries#
List entries from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull entries#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push entries#
Insert or update all entries from local disk to the Uniform project.
- If a directory path is specified, the entries defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
--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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Publish entry#
Publishes given entry.
- If a entryId is specified, then the specific entry will be published.
- If "--all" param is specified instead - all entries in the project will be published.
Command | Output details |
---|---|
--all boolean (optional) | If true, all entries in the project will be published. Overrides "entryId" |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Unpublish entry#
Unpublishes given entry.
- If an entryId is specified, that specific entry will be unpublished.
- If "--all" param is specified instead - all entries in the project will be unpublished.
Command | Output details |
---|---|
--all boolean (optional) | If true, all entries in the project will be unpublished. Overrides "entryId". |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove entry#
Delete a entry definition from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update entry#
Insert or update a entry from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Entry is set to this state after being updated.preview published - Using this option without first pushing the draft entries will result in "orphan" entries and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Entry pattern commands#
note
Requires the @uniformdev/cli
package in version v19.146.2
or higher.
Get entry pattern#
Fetch a entry pattern from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
--state string (optional, choices: "preview", "published", default value: "preview") | Entry pattern state to fetch. |
List entry patterns#
List entry patterns from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull entry pattern#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push entry pattern#
Insert or update all entry patterns from local disk to the Uniform project.
- If a directory path is specified, the entry patterns defined in the files in the directory used.
- If a file path is specified, the entry patterns in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
--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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being 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#
Publishes given entry patterns.
- If a
ids
is specified, then the specific comma-separated entry patterns will be published. - If "--all" param is specified instead - all entry patterns in the project will be published.
Command | Output details |
---|---|
--all boolean (optional) | If true, all entry patterns in the project will be published. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Unpublish entry pattern#
Unpublish given entry patterns.
- If a
ids
is specified, then the specific comma-separated entry patterns will be unpublished. - If "--all" param is specified instead - all entry patterns in the project will be unpublished.
Command | Output details |
---|---|
--all boolean (optional) | If true, all entry patterns in the project will be unpublished. Overrides ids |
-w, --what-if | If true, reports what would be done but changes no files. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove entry pattern#
Delete a entry pattern from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update entry pattern#
Insert or update a entry pattern from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Entry pattern is set to this state after being updated.preview published - Using this option without first pushing the draft entry patterns will result in "orphan" entry patterns and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Data source commands#
Get data source#
Fetch a data source definition from the Uniform project. Because the data source may contain secrets, the value is only written to stdout.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove data source#
Delete a data source from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update data source#
Insert or update a data source using its JSON definition. The JSON can be fetched using the get
command.
example
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Data type commands#
Get data type#
Fetch a data type definition from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List data types#
List data type definitions from the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull data types#
Fetch all data type definitions from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each composition.
- If a file path is specified, all composition definitions are saved in a single file.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | 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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push data types#
note
Data sources referred to in your data types must be created manually before a push can succeed. Data sources cannot be serialized because they contain secrets.
Insert or update all data type definitions from local disk to the Uniform project.
- If a directory path is specified, the compositions defined in the files in the directory used.
- If a file path is specified, the components in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
--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 | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
info
it's important to understand the concept of composition state when using this command or else you might get unexpected results. See the --state
switch for more information.
Remove data types#
Delete a data type definition from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update data types#
Insert or update a data type definition from a local file to the Uniform project.
Command | Output details |
---|---|
--state string (default value: preview) | Data type is set to this state after being updated.preview published - Using this option without first pushing the draft compositions will result in "orphan" compositions and therefore isn't recommended. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Locale commands#
Pull locale#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push locale#
Insert or update all locales from local disk to the Uniform project.
- If a directory path is specified, the locales defined in the files in the directory used.
- If a file path is specified, the locales in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Prompt commands#
info
The commands in this section require the package @uniformdev/canvas
.
At present, built-in prompts cannot be serialized.
Get prompt#
Fetch a prompt from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List prompts#
List prompts in the Uniform project.
Command | Output details |
---|---|
--offset | Number of rows to skip before fetching. |
limit | Number of rows to fetch. |
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull prompt#
Fetch all custom prompts and disabled built-in prompts from the Uniform project and save them locally.
- If a directory path is specified, a separate file is created for each prompt.
- If a file path is specified, all custom prompts and disabled built-in prompts are saved in a single file.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push prompt#
Insert or update all custom prompts and disabled built-in prompts from local disk to the Uniform project.
- If a directory path is specified, the prompt defined in the files in the directory used.
- If a file path is specified, the prompt in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove prompt#
Delete a prompt from the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update prompt#
Insert or update a prompt from a local file to the Uniform project.
Command | Output details |
---|---|
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Preview URL commands#
Get preview URL#
Fetch a preview url from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List preview URLs#
List the preview URLs for the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull preview URL#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push preview URLs#
Pushes all preview urls from files in a directory to Uniform Canvas
- If a directory path is specified, the preview urls defined in the files in the directory used.
- If a file path is specified, the preview urls in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove preview URL#
Remove a preview URL from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update preview URL#
Insert or update a preview url from a local file to the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
!!!!!!
Preview viewport commands#
Get preview viewport#
Fetch a preview viewport from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
List preview viewports#
List the preview viewports for the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Pull preview viewports#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Push preview viewports#
Pushes all preview viewports from files in a directory to Uniform Canvas
- If a directory path is specified, the preview viewports defined in the files in the directory are used.
- If a file path is specified, the preview viewports in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Remove preview viewport#
Remove a preview viewport from the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Update preview viewport#
Insert or update a preview viewport from a local file to the Uniform project.
Command | Output details |
---|---|
-f, --format | Format for the output (YAML or JSON) |
-o, --filename | File name for the output. If not specified the output is written to stdout. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
Workflow commands#
Pull workflow#
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.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-f, --format | Format for the output (YAML or JSON) |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |
tip
If file name is specified, CLI will override only corresponding part of it (for example, pulling Project Map will only override project map section, but leave Canvas section in the same file intact). It allows you to create single file containing whole project export (Canvas + Context + Project Map). This isn't recommended for big projects. Learn about backing up to a single file.
Push workflow#
note
In order to push workflows to a project, you must ensure;
- The current token being used with the CLI has Team Admin permissions
- The team for the project to which the workflows are being pushed already has roles created with the same public IDs as those specified in the workflows being created.
Insert or update all worlflows from local disk to the Uniform project.
- If a directory path is specified, the workflows defined in the files in the directory used.
- If a file path is specified, the workflows in the file are used.
Command | Output details |
---|---|
-w, --what-if | If true, reports what would be done but changes no files. |
-m, --mode | Specifies what kind of changes can be made. |
-d, --diff | 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. |
-p, --project | Uniform project id. If not specified, the environment variable |
-f, --format | Uniform API key. If not specified, the environment variable |
--apiHost | Uniform host. If not specified, the environment variable |
--proxy | Proxy server. If not specified, the following environment variables are used (with the first match being used): |