Skip to content

Commit 241db38

Browse files
committed
Update README.md and bug_report.yml
1 parent 34d6ccf commit 241db38

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ body:
2727
label: OS Version
2828
description: What version of your Operating System are you using?
2929
placeholder: |
30-
For Windows users:
3130
- Operating System or distribution: Windows 10, macOS Big Sur, Ubuntu 21.04, Fedora 34...
3231
- Version:
3332
- Architecture: ARM, Intel
@@ -49,4 +48,4 @@ body:
4948
placeholder: |
5049
Describe your problem here with anything that can help us identify and solve the issue.
5150
validations:
52-
required: false
51+
required: false

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ mv ~/Downloads/gk "$HOME/cli"
4747
export PATH="$HOME/gk:$PATH"
4848
```
4949

50-
You can also [download][releases page] your corresponding package (`.dev`, `.rpm`) and install it with:
50+
You can also [download][releases page] your corresponding package (`.deb`, `.rpm`) and install it with:
5151

5252
```bash
5353
sudo apt install ./gk.deb
@@ -80,6 +80,11 @@ Then edit your environment variables to add it to your PATH.
8080
- If it doesn't exist, create a variable with the name **PATH**.
8181
5. Add the path to the `gk` binary at the end.
8282

83+
84+
## ⚙️ Configuration
85+
### Nerd Fonts
86+
The GitKraken CLI supports Nerd Fonts to display icons for some commands. To ensure correct icon rendering, please obtain and install a Nerd Font available at https://www.nerdfonts.com/. After installation, set the selected Nerd Font as the default font for your terminal.
87+
8388
## Troubleshooting
8489

8590
### ```gk login``` freezes after authenticating in browser
@@ -93,6 +98,19 @@ unalias gk
9398
```
9499

95100
## Examples
101+
### 🎯 Focus View
102+
```
103+
gk focus
104+
```
105+
GitKraken Focus View is a unified dashboard that consolidates PRs, Issues, and WIPs across all of the repositories in a [Cloud Workspace](#-create-workspaces-to-group-repos). You can view the details of any item and take action on your most important tasks.
106+
107+
<img width="900" alt="Screenshot 2024-01-02 at 10 09 03 AM" src="https://github.com/gitkraken/gk-cli/assets/115040794/42f686de-cd8c-49a5-b0cf-43062c6b4509">
108+
109+
#### Pin items to keep them at the top of your list
110+
Use the shortcut <kbd>p</kbd> to pin any PR or Issue to the top of the list. You can unpin an item by using the same shortcut on any pinned item.
111+
#### Snooze items to save them for later
112+
Use the shortcut <kbd>s</kbd> to snooze any PR or Issue, removing them from the list of items. You can view snoozed items by navigating to the `Snoozed` tab in the Focus View. You can unsnooze items and bring them back into your Focus View lists by using the same shortcut on any snoozed item.
113+
96114
### 🤝 Create Workspaces to group repos
97115
```
98116
gk ws create

0 commit comments

Comments
 (0)