README.md

Linear CLI

A CLI for Linear that allows you to quickly view, create and update issues.

Warning

This CLI is unmaintained and likely has issues

Installation

Install with npm

  $ npm install -g @tkudlicka/lr

Install with yarn

  $ yarn global add @tkudlicka/lr

Setup API key

  $ lr init

Commands

• lr cache:refresh
• lr cache:show
• lr config:delete
• lr config:show
• lr init
• lr issue ISSUEID
• lr issue:create
• lr issue:list
• lr issue:search [QUERY]
• lr issue:start ISSUEID
• lr issue:stop ISSUEID
• lr issue:update ISSUEID
• lr teams:show
• lr workspace:add
• lr workspace:current
• lr workspace:switch

lr cache:refresh

Refresh the cache

USAGE
  $ lr cache:refresh

See code: src/commands/cache/refresh.ts

lr cache:show

Print the cache file

USAGE
  $ lr cache:show

OPTIONS
  -p, --pretty  Pretty print

See code: src/commands/cache/show.ts

lr config:delete

USAGE
  $ lr config:delete

See code: src/commands/config/delete.ts

lr config:show

USAGE
  $ lr config:show

See code: src/commands/config/show.ts

lr init

Setup the Linear cli

USAGE
  $ lr init

See code: src/commands/init.ts

lr issue ISSUEID

Show issue info

USAGE
  $ lr issue ISSUEID

OPTIONS
  -b, --branch       Show branch name
  -c, --comments     Show issue comments
  -d, --description  Show issue description
  -o, --open         Open issue in web browser
  -p, --project      Show project name only
  -u, --url          Show issue url

ALIASES
  $ lr i

See code: src/commands/issue/index.ts

lr issue:create

Create a new issue

USAGE
  $ lr issue:create

OPTIONS
  -c, --copy  Copy issue url to clipboard after creating

ALIASES
  $ lr create
  $ lr c

See code: src/commands/issue/create.ts

lr issue:list

List issues

USAGE
  $ lr issue:list

OPTIONS
  -a, --all               List issues from all teams
  -m, --mine              Only show issues assigned to me
  -s, --status=status     Only list issues with provided status
  -t, --team=team         List issues from another team
  -u, --uncompleted       Only show uncompleted issues
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             [default: -status] property to sort by (prepend '-' for descending)

ALIASES
  $ lr list
  $ lr ls
  $ lr l

See code: src/commands/issue/list.ts

lr issue:search [QUERY]

describe the command here

USAGE
  $ lr issue:search [QUERY]

ALIASES
  $ lr search
  $ lr s

See code: src/commands/issue/search.ts

lr issue:start ISSUEID

Change status of issue to "In progress" and assign to yourself.

USAGE
  $ lr issue:start ISSUEID

OPTIONS
  -c, --copy-branch  copy git branch to clip-board

ALIASES
  $ lr start
  $ lr s

See code: src/commands/issue/start.ts

lr issue:stop ISSUEID

Return issue to preview state

USAGE
  $ lr issue:stop ISSUEID

OPTIONS
  -u, --unassign  Unassign issue from yourself

ALIASES
  $ lr stop

See code: src/commands/issue/stop.ts

lr issue:update ISSUEID

Update an issue

USAGE
  $ lr issue:update ISSUEID

OPTIONS
  -p, --property=title|description|status  Property to modify

ALIASES
  $ lr update
  $ lr u

See code: src/commands/issue/update.ts

lr teams:show

Show teams in this workspace

USAGE
  $ lr teams:show

OPTIONS
  -m, --mine  Pretty print

See code: src/commands/teams/show.ts

lr workspace:add

Add a new workplace

USAGE
  $ lr workspace:add

See code: src/commands/workspace/add.ts

lr workspace:current

Print current workspace

USAGE
  $ lr workspace:current

See code: src/commands/workspace/current.ts

lr workspace:switch

Switch to another workspace

USAGE
  $ lr workspace:switch

See code: src/commands/workspace/switch.ts

ZSH completions

If you want to add completions for the lr command and you're using ZSH you can do the following:

# 1. Clone this repository
> git clone https://github.com/evangodon/linear-cli
> cd linear-cli

# 2. On Arch Linux you can do
sudo cp zsh-completions/_lr /usr/share/zsh/site-functions/

# 3. Open a new terminal an enjoy the completions :)