Linear API

The purpose-built tool for planning and building products

Streamline issues, projects, and product roadmaps

with the system for modern software development.

Visit developers.linear.app for the most up to date documentation

🔥 Contribute

The Linear Client uses custom GraphQL Code Generator plugins to produce a typed SDK for all operations and models exposed by the Linear production API.

$3

This monorepo uses pnpm workspaces to manage and publish packages.

Generated code uses file prefix _generated and should never be manually updated.

Open source packages:
- sdk - The Linear Client SDK for interacting with the Linear GraphQL API
- import - Import tooling for uploading from other systems
- codegen-doc - GraphQL codegen plugin to generate GraphQL fragments and documents
- codegen-sdk - GraphQL codegen plugin to generate Typescript SDK from fragments and documents
- codegen-test - GraphQL codegen plugin to generate a jest test for the Typescript SDK

$3

Make sure you have Node 18+ and Corepack enabled (corepack enable).

``shell


install dependencies

pnpm install

build all packages

pnpm build

test all packages

pnpm test

update the schema from the production API

pnpm schema

create changeset for generating CHANGELOG.md

pnpm changeset
``

$3

1. The @linear/codegen-doc plugin is used by codegen.doc.yml to generate fragments and documents
2. The @linear/codegen-sdk plugin is used by codegen.sdk.yml to generate the typed Linear SDK
3. The @linear/codegen-test plugin is used by codegen.test.yml to generate a typed jest test

License

Licensed under the MIT License.