linear-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Linear CLI Skill

Linear CLI Skill

This skill provides instructions for managing Linear issues, tasks, and projects using the linear-cli command-line tool. Linear is a modern issue tracker designed for software teams, and the CLI enables workflow management directly from the terminal.
本Skill提供了使用linear-cli命令行工具管理Linear问题、任务和项目的操作指南。Linear是一款为软件团队设计的现代化问题追踪工具,而该CLI允许直接从终端进行工作流管理。

Installation

安装

First, install the linear-cli tool:
bash
undefined
首先,安装linear-cli工具:
bash
undefined

Using Homebrew

Using Homebrew

brew install schpet/tap/linear
brew install schpet/tap/linear

Or using Deno

Or using Deno

deno install -A --reload -f -g -n linear jsr:@schpet/linear-cli
undefined
deno install -A --reload -f -g -n linear jsr:@schpet/linear-cli
undefined

Setup

配置

  1. Create an API key at https://linear.app/settings/account/security (requires member access)
  2. Add the API key to shell environment:
    bash
    # In ~/.bashrc or ~/.zshrc:
    export LINEAR_API_KEY="lin_api_..."
    
    # Or in fish:
    set -Ux LINEAR_API_KEY="lin_api_..."
  3. Run the configuration wizard in your project repository:
    bash
    cd my-project-repo
    linear config
    This creates a
    .linear.toml
    config file with workspace and team settings.
  1. 将API密钥添加到Shell环境变量中:
    bash
    # 在~/.bashrc或~/.zshrc中:
    export LINEAR_API_KEY="lin_api_..."
    
    # 或在fish中:
    set -Ux LINEAR_API_KEY="lin_api_..."
  2. 在你的项目仓库中运行配置向导:
    bash
    cd my-project-repo
    linear config
    这将创建一个包含工作区和团队设置的
    .linear.toml
    配置文件。

Issue Management

问题管理

View Issues

查看问题

View the current issue (determined from git branch name or jj commit trailer):
bash
linear issue view          # View current issue in terminal
linear issue view ABC-123  # View specific issue
linear issue view -w       # Open issue in web browser
linear issue view -a       # Open issue in Linear.app
linear issue id            # Print issue ID from current branch
linear issue title         # Print issue title
linear issue url           # Print Linear.app URL
查看当前问题(由git分支名称或jj提交尾注确定):
bash
linear issue view          # 在终端中查看当前问题
linear issue view ABC-123  # 查看特定问题
linear issue view -w       # 在浏览器中打开问题
linear issue view -a       # 在Linear.app中打开问题
linear issue id            # 打印当前分支对应的问题ID
linear issue title         # 打印问题标题
linear issue url           # 打印Linear.app的URL

List Issues

列出问题

List issues with filtering and sorting options:
bash
linear issue list           # List unstarted issues assigned to you
linear issue list -A        # List unstarted issues assigned to anyone
linear issue list -s "In Progress"  # Filter by state
linear issue list -w       # Open in web browser
linear issue list -a       # Open in Linear.app
通过筛选和排序选项列出问题:
bash
linear issue list           # 列出分配给你的未启动问题
linear issue list -A        # 列出分配给所有人的未启动问题
linear issue list -s "In Progress"  # 按状态筛选
linear issue list -w       # 在浏览器中打开
linear issue list -a       # 在Linear.app中打开

Start Working on an Issue

开始处理问题

Create or switch to an issue branch and mark as started:
bash
linear issue start          # Choose an issue interactively
linear issue start ABC-123  # Start specific issue
The CLI creates a git branch with the issue ID and updates the issue status.
创建或切换到问题分支,并标记为已启动:
bash
linear issue start          # 交互式选择问题
linear issue start ABC-123  # 开始处理特定问题
CLI会创建一个包含问题ID的git分支,并更新问题状态。

Create Issues

创建问题

Create new issues interactively or with flags:
bash
linear issue create                    # Interactive prompts
linear issue create -t "title" -d "description"
通过交互式提示或参数创建新问题:
bash
linear issue create                    # 交互式提示
linear issue create -t "title" -d "description"

