Skip to content

Commit bc4b26b

Browse files
chore(docs): Add instructions for autocompletions
1 parent 5e77b7d commit bc4b26b

1 file changed

Lines changed: 33 additions & 16 deletions

File tree

README.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,23 @@ A CLI for [Linear](https://linear.app/) that allows you to quickly view, create
3232
# Commands
3333

3434
<!-- commands -->
35-
* [`lr cache:refresh`](#lr-cacherefresh)
36-
* [`lr cache:show`](#lr-cacheshow)
37-
* [`lr config:delete`](#lr-configdelete)
38-
* [`lr config:show`](#lr-configshow)
39-
* [`lr init`](#lr-init)
40-
* [`lr issue ISSUEID`](#lr-issue-issueid)
41-
* [`lr issue:create`](#lr-issuecreate)
42-
* [`lr issue:list`](#lr-issuelist)
43-
* [`lr issue:search [QUERY]`](#lr-issuesearch-query)
44-
* [`lr issue:start ISSUEID`](#lr-issuestart-issueid)
45-
* [`lr issue:stop ISSUEID`](#lr-issuestop-issueid)
46-
* [`lr issue:update ISSUEID`](#lr-issueupdate-issueid)
47-
* [`lr teams:show`](#lr-teamsshow)
48-
* [`lr workspace:add`](#lr-workspaceadd)
49-
* [`lr workspace:current`](#lr-workspacecurrent)
50-
* [`lr workspace:switch`](#lr-workspaceswitch)
35+
36+
- [`lr cache:refresh`](#lr-cacherefresh)
37+
- [`lr cache:show`](#lr-cacheshow)
38+
- [`lr config:delete`](#lr-configdelete)
39+
- [`lr config:show`](#lr-configshow)
40+
- [`lr init`](#lr-init)
41+
- [`lr issue ISSUEID`](#lr-issue-issueid)
42+
- [`lr issue:create`](#lr-issuecreate)
43+
- [`lr issue:list`](#lr-issuelist)
44+
- [`lr issue:search [QUERY]`](#lr-issuesearch-query)
45+
- [`lr issue:start ISSUEID`](#lr-issuestart-issueid)
46+
- [`lr issue:stop ISSUEID`](#lr-issuestop-issueid)
47+
- [`lr issue:update ISSUEID`](#lr-issueupdate-issueid)
48+
- [`lr teams:show`](#lr-teamsshow)
49+
- [`lr workspace:add`](#lr-workspaceadd)
50+
- [`lr workspace:current`](#lr-workspacecurrent)
51+
- [`lr workspace:switch`](#lr-workspaceswitch)
5152

5253
## `lr cache:refresh`
5354

@@ -290,4 +291,20 @@ USAGE
290291
```
291292

292293
_See code: [src/commands/workspace/switch.ts](https://github.com/evangodon/linear-cli/blob/v0.17.0/src/commands/workspace/switch.ts)_
294+
293295
<!-- commandsstop -->
296+
297+
# ZSH completions
298+
299+
If you want to add completions for the `lr` command and you're using ZSH you can do the following:
300+
301+
```sh
302+
# 1. Clone this repository
303+
> git clone https://github.com/evangodon/linear-cli
304+
> cd linear-cli
305+
306+
# 2. On Arch Linux you can do
307+
sudo cp zsh-completions/_lr /usr/share/zsh/site-functions/
308+
309+
# 3. Open a new terminal an enjoy the completions :)
310+
```

0 commit comments

Comments
 (0)