Getting Started

The Linear Typescript SDK exposes the Linear GraphQL schema through strongly typed models and operations. It's written in Typescript but can also be used in any Javascript environment.

All operations return models, which can be used to perform operations for other models and all types are accessible through the Linear SDK package.

import { LinearClient, LinearFetch, User } from "@linear/sdk";
const linearClient = new LinearClient({ apiKey });
async function getCurrentUser(): LinearFetch<User> {
return linearClient.viewer;
}

You can view the Linear SDK source code on GitHub.

To quickly try out the SDK, open Javascript console when viewing your Linear workspace. You can load the SDK with your account using loadLinearClient() command.

Connect to the Linear API and interact with your data in a few steps:

1. Install the Linear Client

Using npm:

npm install @linear/sdk

Or yarn:

yarn add @linear/sdk

2. Create a Linear client

SDK supports both authentication methods, personal API keys and OAuth 2. See authentication for more details.

You can create a client after creating authentication keys:

import { LinearClient } from '@linear/sdk'
// Api key authentication
const client1 = new LinearClient({
apiKey: YOUR_PERSONAL_API_KEY
})
// OAuth2 authentication
const client2 = new LinearClient({
accessToken: YOUR_OAUTH_ACCESS_TOKEN
})

3. Query for your issues

Using async await syntax:

async function getMyIssues() {
const me = await linearClient.viewer;
const myIssues = await me.assignedIssues();
if (myIssues.nodes.length) {
myIssues.nodes.map(issue => console.log(`${me.displayName} has issue: ${issue.title}`));
} else {
console.log(`${me.displayName} has no issues`);
}
}
getMyIssues();

Or promises:

linearClient.viewer.then(me => {
return me.assignedIssues().then(myIssues => {
if (myIssues.nodes.length) {
myIssues.nodes.map(issue => console.log(`${me.displayName} has issue: ${issue.title}`));
} else {
console.log(`${me.displayName} has no issues`);
}
});
});