Skip to main content

Command reference

All commands print JSON. --pretty changes whitespace only. --api-key overrides the environment and config file for the current invocation.

Cobra also supplies --help on the root command and every subcommand; it prints usage and command-local help without calling the Linear API.

Top-level commands

CommandPurpose
linear-cli versionPrint build version, commit, and date.
linear-cli authManage authentication.
linear-cli configManage local configuration.
linear-cli issueManage issues.
linear-cli commentManage issue comments.
linear-cli teamManage teams.
linear-cli userManage users.
linear-cli statusManage workflow states.
linear-cli labelManage issue labels.
linear-cli projectManage projects.
linear-cli cycleManage cycles.
linear-cli docManage documents.
linear-cli attachmentManage file attachments.

Inventory

The positional syntax and every command-local flag are listed below. Detailed behavior and examples are split into the linked pages.

SyntaxFlags
auth login--token required
auth whoaminone
config set <key> <value>none
config get <key>none
config listnone
issue list--team, --assignee, --status, --priority, --label, --limit default 50, --cursor
issue get <identifier>none
issue create--title required, --team, --description, --description-file, --priority, --assignee, --label, --estimate, --cycle, --project, --state
issue update <identifier>--title, --description, --description-file, --priority, --assignee, --label, --estimate, --cycle, --project, --status, --state
issue search <query>--limit default 20
comment list--issue required
comment create--issue required, --body, --body-file
team list--limit default 50, --cursor
team get <team-key>none
user list--limit default 50, --cursor
user get <user-id>none
user menone
status list--team required
status get <state-id>none
label list--team, --limit default 50
label create--name required, --color, --team
project list--team, --limit default 50, --cursor
project get <project-id>none
project create--name required, --team required unless default team is configured, --description, --description-file
project update <project-id>--name, --description, --state
cycle list--team required, --limit default 20, --cursor
cycle get <cycle-id>none
doc list--limit default 20, --cursor
doc get <doc-id>none
doc search <query>--limit default 20
attachment upload--issue required, --file required, --title

See issues and comments, resources, and attachments for required inputs, resolution rules, and output details.