File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -25,20 +25,74 @@ $ rake install
2525
2626You must set the LINEAR_API_KEY environment variable to your Linear API key. You can find your API key at https://linear.app/settings/api.
2727
28+ ==== Tab Completion
29+
30+ If you are using bash or zsh, you can enable tab completion by adding the following to your .bashrc or .zshrc:
31+
32+ Bash:
33+
34+ [source,sh]
35+ ----
36+ eval "$(lc completion bash)"
37+ ----
38+
39+ Zsh:
40+
41+ [source,sh]
42+ ----
43+ eval "$(lc completion zsh)"
44+ ----
45+
2846=== Commands
2947
48+ === Help
49+
50+ You can get help/usage for any command or subcommand by using the `--help` flag.
51+
52+ [source,sh]
53+ ----
54+ $ lc
55+ $ lc [COMMAND] --help
56+ $ lc [COMMAND] [SUBCOMMAND] --help
57+ ----
58+
3059==== Who Am I?
3160
61+ You can use the 'w' alias for 'whoami'
62+
3263[source,sh]
3364----
3465$ lc whoami
35- $ lc whoami --teams
66+ $ lc w --teams
3667----
3768
3869==== List Issues
3970
71+ `lcls` is a helper provided to list issues. It's an alias for `lc issues list`.
72+
4073[source,sh]
4174----
4275$ lcls
4376$ lcls --full
4477----
78+
79+ ==== Assign one or more issues to yourself (take em!)
80+
81+ 'i' is a shortcut for the 'issue' command
82+
83+ [source,sh]
84+ ----
85+ $ lc i take CRY-1234
86+ $ lc issue take CRY-456 CRY-789
87+ ----
88+
89+ ==== Create an issue
90+
91+ 'c' is a shortcut for the 'create' subcommand of the issue command
92+
93+ [source,sh]
94+ ----
95+ $ lc i c --title "My new issue" --description "This is a new issue"
96+ ----
97+
98+ NOTE: If you don't provide a title or description, you will be prompted to enter them.
You can’t perform that action at this time.
0 commit comments