# @design-sync/cli

> CLI for Design Sync

Latest version **0.11.3** (published 2024-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @design-sync/cli
pnpm add @design-sync/cli
yarn add @design-sync/cli
bun add @design-sync/cli
```

Provides the command `design-sync`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.11.3 |
| Published | 2024-06-06 |
| First published | 2023-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 23.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Maintainers | salamaashoush |

## Links

- npm: https://www.npmjs.com/package/@design-sync/cli
- Repository: https://github.com/salamaashoush/design-sync
- Homepage: https://github.com/salamaashoush/design-sync#readme
- Issues: https://github.com/salamaashoush/design-sync/issues
- npm.io page: https://npm.io/package/@design-sync/cli

## Dependencies (5)

- [nypm](https://npm.io/package/nypm.md) ^0.3.8
- [citty](https://npm.io/package/citty.md) ^0.1.6
- [@design-sync/utils](https://npm.io/package/@design-sync/utils.md) 0.5.1
- [@design-sync/manager](https://npm.io/package/@design-sync/manager.md) 0.6.3
- [@design-sync/w3c-dtfm](https://npm.io/package/@design-sync/w3c-dtfm.md) 0.11.2

## Recent versions

- 0.11.3 (latest) — 2024-06-06
- 0.11.2 — 2024-06-06
- 0.11.1 — 2023-12-15
- 0.11.0 — 2023-12-15
- 0.10.0 — 2023-12-15
- 0.9.2 — 2023-11-30
- 0.9.1 — 2023-11-29
- 0.9.0 — 2023-11-29
- 0.8.1 — 2023-11-28
- 0.8.0 — 2023-11-28
- 0.7.2 — 2023-11-27
- 0.7.1 — 2023-11-27
- 0.7.0 — 2023-11-27
- 0.6.0 — 2023-11-22
- 0.5.0 — 2023-11-22
- … 2 more at https://npm.io/package/@design-sync/cli/versions

## README

# @design-sync/cli

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
<!-- [![bundle][bundle-src]][bundle-href]
[![Codecov][codecov-src]][codecov-href] -->

Design Sync CLI

## Usage

Initialize and install packages

```sh
# npm
npx @design-sync/cli init
```

follow the prompt to create a `design-sync.config` file or pass `-y` to skip the prompt and use the default values.

Sync:

add a `sync` script to your `package.json` file

```json
{
  "scripts": {
    "sync": "design-sync sync"
  }
}
```

then run

```sh
<npm|pnpm|yarn|bun> run sync
```

## Configuration

The configuration file is a `design-sync.config.ts` file in the root of your project.

- `uri`: (string) the uri of a git repository to download the design tokens from, eg `gh:owner/repo/path/to/file/or/folder#branch` supports `github`, `gitlab`, `sourcehut` and `bitbucket` see [giget](https://github.com/unjs/giget) for more info.
- `auth`: (string) Custom Authorization token to use for downloading tokens. (Can be overridden with `GIGET_AUTH` environment variable).
- `out`: (string) the output directory for the generated files
- `plugins`: (array) plugins to use, see [plugins](#plugins) for more info
- `schemaExtensions` (array)- schema extensions to use, see [schema extensions](#schema-extensions) for more info
- `prettify`: (boolean) format the generated files using `prettier`, default: `false`
- `filter`: (TokensWalkerFilter) filter tokens to process, default: all supported token types
- `requiredModes`: (array) required modes, default: `[]`
- `defaultMode`: (string) default mode, default: `default`
- `disableDefaultExtensions`: (boolean) disable default schema extensions, default: `false`

## Plugins

- [css-plugin](../../packages/css-plugin/README.md)
- [json-plugin](../../packages/json-plugin/README.md)
- [vanilla-extract-plugin](../../packages/vanilla-extract-plugin/README.md)

## Schema Extensions

- Modes -> allow you to override tokens per mode (dark, light, etc) and generate a theme for each mode, enabled by default.
- Color Modifiers -> allow you to modify colors using common color modifiers like lighten, darken, saturate, etc, enabled by default.
- Color Generators  -> allow you to generate more colors dynamically using color modifiers, enabled by default.

## Development

- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`

## License

Made with 💛

Published under [MIT License](./LICENSE).

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@design-sync/cli?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/@design-sync/cli
[npm-downloads-src]: https://img.shields.io/npm/dm/@design-sync/cli?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/@design-sync/cli
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/unjs/@design-sync/cli/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/unjs/@design-sync/cli
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@design-sync/cli?style=flat&colorA=18181B&colorB=F0DB4F
[bundle-href]: https://bundlephobia.com/result?p=@design-sync/cli -->

---
_Source: https://npm.io/package/@design-sync/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._