Canvas
The commands in this section are available when the following packages are installed:
@uniformdev/cli
@uniformdev/canvas
Component commands
Get component
uniform canvas component get <id>
List components
uniform canvas component list
Pull component
uniform canvas component pull <directory or file path>
- 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.
If file name is specified, CLI will override only corresponding part of it (e.g. 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). Not recommended for big projects. Check for more here
Push component
uniform canvas component push <directory or file path>
- 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.
Remove component
uniform canvas component remove <id>
Update component
uniform canvas component update <filename>
Composition commands
Get composition
uniform canvas composition get <id>
List compositions
uniform canvas composition list
Pull composition
uniform canvas composition pull <directory or file path>
- 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.
If file name is specified, CLI will override only corresponding part of it (e.g. 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). Not recommended for big projects. Check for more here
Push composition
uniform canvas composition push <directory or file path>
- 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.
It is 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 composition
uniform canvas composition remove <id>
Update composition
uniform canvas composition update <filename>