Skip to main content

Canvas

The commands in this section are available when the package @uniformdev/canvas is installed.

Component commands

Get component

- undefined
uniform canvas component get <id>
command
Fetch a component definition from the Uniform project.
+ show options

List components

- undefined
uniform canvas component list
command
List component definitions from the Uniform project.
+ show options

Pull component

- undefined
uniform canvas component pull <directory>
command
Fetch all component definitions from the Uniform project and save them to files in a local directory.
+ show options

Push component

- undefined
uniform canvas component push <directory>
command
insert or update all component definitions from files in a local directory to the Uniform project.
+ show options

Remove component

- undefined
uniform canvas component remove <id>
command
Delete a component definition from the Uniform project.
+ show options

Update component

- undefined
uniform canvas component update <filename>
command
Insert or update a component definition from a local file to the Uniform project.
+ show options

Composition commands

Get composition

- undefined
uniform canvas composition get <id>
command
Fetch a composition definition from the Uniform project.
+ show options

List compositions

- undefined
uniform canvas composition list
command
List composition definitions from the Uniform project.
+ show options

Pull composition

- undefined
uniform canvas composition pull <directory>
command
Fetch all composition definitions from the Uniform project and save them to files in a local directory.
+ show options

Push composition

- undefined
uniform canvas composition push <directory>
command
insert or update all composition definitions from files in a local directory to the Uniform project.
+ show options

Remove composition

- undefined
uniform canvas composition remove <id>
command
Delete a composition definition from the Uniform project.
+ show options

Update composition

- undefined
uniform canvas composition update <filename>
command
Insert or update a composition definition from a local file to the Uniform project.
+ show options