Install and configure Linear SDK/CLI authentication. Use when setting up a new Linear integration, configuring API keys, or initializing Linear in your project. Trigger with phrases like "install linear", "setup linear", "linear auth", "configure linear API key", "linear SDK setup".
Set up Linear SDK and configure authentication credentials for API access.
# npm
npm install @linear/sdk
# pnpm
pnpm add @linear/sdk
# yarn
yarn add @linear/sdk
# Set environment variable
export LINEAR_API_KEY="lin_api_xxxxxxxxxxxx"
# Or create .env file
echo 'LINEAR_API_KEY=lin_api_xxxxxxxxxxxx' >> .env
import { LinearClient } from "@linear/sdk";
const client = new LinearClient({ apiKey: process.env.LINEAR_API_KEY });
const me = await client.viewer;
console.log(`Authenticated as: ${me.name} (${me.email})`);
@linear/sdk package in node_modules| Error | Cause | Solution |
|---|---|---|
Authentication failed | Invalid or expired API key | Generate new key in Linear settings |
Invalid API key format | Key doesn't start with lin_api_ | Verify key format from Linear |
Rate limited | Too many requests | Implement exponential backoff |
Module not found | Installation failed | Run npm install @linear/sdk again |
Network error | Firewall blocking | Ensure outbound HTTPS to api.linear.app |
import { LinearClient } from "@linear/sdk";
const linearClient = new LinearClient({
apiKey: process.env.LINEAR_API_KEY,
});
// Verify connection
async function verifyConnection() {
try {
const viewer = await linearClient.viewer;
console.log(`Connected as ${viewer.name}`);
return true;
} catch (error) {
console.error("Linear connection failed:", error);
return false;
}
}
import { LinearClient } from "@linear/sdk";
// OAuth tokens from your OAuth flow
const client = new LinearClient({
accessToken: userAccessToken,
});
After successful auth, proceed to linear-hello-world for your first API call.