{"id":13343892,"url":"https://github.com/zeplin/cli","last_synced_at":"2025-04-06T09:11:13.418Z","repository":{"id":38426848,"uuid":"207431570","full_name":"zeplin/cli","owner":"zeplin","description":"Command-line interface for Zeplin","archived":false,"fork":false,"pushed_at":"2024-12-24T06:31:07.000Z","size":1369,"stargazers_count":31,"open_issues_count":8,"forks_count":8,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-03-30T08:08:36.136Z","etag":null,"topics":["zeplin","zeplin-cli"],"latest_commit_sha":null,"homepage":"https://zeplin.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeplin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-10T00:42:08.000Z","updated_at":"2024-12-24T06:31:09.000Z","dependencies_parsed_at":"2024-10-24T07:03:44.699Z","dependency_job_id":"185ccd61-fcd2-4e8c-b9bf-e5d1c7c04e3d","html_url":"https://github.com/zeplin/cli","commit_stats":{"total_commits":344,"total_committers":9,"mean_commits":38.22222222222222,"dds":"0.47965116279069764","last_synced_commit":"9b45af80fb740d349273707bbbf3b047c4f63a50"},"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeplin","download_url":"https://codeload.github.com/zeplin/cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247457803,"owners_count":20941906,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zeplin","zeplin-cli"],"created_at":"2024-07-29T19:32:05.108Z","updated_at":"2025-04-06T09:11:13.394Z","avatar_url":"https://github.com/zeplin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zeplin CLI\n\nCommand-line interface for Zeplin\n\n## Installation\n\nInstall Zeplin CLI using npm.\n\n```sh\nnpm install -g @zeplin/cli\n```\n\n## Usage\n\n### Connected Components\n\n[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. 🧩\n\nCLI `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.\n\nMake 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:\n\n```sh\nzeplin connect [options]\n```\n\n| Options      | Description                                       | Default                 |\n|--------------|---------------------------------------------------|-------------------------|\n| -f, --file   | Path to components configuration file             | .zeplin/components.json |\n| -d, --dev    | Activate development mode                         | false                   |\n| --no-watch   | Disable watching file changes on development mode | false                   |\n| -p, --plugin | npm package name of a Zeplin CLI `connect` plugin |                         |\n| -h, --help   | Output usage information                          |                         |\n| --verbose    | Enable verbose logs                               |                         |\n\n## Plugins\n\nZeplin CLI commands are extensible using plugins. See [PLUGIN.md](./PLUGIN.md) to build your own plugin.\n\n### Connected Components\n\n`connect` command uses plugins to analyze component source code. Plugins generate component descriptions, code snippets and links for each component.\n\n#### Available plugins\n\n| npm package name                                                                               | Description                                       |\n|------------------------------------------------------------------------------------------------|---------------------------------------------------|\n| [@zeplin/cli-connect-react-plugin](https://github.com/zeplin/cli-connect-react-plugin)         | Generates snippets from React components          |\n| [@zeplin/cli-connect-angular-plugin](https://github.com/zeplin/cli-connect-angular-plugin)     | Generate snippets from Angular components         |\n| [@zeplin/cli-connect-swift-plugin](https://github.com/zeplin/cli-connect-swift-plugin)         | Generates snippets from iOS, macOS views in Swift |\n| [@zeplin/cli-connect-storybook-plugin](https://github.com/zeplin/cli-connect-storybook-plugin) | Generates Storybook links of components           |\n\n#### Usage\n\nInstall a `connect` plugin using npm.\n\n```sh\nnpm install -g @zeplin/cli-connect-react-plugin\n```\n\nExecute `connect` command using the plugin.\n\n```sh\nzeplin connect -p @zeplin/cli-connect-react-plugin\n```\n\nYou 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.\n\n### Usage with access token\n\nZeplin CLI can authenticate using an access token instead of your Zeplin credentials which makes it easier to integrate it into your CI workflow.\n\n1. Get a CLI access token from your [Profile](https://app.zeplin.io/profile/connected-apps) in Zeplin.\n2. Set `ZEPLIN_ACCESS_TOKEN` environment variable in your CI.\n\n## Contributing and Issue Tracking\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeplin%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli/lists"}