# @zeplin/cli > Zeplin CLI Latest version **2.1.1** (published 2025-06-13) · MIT license · 0 weekly downloads ## Install ```sh npm install @zeplin/cli pnpm add @zeplin/cli yarn add @zeplin/cli bun add @zeplin/cli ``` Provides the command `zeplin`. ## Health **Score 35/100 (D)** — status: maintenance-mode. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.1.1 | | Published | 2025-06-13 | | First published | 2019-11-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 35 | | Unpacked size | 257.2 KB | | Known vulnerabilities | 0 (+2 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 32 | | Maintainers | ceylanismail, merih, zeplin-npm, berkcebi | ## Links - npm: https://www.npmjs.com/package/@zeplin/cli - Repository: https://github.com/zeplin/cli - Homepage: https://github.com/zeplin/cli#readme - Issues: https://github.com/zeplin/cli/issues - npm.io page: https://npm.io/package/@zeplin/cli ## Dependencies (35) - [ini](https://npm.io/package/ini.md) 5.0.0 - [ora](https://npm.io/package/ora.md) ^5.1.0 - [open](https://npm.io/package/open.md) ^7.3.0 - [axios](https://npm.io/package/axios.md) ^1.7.9 - [chalk](https://npm.io/package/chalk.md) ^3.0.0 - [execa](https://npm.io/package/execa.md) ^5.0.0 - [semver](https://npm.io/package/semver.md) ^5.7.1 - [ci-info](https://npm.io/package/ci-info.md) ^2.0.0 - [express](https://npm.io/package/express.md) ^4.17.1 - [winston](https://npm.io/package/winston.md) ^3.2.1 - [chokidar](https://npm.io/package/chokidar.md) ^3.3.1 - [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0 - [has-yarn](https://npm.io/package/has-yarn.md) ^2.1.0 - [inquirer](https://npm.io/package/inquirer.md) ^7.0.0 - [url-join](https://npm.io/package/url-join.md) ^4.0.1 - [@hapi/joi](https://npm.io/package/@hapi/joi.md) ^17.1.1 - [commander](https://npm.io/package/commander.md) ^6.2.0 - [mask-json](https://npm.io/package/mask-json.md) ^1.0.3 - [ts-dedent](https://npm.io/package/ts-dedent.md) ^1.1.0 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^6.0.0 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^7.0.0 - [import-from](https://npm.io/package/import-from.md) ^3.0.0 - [import-local](https://npm.io/package/import-local.md) ^3.0.2 - [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.2 - [git-url-parse](https://npm.io/package/git-url-parse.md) ^13.1.0 - [is-yarn-global](https://npm.io/package/is-yarn-global.md) ^0.3.0 - [latest-version](https://npm.io/package/latest-version.md) ^5.1.0 - [strip-comments](https://npm.io/package/strip-comments.md) ^2.0.1 - [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0 - [http-status-codes](https://npm.io/package/http-status-codes.md) ^1.4.0 - [inquirer-fuzzy-path](https://npm.io/package/inquirer-fuzzy-path.md) ^2.3.0 - [inquirer-search-list](https://npm.io/package/inquirer-search-list.md) ^1.2.6 - [is-installed-globally](https://npm.io/package/is-installed-globally.md) ^0.3.2 - [detect-package-manager](https://npm.io/package/detect-package-manager.md) ^3.0.1 - [inquirer-search-checkbox](https://npm.io/package/inquirer-search-checkbox.md) ^1.0.0 ## Recent versions - 2.1.1 (latest) — 2025-06-13 - 2.1.0 — 2025-06-03 - 2.0.2 — 2024-03-15 - 2.0.1 — 2022-10-05 - 2.0.0 — 2022-02-24 - 1.1.13 — 2021-11-17 - 1.1.12 — 2021-06-03 - 1.1.11 — 2021-04-20 - 1.1.10 — 2021-04-08 - 1.1.9 — 2021-04-06 - 1.1.8 — 2021-04-05 - 1.1.7 — 2021-04-05 - 1.1.6 — 2021-02-19 - 1.1.5 — 2021-02-08 - 1.1.4 — 2021-02-05 - … 35 more at https://npm.io/package/@zeplin/cli/versions ## README # Zeplin CLI Command-line interface for Zeplin ## Installation Install Zeplin CLI using npm. ```sh npm install -g @zeplin/cli ``` ## Usage ### Connected Components [Connected Components](https://zpl.io/connected-components) in Zeplin lets you access components in your codebase directly on designs in Zeplin, with links to Storybook, GitHub and any other source of documentation based on your workflow. 🧩 CLI `connect` command uses plugins to analyze component source code and publishes a high-level overview to be displayed in Zeplin. You can either publish changes to your components manually, or better yet, you can always keep them in sync by running the CLI as a step in your CI workflow. Make sure that you created a configuration file (`.zeplin/components.json`) following [Connected Components documentation](https://github.com/zeplin/connected-components-docs) and run the `connect` command: ```sh zeplin connect [options] ``` | Options | Description | Default | |--------------|---------------------------------------------------|-------------------------| | -f, --file | Path to components configuration file | .zeplin/components.json | | -d, --dev | Activate development mode | false | | --no-watch | Disable watching file changes on development mode | false | | -p, --plugin | npm package name of a Zeplin CLI `connect` plugin | | | -h, --help | Output usage information | | | --verbose | Enable verbose logs | | ## Plugins Zeplin CLI commands are extensible using plugins. See [PLUGIN.md](./PLUGIN.md) to build your own plugin. ### Connected Components `connect` command uses plugins to analyze component source code. Plugins generate component descriptions, code snippets and links for each component. #### Available plugins | npm package name | Description | |------------------------------------------------------------------------------------------------|---------------------------------------------------| | [@zeplin/cli-connect-react-plugin](https://github.com/zeplin/cli-connect-react-plugin) | Generates snippets from React components | | [@zeplin/cli-connect-angular-plugin](https://github.com/zeplin/cli-connect-angular-plugin) | Generate snippets from Angular components | | [@zeplin/cli-connect-swift-plugin](https://github.com/zeplin/cli-connect-swift-plugin) | Generates snippets from iOS, macOS views in Swift | | [@zeplin/cli-connect-storybook-plugin](https://github.com/zeplin/cli-connect-storybook-plugin) | Generates Storybook links of components | #### Usage Install a `connect` plugin using npm. ```sh npm install -g @zeplin/cli-connect-react-plugin ``` Execute `connect` command using the plugin. ```sh zeplin connect -p @zeplin/cli-connect-react-plugin ``` You can also provide a list of plugins via the `plugins` parameter of the [components configuration file](./docs/cli.componentconfigfile.plugins.md), where it's possible to pass custom parameters to plugins. ### Usage with access token Zeplin CLI can authenticate using an access token instead of your Zeplin credentials which makes it easier to integrate it into your CI workflow. 1. Get a CLI access token from your [Profile](https://app.zeplin.io/profile/connected-apps) in Zeplin. 2. Set `ZEPLIN_ACCESS_TOKEN` environment variable in your CI. ## Contributing and Issue Tracking See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. --- _Source: https://npm.io/package/@zeplin/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._