---
title: Trello
icon: trello
description: Mount Trello boards, lists, and cards as a Mirage filesystem.
---

`TrelloResource` exposes a Trello workspace as a tree of boards, lists, and cards.

Setup steps for the API key/token live at [Trello Credentials](/home/setup/trello).

## Node

```bash
pnpm add @struktoai/mirage-node
```

```ts
import { MountMode, TrelloResource, Workspace } from '@struktoai/mirage-node'

const trello = new TrelloResource({
  apiKey: process.env.TRELLO_API_KEY!,
  apiToken: process.env.TRELLO_API_TOKEN!,
})

const ws = new Workspace({ '/trello': trello }, { mode: MountMode.READ })
await ws.execute('ls /trello/')
```

## Browser

```bash
pnpm add @struktoai/mirage-browser
```

```ts
import { MountMode, TrelloResource, Workspace } from '@struktoai/mirage-browser'

const trello = new TrelloResource({
  apiKey: TRELLO_API_KEY,
  apiToken: TRELLO_API_TOKEN,
})
```

## Config

| Field | Default | Notes |
| --- | --- | --- |
| `apiKey` | required | Trello API key. Redacted in snapshots. |
| `apiToken` | required | Trello API token. Redacted in snapshots. |
| `workspaceId` | none | Restrict to a single workspace. |
| `boardIds` | none | Optional allowlist of board IDs. |
| `baseUrl` | `https://api.trello.com/1` | Override for Enterprise instances. |

## Mount mode

`read`.

For board/list/card layout see the [Python Trello docs](/python/resource/trello).
