You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,20 +11,21 @@
11
11
12
12
### Installation:
13
13
14
-
- Install the `gh-dash` CLI via npm, or mark autoinstall as true in the config function
14
+
- Install the 'gh' command line tool for your OS from [GitHub CLI](https://cli.github.com/).
15
+
16
+
e.g. for macOS:
15
17
16
18
```bash
17
-
npm install -g @openai/gh-dash
19
+
brew install gh
18
20
```
19
21
20
-
- Grab an API key from OpenAI and set it in your environment variables:
21
-
- Note: You can also set it in your `~/.bashrc` or `~/.zshrc` file to persist across sessions, but be careful with security. Especially if you share your config files.
22
+
- Install the `gh-dash` TUI as a plugin from the `gh` command, or mark autoinstall as true in the config function
22
23
23
24
```bash
24
-
export OPENAI_API_KEY=your_api_key
25
+
gh extension install dlvhdr/gh-dash
25
26
```
26
27
27
-
- Use your plugin manager, e.g. lazy.nvim:
28
+
- Use your plugin manager to install, e.g. lazy.nvim:
28
29
29
30
```lua
30
31
return {
@@ -46,6 +47,7 @@ return {
46
47
},
47
48
}
48
49
```
50
+
- If you are not using Lazy, I assume you can figure out how to install the plugin yourself by cloning the repo.
49
51
50
52
### Usage:
51
53
- Call `:gh-dash` (or `:gh-dashToggle`) to open or close the gh-dash popup.
0 commit comments