Connect
Create a personal API key at Linear API settings. Use a personal API key with access to the teams you want Locality to ingest; do not paste an OAuth client secret. Locality never stores the plaintext key in browser storage or writes it to logs. Create the default Linear API key connection:linear-default. OAuth is not advertised until
Locality has a Linear OAuth broker flow.
Connection failures are intentionally distinct: an invalid key asks you to
replace it, insufficient permissions asks you to change the key’s access,
rate limiting reports when retry is safe, and temporary provider failures are
retried automatically.
Mount
linear-main. In the desktop app, the Add Source
dialog uses the same API key flow and creates or reconnects the default
linear-main mount under the desktop CloudStorage root.
Projection
- team directories preserve Linear team identity;
- status directories are keyed by team and Linear state id;
- empty workflow states are omitted;
- issue directories include the Linear issue identifier and title;
- each issue body lives in
page.md.
page.md is canonical Markdown with Linear reference fields in frontmatter and
the Linear issue description as the body. Rendered references use the
Label <id> shape so local diff can ignore label-only refreshes while
preserving stable Linear UUIDs.
Editable fields
The issue body inpage.md is editable. Linear descriptions are updated as a
single remote field after review and push.
Supported frontmatter edits:
title;Status;Project;Assignee.
Teams/<team>/Issues/<status>/ folder
updates the Linear team and/or status. Arbitrary creates, renames, moves at
grouping levels, deletes, and issue creates are not supported yet.
Generated lifecycle and date metadata is read-only, including created_at,
updated_at, archived_at, started_at, completed_at, canceled_at,
auto_archived_at, auto_closed_at, started_triage_at, triaged_at,
snoozed_until_at, added_to_cycle_at, added_to_project_at,
added_to_team_at, and due_date.
Sidecars
Each issue directory can include generated read-only sidecars:comments.mdcontains paginated issue comments in creation order;attachments.mdcontains paginated issue attachments, download status, and raw metadata;pull-requests.mdsummarizes pull-request-shaped attachments and Linear’s suggestedbranchName;history.mdcontains paginated issue history entries.
loc.type: asset frontmatter and reject local edits before any
Linear mutation is attempted.
Attachments
Linear issue attachments are external links. During hydration ofattachments.md, Locality best-effort downloads HTTP(S) attachment URLs up to
25 MB per attachment into:
Current limits
- OAuth is not available for Linear yet.
- Issue creates, deletes, and undo are future work.
- Unsupported properties and generated lifecycle/date fields fail closed before remote mutation.
- Sidecars are read-only even when the mount is writable.