> ## 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.

# Dub

> Short link management platform with analytics and API for creating, managing, and tracking branded short links

Short link management platform with analytics and API for creating, managing, and tracking branded short links

`dub` · **17 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth dub
run auth dub --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 dub          # common commands
run dub --all    # every command
```

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

## Common tools

| Tool                | What it does                                                                                                                                               |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `bulk-update-links` | Tool to update multiple short links in bulk. Use when you need to apply the same updates to multiple links at once by specifying link IDs or external IDs. |
| `create-domain`     | Tool to add a domain to a Dub workspace. Use when you need to create a new domain for shortening links.                                                    |
| `create-tag`        | Tool to create a new tag in Dub. Use when you need to organize links by creating custom tags.                                                              |
| `get-link-info`     | Tool to retrieve details of a specific short link from Dub. Use when you need to get comprehensive information about a link including its...               |
| `get-links`         | Tool to retrieve a paginated list of links for the authenticated workspace.                                                                                |
| `get-tags`          | Tool to retrieve a list of tags from Dub. Use when you need to fetch all tags or search for specific tags by name or IDs.                                  |
| `get-workspace`     | Tool to retrieve detailed information for a specific workspace.                                                                                            |
| `list-domains`      | Tool to retrieve a list of domains for the authenticated workspace.                                                                                        |
| `update-domain`     | Tool to update a domain configuration in Dub. Use when you need to modify domain settings like redirect URLs, placeholder text, archive status, or...      |
| `upsert-link`       | Tool to create or update a short link in Dub. Use when you need to create a new short link or update an existing one.                                      |

<Accordion title="All 17 tools" icon="list">
  | Tool                | What it does                                                                                                                                               |
  | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `bulk-delete-links` | Tool to delete multiple short links in bulk from Dub. Use when you need to remove multiple links at once.                                                  |
  | `bulk-update-links` | Tool to update multiple short links in bulk. Use when you need to apply the same updates to multiple links at once by specifying link IDs or external IDs. |
  | `create-domain`     | Tool to add a domain to a Dub workspace. Use when you need to create a new domain for shortening links.                                                    |
  | `create-tag`        | Tool to create a new tag in Dub. Use when you need to organize links by creating custom tags.                                                              |
  | `delete-domain`     | Tool to delete a domain from your Dub workspace. Use when you need to permanently remove a domain.                                                         |
  | `delete-tag`        | Tool to delete a tag from Dub. Use when you need to remove a tag that is no longer needed.                                                                 |
  | `get-link-info`     | Tool to retrieve details of a specific short link from Dub. Use when you need to get comprehensive information about a link including its...               |
  | `get-links`         | Tool to retrieve a paginated list of links for the authenticated workspace.                                                                                |
  | `get-links-count`   | Tool to retrieve the count of links in workspace with optional filters.                                                                                    |
  | `get-tags`          | Tool to retrieve a list of tags from Dub. Use when you need to fetch all tags or search for specific tags by name or IDs.                                  |
  | `get-workspace`     | Tool to retrieve detailed information for a specific workspace.                                                                                            |
  | `list-domains`      | Tool to retrieve a list of domains for the authenticated workspace.                                                                                        |
  | `track-open`        | Tool to track a deep link open event in Dub. Use when you need to record when a user opens your app via a deep link.                                       |
  | `update-domain`     | Tool to update a domain configuration in Dub. Use when you need to modify domain settings like redirect URLs, placeholder text, archive status, or...      |
  | `update-tag`        | Tool to update an existing tag by ID. Use when you need to change the name or color of a tag.                                                              |
  | `update-workspace`  | Tool to update workspace settings in Dub. Use when you need to modify workspace name, slug, logo, or conversion tracking settings.                         |
  | `upsert-link`       | Tool to create or update a short link in Dub. Use when you need to create a new short link or update an existing one.                                      |
</Accordion>

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