Describe workspaces

List all information about workspaces you have access to.

Using the Supernova CLI utility, you can get structure of all workspaces including all their design systems, brands and themes. This is very useful for getting a high-level overview of what is available and currently set up across all of your workspaces when you are configuring the Tokens Studio plugin mapping.


Use the following command to list all workspaces, design systems, brands and themes that are available under the provided API key:

                                                            $ supernova describe-workspaces \

Once you've run the command, you'll obtain the entire structure of your workspaces, similar to this:

                                                            ↳  Workspace "Dark Matter", handle: "dark-matter":
                                                          ↳  Design system "Dark Matter", id: 123
                                                            ↳  Brand "Default", id: 59eecf09-3641-46e3-82cb-1d82a0a01bc8
                                                              ↳ Theme "Dark", id: d21a33e2-2105-493c-852e-a2c0a443a959
                                                              ↳ Theme "Grayscale", id: d21a33e2-2105-493c-852e-a2c0a443a900

You can use the data to help you configure your Tokens Studio sync behaviors.