Specify Docs
Specify ↗︎Changelog ↗︎Guide ↗︎
V1
V1
  • Getting started
    • Introduction
    • What is Specify?
    • Getting started
    • Glossary
  • Advanced Repository
    • Getting started
    • Figma Variables & Styles
    • Tokens Studio
    • CLI & Config
    • Querying a SDTF graph
    • GitHub
    • Parsers
      • to-css-custom-properties
      • to-style-dictionary
      • to-tailwind
      • to-sdtf
      • to-javascript
      • to-react-native
      • to-json
      • to-typescript
      • filter
      • select-modes
      • change-case
      • convert-color
      • convert-dimension
    • Templates
      • CSS Custom Properties
      • SDTF
      • Tailwind
    • REST API
    • Playground
  • Concepts
    • Token types
    • Configuration
    • Parsers
    • Templates
    • Best practices
  • Apps & Tools
    • Overview
    • GitHub
    • npm
    • GitLab
    • Bitbucket
    • Azure DevOps
    • REST API
    • CLI
    • Notion
    • Raycast
  • Useful links
    • Discord
    • YouTube
    • Twitter
    • Help Center
Powered by GitBook
On this page
  • Introduction
  • Installation
  • Commands
  • Init
  • Pull
  • Sync
  • Flags

Was this helpful?

Edit on GitHub
Export as PDF
  1. Apps & Tools

CLI

The Specify CLI helps you pull design tokens and assets from Specify right from your terminal.

PreviousREST APINextNotion

Last updated 1 year ago

Was this helpful?

Introduction

Use the Specify CLI to integrate Specify in your workflow.

You can use the Specify CLI to:

  • Pull your design tokens in the right format using parsers

  • Test your configuration before using it in a GitHub repository

  • Sync a Specify repository

Installation

Install @specifyapp/cli via npm or Yarn.

npm install -g @specifyapp/cli
yarn global add @specifyapp/cli

Commands

Init

specify init

Pull

Pull design tokens and assets from your Specify repository.

specify pull [flags]

Sync

Sync a Specify repository to update its design tokens and assets.

specify sync [flags]

Flags

Flags are parameters you can pass while launching the command. All of these parameters are optional if you use a config file.

-C, --config-path

Relative path to your Specify config file.

-r, --repository

The name of the Specify repository you want to pull your design tokens and assets from.

-p, --personal-access-token

The Specify Personal Access Token used to authenticate your actions.

-R, --rules

Rules Specify will follow to generate design tokens and assets in your desired output format.

--dry-run

Execute command without actually writing files. Use this flag to test the output of a configuration without generating files.

Initialize a Specify configuration tailored for a specific output format. .

Need a personal access token?

See all configuration templates
Generate one ↗