Skip to content

Commit

Permalink
Update README.md and bug_report.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiolms committed Feb 26, 2024
1 parent 34d6ccf commit 241db38
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ body:
label: OS Version
description: What version of your Operating System are you using?
placeholder: |
For Windows users:
- Operating System or distribution: Windows 10, macOS Big Sur, Ubuntu 21.04, Fedora 34...
- Version:
- Architecture: ARM, Intel
Expand All @@ -49,4 +48,4 @@ body:
placeholder: |
Describe your problem here with anything that can help us identify and solve the issue.
validations:
required: false
required: false
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ mv ~/Downloads/gk "$HOME/cli"
export PATH="$HOME/gk:$PATH"
```

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

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


## ⚙️ Configuration
### Nerd Fonts
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.

## Troubleshooting

### ```gk login``` freezes after authenticating in browser
Expand All @@ -93,6 +98,19 @@ unalias gk
```

## Examples
### 🎯 Focus View
```
gk focus
```
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.

<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">

#### Pin items to keep them at the top of your list
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.
#### Snooze items to save them for later
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.

### 🤝 Create Workspaces to group repos
```
gk ws create
Expand Down

0 comments on commit 241db38

Please sign in to comment.