zigma

Zigma CLI

A design system creation platform that allows you to create, manage, document, share, and collaborate on design systems.

Quick Start

Note: Zigma CLI requires Node.js 18.17.x+ or later

You can choose the following ways to start the Zigma CLI.

Npx

npx zigma@latest

Global Installation

npm install -g zigma

Usage

Zigma CLI v0.0.17

Usage: zigma [command]

Options:
  -v, --version     Output the current version
  -h, --help        Display help for command

Commands:
  init [options]    Initializes a personal access token
  pull [options]    Pull the tokens and export them to the local file
  switch [options]  Switch the workspace or project
  disconnect        Disconnect the current PAT

Init

Initialize the Zigma CLI with your personal access token.

zigma init

Init Options

• -p --personal-access-token [string] Personal access token to authenticate with Zigma API.

Output:

? Enter your personal access token:
You can find this token by going to your account settings on: https://app.zigma.io ›

Pull

Pull the tokens and export them to the local file.

zigma pull

Pull Options

• -o --output [string] Set the output file path
• -w --watch Keep fetching the tokens and update the local file every 5 seconds (default: false)

Switch

Switch the workspace and project or only the project.

zigma switch

Switch Options

• -p --project [boolean] Only switch project (default: false)

Updating CLI Globally

npm update -g zigma

Use cases

• Pull the tokens from the Zigma API and export them to the local file.
• List available workspaces and projects

Documentation

Soon

Community

We're excited to see the community adopt zigma CLI, raise issues, and provide feedback. Whether it's a feature request, bug report, or a project to showcase, please get involved!

• Discord
• Twitter

License

MIT