> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Zeplin

> Zeplin is a design delivery platform that connects designers and developers, enabling access to design resources like projects, screens, components, and assets

Zeplin is a design delivery platform that connects designers and developers, enabling access to design resources like projects, screens, components, and assets.

`zeplin` · **24 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth zeplin
run auth zeplin --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run zeplin          # common commands
run zeplin --all    # every command
```

```ts theme={"theme":"github-dark"}
import { zeplin } from "@boxd/run";
```

## Common tools

| Tool                           | What it does                                                                                                                                                        |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `auth-o-auth-authorize`        | Tool to start OAuth 2.0 authorization code flow for Zeplin apps.                                                                                                    |
| `project-colors-list`          | Tool to list colors in a Zeplin project. Use when you need to fetch defined color tokens at the project level after obtaining the project ID.                       |
| `project-color-update`         | Tool to update a color in a Zeplin project. Use when you need to modify RGBA channels or source ID of an existing color after confirming the project and color IDs. |
| `projects-get`                 | Tool to get a Zeplin project by ID. Use when you need detailed info about a specific project after confirming its project\_id.                                      |
| `projects-members-invite`      | Tool to invite a user to a Zeplin project. Use when you need to add a member by email or username to a project after obtaining the project ID.                      |
| `project-text-styles-list`     | Tool to list text styles in a Zeplin project. Use when you need to fetch typography tokens defined at the project level after obtaining the project ID.             |
| `project-text-style-update`    | Tool to update a text style in a Zeplin project. Use when you need to modify typography settings of an existing text style after confirming the...                  |
| `screen-annotation-delete`     | Tool to delete a screen annotation in Zeplin. Use when you need to remove a specific annotation from a Zeplin screen given its IDs.                                 |
| `screen-annotation-get`        | Tool to fetch a single screen annotation. Use when you know the screen\_id and annotation\_id and need the detailed annotation data.                                |
| `screen-annotations-list`      | Tool to list annotations for a Zeplin screen. Use when you have the screen\_id and need its annotations.                                                            |
| `screen-annotations-update`    | Tool to update a screen annotation's content, position, or type.                                                                                                    |
| `screen-components-list`       | Tool to list components in a Zeplin screen. Use when you have the screen\_id and need to retrieve UI components in a specific screen.                               |
| `screen-section-get`           | Tool to get a single screen section. Use when you need to fetch detailed information of a screen section by its ID after confirming the project and section IDs.    |
| `screen-sections-list`         | Tool to list screen sections in a Zeplin project. Use when you need a paginated list of screen sections after confirming the project ID.                            |
| `screen-version-get`           | Tool to retrieve a specific screen version. Use after specifying both screen\_id and version\_id when you need detailed snapshot metadata.                          |
| `screen-versions-create`       | Tool to create a new version of a screen. Use when uploading a new design snapshot (PNG or JPEG image) as a screen version.                                         |
| `screen-versions-list`         | Tool to list all versions of a screen. Use when you need to enumerate past screen snapshots after obtaining a screen ID.                                            |
| `styleguide-color-create`      | Tool to create a new styleguide color. Use after obtaining the styleguide ID to define custom color tokens.                                                         |
| `styleguide-colors-list`       | Tool to list colors in a Zeplin styleguide. Use when you need to fetch defined color tokens after obtaining the styleguide ID.                                      |
| `styleguide-color-update`      | Tool to update a color in a Zeplin styleguide. Use after obtaining the styleguide and color IDs.                                                                    |
| `styleguide-text-styles-list`  | Tool to list text styles in a Zeplin styleguide. Use when you need to fetch defined typography tokens after obtaining the styleguide ID.                            |
| `styleguide-text-style-update` | Tool to update a text style in a Zeplin styleguide. Use when you need to modify typography settings of an existing text style after confirming the...               |
| `users-get-personal-projects`  | Tool to list personal projects. Use when you need to fetch all projects in the current user's personal workspace after authentication.                              |

<Accordion title="All 24 tools" icon="list">
  | Tool                                | What it does                                                                                                                                                        |
  | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `auth-o-auth-authorize`             | Tool to start OAuth 2.0 authorization code flow for Zeplin apps.                                                                                                    |
  | `connected-components-project-list` | Tool to list connected components in a Zeplin project. Use when you have the project\_id and need to retrieve connected components in a specific project.           |
  | `project-colors-list`               | Tool to list colors in a Zeplin project. Use when you need to fetch defined color tokens at the project level after obtaining the project ID.                       |
  | `project-color-update`              | Tool to update a color in a Zeplin project. Use when you need to modify RGBA channels or source ID of an existing color after confirming the project and color IDs. |
  | `projects-get`                      | Tool to get a Zeplin project by ID. Use when you need detailed info about a specific project after confirming its project\_id.                                      |
  | `projects-members-invite`           | Tool to invite a user to a Zeplin project. Use when you need to add a member by email or username to a project after obtaining the project ID.                      |
  | `project-text-styles-list`          | Tool to list text styles in a Zeplin project. Use when you need to fetch typography tokens defined at the project level after obtaining the project ID.             |
  | `project-text-style-update`         | Tool to update a text style in a Zeplin project. Use when you need to modify typography settings of an existing text style after confirming the...                  |
  | `screen-annotation-delete`          | Tool to delete a screen annotation in Zeplin. Use when you need to remove a specific annotation from a Zeplin screen given its IDs.                                 |
  | `screen-annotation-get`             | Tool to fetch a single screen annotation. Use when you know the screen\_id and annotation\_id and need the detailed annotation data.                                |
  | `screen-annotations-list`           | Tool to list annotations for a Zeplin screen. Use when you have the screen\_id and need its annotations.                                                            |
  | `screen-annotations-update`         | Tool to update a screen annotation's content, position, or type.                                                                                                    |
  | `screen-components-list`            | Tool to list components in a Zeplin screen. Use when you have the screen\_id and need to retrieve UI components in a specific screen.                               |
  | `screen-section-get`                | Tool to get a single screen section. Use when you need to fetch detailed information of a screen section by its ID after confirming the project and section IDs.    |
  | `screen-sections-list`              | Tool to list screen sections in a Zeplin project. Use when you need a paginated list of screen sections after confirming the project ID.                            |
  | `screen-version-get`                | Tool to retrieve a specific screen version. Use after specifying both screen\_id and version\_id when you need detailed snapshot metadata.                          |
  | `screen-versions-create`            | Tool to create a new version of a screen. Use when uploading a new design snapshot (PNG or JPEG image) as a screen version.                                         |
  | `screen-versions-list`              | Tool to list all versions of a screen. Use when you need to enumerate past screen snapshots after obtaining a screen ID.                                            |
  | `styleguide-color-create`           | Tool to create a new styleguide color. Use after obtaining the styleguide ID to define custom color tokens.                                                         |
  | `styleguide-colors-list`            | Tool to list colors in a Zeplin styleguide. Use when you need to fetch defined color tokens after obtaining the styleguide ID.                                      |
  | `styleguide-color-update`           | Tool to update a color in a Zeplin styleguide. Use after obtaining the styleguide and color IDs.                                                                    |
  | `styleguide-text-styles-list`       | Tool to list text styles in a Zeplin styleguide. Use when you need to fetch defined typography tokens after obtaining the styleguide ID.                            |
  | `styleguide-text-style-update`      | Tool to update a text style in a Zeplin styleguide. Use when you need to modify typography settings of an existing text style after confirming the...               |
  | `users-get-personal-projects`       | Tool to list personal projects. Use when you need to fetch all projects in the current user's personal workspace after authentication.                              |
</Accordion>

[Open Zeplin in the console →](https://app.boxd.sh/integrations/detail/zeplin)