@linear/sdk

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.

Structure

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

Get Started

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

# 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

Plugin Flow

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

License

Licensed under the MIT License.

Similar packages

Other packages similar to @linear/sdk

jira-client

jira-client is an SDK for interacting with the JIRA API. It provides similar functionalities for managing issues, projects, and other resources within JIRA. Compared to @linear/sdk, jira-client is tailored for JIRA's ecosystem and offers extensive support for JIRA-specific features.

asana

asana is an SDK for interacting with the Asana API. It allows developers to manage tasks, projects, teams, and other resources within Asana. Like @linear/sdk, it provides a convenient way to integrate Asana's functionalities into your applications, but it is specific to the Asana platform.

github

github is an SDK for interacting with the GitHub API. It allows developers to manage repositories, issues, pull requests, and other resources within GitHub. While it offers similar issue management functionalities, it is tailored for GitHub's ecosystem and includes features specific to version control and collaboration.