Update Issues

更新问题

Update existing issue details:
bash
linear issue update         # Interactive prompts for current issue
更新现有问题的详情:
bash
linear issue update         # 交互式提示更新当前问题

Delete Issues

删除问题

Remove an issue from Linear:
bash
linear issue delete
从Linear中移除问题:
bash
linear issue delete

Create Pull Requests

创建拉取请求

Generate a GitHub PR with issue details via
gh pr create
:
bash
linear issue pr
通过
gh pr create
生成包含问题详情的GitHub PR:
bash
linear issue pr

Issue Comments

问题评论

Manage comments on issues:
bash
linear issue comment list          # List comments
linear issue comment add           # Add comment
linear issue comment add -p <id>   # Reply to specific comment
linear issue comment update <id>   # Update comment
管理问题的评论:
bash
linear issue comment list          # 列出评论
linear issue comment add           # 添加评论
linear issue comment add -p <id>   # 回复特定评论
linear issue comment update <id>   # 更新评论

Team Management

团队管理

bash
linear team list       # List teams
linear team id         # Print team ID
linear team members    # List team members
linear team create     # Create a new team
linear team autolinks  # Configure GitHub autolinks
bash
linear team list       # 列出团队
linear team id         # 打印团队ID
linear team members    # 列出团队成员
linear team create     # 创建新团队
linear team autolinks  # 配置GitHub自动关联

Project Management

项目管理

bash
linear project list    # List projects
linear project view    # View project details
bash
linear project list    # 列出项目
linear project view    # 查看项目详情

Milestone Management

里程碑管理

bash
linear milestone list --project <projectId>     # List milestones
linear m list --project <projectId>             # Alias
linear milestone view <milestoneId>             # View details
linear m view <milestoneId>                     # Alias
linear milestone create --project <projectId> --name "Q1 Goals" --target-date "2026-03-31"
linear m create --project <projectId>           # Interactive
linear milestone update <milestoneId> --name "New Name"
linear m update <milestoneId> --target-date "2026-04-15"
linear milestone delete <milestoneId>
linear m delete <milestoneId> --force
bash
linear milestone list --project <projectId>     # 列出里程碑
linear m list --project <projectId>             # 别名
linear milestone view <milestoneId>             # 查看详情
linear m view <milestoneId>                     # 别名
linear milestone create --project <projectId> --name "Q1 Goals" --target-date "2026-03-31"
linear m create --project <projectId>           # 交互式创建
linear milestone update <milestoneId> --name "New Name"
linear m update <milestoneId> --target-date "2026-04-15"
linear milestone delete <milestoneId>
linear m delete <milestoneId> --force

Document Management

文档管理

Manage Linear documents (can be attached to projects or issues):
bash
undefined
管理Linear文档(可关联到项目或问题):
bash
undefined

List documents

列出文档

linear document list linear docs list # Alias linear document list --project <projectId> linear document list --issue TC-123 linear document list --json
linear document list linear docs list # 别名 linear document list --project <projectId> linear document list --issue TC-123 linear document list --json

View documents

查看文档

linear document view <slug> linear document view <slug> --raw linear document view <slug> --web linear document view <slug> --json
linear document view <slug> linear document view <slug> --raw linear document view <slug> --web linear document view <slug> --json

Create documents

创建文档

linear document create --title "My Doc" --content "# Hello" linear document create --title "Spec" --content-file ./spec.md linear document create --title "Doc" --project <projectId> linear document create --title "Notes" --issue TC-123 cat spec.md | linear document create --title "Spec"
linear document create --title "My Doc" --content "# Hello" linear document create --title "Spec" --content-file ./spec.md linear document create --title "Doc" --project <projectId> linear document create --title "Notes" --issue TC-123 cat spec.md | linear document create --title "Spec"

Update documents

更新文档

linear document update <slug> --title "New Title" linear document update <slug> --content-file ./updated.md linear document update <slug> --edit
linear document update <slug> --title "New Title" linear document update <slug> --content-file ./updated.md linear document update <slug> --edit

