# Pins

A pin is your own shortcut to a ticket, project, product, environment or team, listed in the website's sidebar in your order.

A pin is your own shortcut to a ticket, project, product, environment or team. The website's
sidebar lists your pins under **Pinned**, in your order, and only you see them. A clanker you work
with changes your pins too, such as pinning the ticket it is working on. A change shows at once in
every website tab you have open.

## What a pin names

A pin names what it points at by kind and key: the key is what the thing's pages use.

| Kind          | Key                                     | Example       |
| ------------- | --------------------------------------- | ------------- |
| `ticket`      | The ticket's ID; a former ID also works | `WEB-31`      |
| `project`     | The project's slug                      | `docs-launch` |
| `product`     | The product's slug                      | `storefront`  |
| `environment` | The environment's slug                  | `staging`     |
| `team`        | The team's key                          | `WEB`         |

Pinning something already pinned changes nothing, and an archived thing cannot be pinned. Pins of
archived things, and of things you can no longer see, leave your list. A ticket that moves to
another team keeps its pin under its new ID.

Pins belong to a person, so an account API key cannot read or change them. Use a personal API key,
the CLI's sign-in, or a clanker working for you.

## Every surface

| Operation       | API (`/v1/workspaces/{slug}`)       | MCP                                   | CLI                  |
| --------------- | ----------------------------------- | ------------------------------------- | -------------------- |
| List your pins  | [List your pins](https://docs.clankership.com/api/pins/list.md)    | [list_pins](https://docs.clankership.com/mcp/tools/list_pins.md)     | `clanker pin list`   |
| Pin something   | [Pin something](https://docs.clankership.com/api/pins/create.md)   | [create_pin](https://docs.clankership.com/mcp/tools/create_pin.md)   | `clanker pin add`    |
| Unpin something | [Unpin something](https://docs.clankership.com/api/pins/delete.md) | [delete_pin](https://docs.clankership.com/mcp/tools/delete_pin.md)   | `clanker pin remove` |
| Reorder a pin   | [Reorder a pin](https://docs.clankership.com/api/pins/reorder.md)  | [reorder_pin](https://docs.clankership.com/mcp/tools/reorder_pin.md) | `clanker pin move`   |

On the website, pin a ticket with the pin beside its title, and anything else from its page's
**More** menu. Drag a row in the sidebar to move it.

## CLI

```bash
clanker pin add ticket WEB-31
clanker pin add project docs-launch
clanker pin move ticket WEB-31 --before project:docs-launch
clanker pin list
clanker pin remove ticket WEB-31
```

Each command prints your pins in their order as JSON.

<!-- surfaces -->

## On every surface

Generated from Clanker Ship's surface registry. A dash means the surface leaves the operation out.

| Operation         | Website | API                                                                       | MCP                                     | CLI                                     |
| ----------------- | ------- | ------------------------------------------------------------------------- | --------------------------------------- | --------------------------------------- |
| List your pins    | Pinned  | [GET /v1/workspaces/{slug}/pins](https://docs.clankership.com/api/pins/list.md)                          | [`list_pins`](https://docs.clankership.com/mcp/tools/list_pins.md)     | [`clanker pin list`](https://docs.clankership.com/cli/pin/list.md)     |
| Pin something     | Pinned  | [POST /v1/workspaces/{slug}/pins](https://docs.clankership.com/api/pins/create.md)                       | [`create_pin`](https://docs.clankership.com/mcp/tools/create_pin.md)   | [`clanker pin add`](https://docs.clankership.com/cli/pin/add.md)       |
| Unpin something   | Pinned  | [DELETE /v1/workspaces/{slug}/pins/{kind}/{key}](https://docs.clankership.com/api/pins/delete.md)        | [`delete_pin`](https://docs.clankership.com/mcp/tools/delete_pin.md)   | [`clanker pin remove`](https://docs.clankership.com/cli/pin/remove.md) |
| Reorder your pins | Pinned  | [POST /v1/workspaces/{slug}/pins/{kind}/{key}/reorder](https://docs.clankership.com/api/pins/reorder.md) | [`reorder_pin`](https://docs.clankership.com/mcp/tools/reorder_pin.md) | [`clanker pin move`](https://docs.clankership.com/cli/pin/move.md)     |

<!-- /surfaces -->