Skip to main content

Context

The commands in this section are available when the following packages are installed:

  • @uniformdev/cli
  • @uniformdev/context

Aggregates​

Get aggregate​

uniform context aggregate get <id>
command
Fetch a aggregate definition from the Uniform project.
＋ show options

List aggregates​

uniform context aggregate list
command
List aggregate definitions from the Uniform project.
＋ show options

Pull aggregate​

uniform context aggregate pull <directory or file path>
command
Fetch all aggregate definitions from the Uniform project and save them locally.
  • If a directory path is specified, a separate file is created for each aggregate.
  • If a file path is specified, all aggregate definitions are saved in a single file.
＋ show options
tip

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 aggregate​

uniform context aggregate push <directory or file path>
command
Insert or update all aggregate definitions from local disk to the Uniform project.
  • If a directory path is specified, the aggregates defined in the files in the directory used.
  • If a file path is specified, the aggregates in the file are used.
＋ show options

Remove aggregate​

uniform context aggregate remove <id>
command
Delete a aggregate definition from the Uniform project.
＋ show options

Update aggregate​

uniform context aggregate update <filename>
command
Insert or update a aggregate definition from a local file to the Uniform project.
＋ show options

Enrichments​

Get enrichment​

uniform context enrichment get <id>
command
Fetch a enrichment definition from the Uniform project.
＋ show options

List enrichments​

uniform context enrichment list
command
List enrichment definitions from the Uniform project.
＋ show options

Pull enrichment​

uniform context enrichment pull <directory or file path>
command
Fetch all enrichment definitions from the Uniform project and save them locally.
  • If a directory path is specified, a separate file is created for each enrichment.
  • If a file path is specified, all enrichment definitions are saved in a single file.
＋ show options
tip

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 enrichment​

uniform context enrichment push <directory or file path>
command
Insert or update all enrichment definitions from local disk to the Uniform project.
  • If a directory path is specified, the enrichments defined in the files in the directory used.
  • If a file path is specified, the enrichments in the file are used.
＋ show options

Remove enrichment​

uniform context enrichment remove <id>
command
Delete a enrichment definition from the Uniform project.
＋ show options

Update enrichment​

uniform context enrichment update <filename>
command
Insert or update a enrichment definition from a local file to the Uniform project.
＋ show options

Manifests​

Get manifest​

uniform context manifest get <filename>
command
Fetch the manifest for the Uniform project.
＋ show options

Publish manifest​

uniform context manifest publish
command
Publish the manifest for the Uniform project.
＋ show options

Quirks​

Get quirk​

uniform context quirk get <id>
command
Fetch a quirk definition from the Uniform project.
＋ show options

List quirks​

uniform context quirk list
command
List quirk definitions from the Uniform project.
＋ show options

Pull quirk​

uniform context quirk pull <directory or file path>
command
Fetch all quirk definitions from the Uniform project and save them locally.
  • If a directory path is specified, a separate file is created for each quirk.
  • If a file path is specified, all quirk definitions are saved in a single file.
＋ show options
tip

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 quirk​

uniform context quirk push <directory or file path>
command
Insert or update all quirk definitions from local disk to the Uniform project.
  • If a directory path is specified, the quirks defined in the files in the directory used.
  • If a file path is specified, the quirks in the file are used.
＋ show options

Remove quirk​

uniform context quirk remove <id>
command
Delete a quirk definition from the Uniform project.
＋ show options

Update quirk​

uniform context quirk update <filename>
command
Insert or update a quirk definition from a local file to the Uniform project.
＋ show options

Signals​

Get signal​

uniform context signal get <id>
command
Fetch a signal definition from the Uniform project.
＋ show options

List signals​

uniform context signal list
command
List signal definitions from the Uniform project.
＋ show options

Pull signal​

uniform context signal pull <directory or file path>
command
Fetch all signal definitions from the Uniform project and save them locally.
  • If a directory path is specified, a separate file is created for each signal.
  • If a file path is specified, all signal definitions are saved in a single file.
＋ show options
tip

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 signal​

uniform context signal push <directory or file path>
command
Insert or update all signal definitions from local disk to the Uniform project.
  • If a directory path is specified, the signals defined in the files in the directory used.
  • If a file path is specified, the signals in the file are used.
＋ show options

Remove signal​

uniform context signal remove <id>
command
Delete a signal definition from the Uniform project.
＋ show options

Update signal​

uniform context signal update <filename>
command
Insert or update a signal definition from a local file to the Uniform project.
＋ show options

Tests​

Get test​

uniform context test get <id>
command
Fetch a test definition from the Uniform project.
＋ show options

List tests​

uniform context test list
command
List test definitions from the Uniform project.
＋ show options

Pull test​

uniform context test pull <directory or file path>
command
Fetch all test definitions from the Uniform project and save them locally.
  • If a directory path is specified, a separate file is created for each test.
  • If a file path is specified, all test definitions are saved in a single file.
＋ show options
tip

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 test​

uniform context test push <directory or file path>
command
Insert or update all test definitions from local disk to the Uniform project.
  • If a directory path is specified, the tests defined in the files in the directory used.
  • If a file path is specified, the tests in the file are used.
＋ show options

Remove test​

uniform context test remove <id>
command
Delete a test definition from the Uniform project.
＋ show options

Update test​

uniform context test update <filename>
command
Insert or update a test definition from a local file to the Uniform project.
＋ show options