CLI Quickstart

Get up and running with the Handoff CLI in just a few minutes with our step-by-step installation and setup guide. Learn how to initialize your first project, connect to Figma, and fetch your design foundations with a single command. The CLI is your local gateway to a faster, more automated design system workflow.

The Handoff CLI is your primary local tool for managing the design system pipeline. This guide will take you from installation to a fully running project in less than five minutes.

Step 1: Install the CLI

Install the handoff-app package globally using npm to get access to all Handoff commands from your terminal.

example.sh
bash
1npm install -g handoff-app

Step 2: Initialize Your Project

Run the init command to scaffold a new Handoff project. You will be guided through an interactive setup process to configure your project's basic settings.

example.sh
bash
1handoff-app init

Step 3: Connect to Figma

Set your Figma project ID and personal access token in your project's configuration or through environment variables. This connection allows Handoff to fetch your latest design styles directly from the source.

Step 4: Fetch Design Tokens

Use the fetch command to extract all tokens and component metadata from your Figma library. This data is the foundation for your documentation and all technical integrations.

example.sh
bash
1npm run fetch

Step 5: Start the Documentation Application

Launch the local development server to view your generated documentation and live component previews in real-time.

example.sh
bash
1npm run start

Next Steps