Skip to main content
Every team the API key can reach becomes a folder of members, issues, projects, cycles and documents, one JSON file each, with an issue’s comments as one JSONL file.

Setup

Create a personal API key in Linear under Settings, Account, Security & Access, in the Personal API keys section. The Read permission is enough for the mount; the linear CLI needs Write or the create permissions to change issues. A key can also be limited to some teams. Admins can always create keys; members can when an admin allows it under Administration, API. Copy the key when it is shown.

Connect

workspace.yaml

Layout

  • Every name ends in __<id>; the readable part is sanitized, so ls the parent instead of building it.
  • Files hold Mirage’s normalized JSON with snake_case keys, not Linear’s raw GraphQL response.
  • team_ids limits the mount to some teams.

Sample runs

The mount is read-only. Create, update, assign and comment on issues with the linear CLI.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.