Skip to main content

Project Map

Digital Experience Composition (DXC) Catalyst Customers Only

This feature is currently only available through our Digital Experience Composition (DXC) Catalyst Customer Success program. If you're interested in joining this program, please reach out to your Uniform contact or email us at customer-success@uniform.dev.

Keep an eye on our social media and What's New page to be the first to know when this feature is generally available.

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

  • @uniformdev/cli
  • @uniformdev/project-map

Project Map commands

These commands should be added as a script command in your project, rather than run directly in the terminal. For example, in the package.json file of a next.js project:

"scripts": {
"uniform:fetch-map": "uniform project-map definition list"
},

Get project map

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

List project maps

uniform project-map definition list
command
List project map definitions from the Uniform project.
+ show options

Pull project map

uniform project-map definition pull <directory or file path>
command
Fetch all project map 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.
+ 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 project map

uniform project-map definition push <directory or file path>
command
Insert or update all project map 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.
+ show options

Remove project map

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

Update project map

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

Project Map Node commands

Get project map node

uniform project-map node get <id>
command
Fetch a project map node from the Uniform project.
+ show options

List project map nodes

uniform project-map node list
command
List project map nodes from the Uniform project.
+ show options

Pull project map node

uniform project-map node pull <directory or file path>
command
Fetch all project map nodes 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 nodes 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 project map node

uniform project-map node push <directory or file path>
command
Insert or update all project map nodes 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.
+ show options

Remove project map node

uniform project-map node remove <id>
command
Delete a project map node from the Uniform project.
+ show options

Update project map node

uniform project-map node update <filename>
command
Insert or update a project map node from a local file to the Uniform project.
+ show options