Delete documents

删除文档

linear document delete <slug> linear document delete <slug> --permanent linear document delete --bulk <slug1> <slug2>
undefined
linear document delete <slug> linear document delete <slug> --permanent linear document delete --bulk <slug1> <slug2>
undefined

Configuration Options

配置选项

Configure Linear CLI via environment variables or
.linear.toml
:
OptionEnvironment VariableTOML KeyExample
API key
LINEAR_API_KEY
api_key
"lin_api_..."
Team ID
LINEAR_TEAM_ID
team_id
"TEAM_abc123"
Workspace
LINEAR_WORKSPACE
workspace
"mycompany"
Issue sort
LINEAR_ISSUE_SORT
issue_sort
"priority"
or
"manual"
VCS
LINEAR_VCS
vcs
"git"
or
"jj"
Download images
LINEAR_DOWNLOAD_IMAGES
download_images
true
or
false
通过环境变量或
.linear.toml
配置Linear CLI:
选项环境变量TOML 键示例
API密钥
LINEAR_API_KEY
api_key
"lin_api_..."
团队ID
LINEAR_TEAM_ID
team_id
"TEAM_abc123"
工作区
LINEAR_WORKSPACE
workspace
"mycompany"
问题排序
LINEAR_ISSUE_SORT
issue_sort
"priority"
"manual"
版本控制系统
LINEAR_VCS
vcs
"git"
"jj"
下载图片
LINEAR_DOWNLOAD_IMAGES
download_images
true
false

Version Control Integration

版本控制系统集成

The CLI works with both git and jj (jujutsu):
  • git: Works best when branches include Linear issue IDs (e.g.,
    eng-123-my-feature
    ). Use
    linear issue start
    or copy branch names from Linear UI.
  • jj: Detects issues from
    Linear-issue
    trailers in commit descriptions. Use
    linear issue start
    to add the trailer automatically.
该CLI支持git和jj(jujutsu):
  • git:当分支包含Linear问题ID时(例如
    eng-123-my-feature
    )效果最佳。使用
    linear issue start
    或从Linear UI复制分支名称。
  • jj:从提交描述中的
    Linear-issue
    尾注检测问题。使用
    linear issue start
    可自动添加该尾注。

Common Workflows

常见工作流

Daily Workflow

日常工作流

  1. List assigned issues:
    linear issue list
  2. Start working:
    linear issue start
    (choose interactively)
  3. View details:
    linear issue view
  4. When done: create PR with
    linear issue pr
  1. 列出分配给你的问题:
    linear issue list
  2. 开始处理:
    linear issue start
    (交互式选择)
  3. 查看详情:
    linear issue view
  4. 完成后:使用
    linear issue pr
    创建PR

Creating a Task

创建任务

  1. Create issue:
    linear issue create -t "Task title" -d "Description"
  2. Start working:
    linear issue start <issue-id>
  3. Track progress in the branch
  1. 创建问题:
    linear issue create -t "Task title" -d "Description"
  2. 开始处理:
    linear issue start <issue-id>
  3. 在分支中跟踪进度

Reviewing Issues

审核问题

  1. List all unstarted issues:
    linear issue list -A
  2. View specific issue:
    linear issue view <issue-id>
  3. Check comments:
    linear issue comment list
  1. 列出所有未启动的问题:
    linear issue list -A
  2. 查看特定问题:
    linear issue view <issue-id>
  3. 查看评论:
    linear issue comment list

Tips

小贴士

  • Use
    linear issue view
    to quickly see the current branch's issue
  • Use
    linear issue pr
    when ready to create a pull request - it pre-fills title and description from Linear
  • The CLI keeps you in the right views in Linear, avoiding context switching
  • Git branches with issue IDs are automatically detected by the CLI
  • 使用
    linear issue view
    快速查看当前分支对应的问题
  • 准备好创建拉取请求时使用
    linear issue pr
    ——它会从Linear自动填充标题和描述
  • 该CLI可让你停留在Linear的对应视图中,避免上下文切换
  • 包含问题ID的Git分支会被CLI自动检测