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

# Trello

> 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 theme={null}
pnpm add @struktoai/mirage-node
```

```ts theme={null}
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 theme={null}
pnpm add @struktoai/mirage-browser
```

```ts theme={null}
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).