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

# Linear

> Mount Linear teams, projects, and issues as a Mirage filesystem.

`LinearVFS` exposes a Linear workspace as a tree of teams, projects, and issues. Reads route through the Linear GraphQL API.

Setup steps for the API key live at [Linear Credentials](/home/setup/linear).

## Node

```bash theme={null}
pnpm add @struktoai/mirage-node
```

```ts theme={null}
import { LinearVFS, MountMode, Workspace } from '@struktoai/mirage-node'

const linear = new LinearVFS({
  apiKey: process.env.LINEAR_API_KEY!,
  workspace: 'strukto',
})

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

## Browser

```bash theme={null}
pnpm add @struktoai/mirage-browser
```

```ts theme={null}
import { LinearVFS, MountMode, Workspace } from '@struktoai/mirage-browser'

const linear = new LinearVFS({
  apiKey: LINEAR_API_KEY,
})
```

## Config

| Field | Default | Notes |
| - | - | - |
| `apiKey` | required | Personal API key. Redacted in snapshots. |
| `workspace` | (auto) | Workspace identifier; auto-detected from the key. |
| `teamIds` | none | Optional allowlist of team IDs to expose. |
| `baseUrl` | `https://api.linear.app/graphql` | Override for self-hosted instances. |

## Mount mode

`read`.

For the mounted layout (`teams/`, `projects/`, `issues/`) see the [Python Linear docs](/python/vfs/linear).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.