Getting Started

Welcome to Servly — the open standard for syncing design systems between tools and code.

Prerequisites

• Node.js 18+
• A package manager (npm, pnpm, or yarn)

Quick Install

npm install @servly/cli

Your First Scan

Run servly scan in any project to analyze your existing design tokens and components:

servly scan

Servly will detect your framework, locate your design tokens, and create a component manifest.

Distribute

Once scanned, distribute your components to any supported framework:

servly distribute --framework react

Next Steps

• Read the CIF Spec to understand the Component Interchange Format
• Explore the CLI reference for all available commands
• Follow a framework guide for React or build your own adapter