https://github.com/trailjeep/kbd

Keyboard Shortcuts repository for use with cheat.sh standalone install.
https://github.com/trailjeep/kbd

applications apps cheat-sh cheat-sheets cheatsheets cht-sh keyboard shortcuts tldr

Last synced: 3 months ago
JSON representation

Keyboard Shortcuts repository for use with cheat.sh standalone install.

• Host: GitHub
• URL: https://github.com/trailjeep/kbd
• Owner: trailjeep
• Created: 2022-11-02T16:27:57.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-27T18:09:58.000Z (almost 2 years ago)
• Last Synced: 2023-04-29T21:52:01.150Z (over 1 year ago)
• Topics: applications, apps, cheat-sh, cheat-sheets, cheatsheets, cht-sh, keyboard, shortcuts, tldr
• Language: Python
• Homepage:
• Size: 132 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Keyboard Shortcut Cheat Sheets

Personal Keyboard Shortcuts repository for use with cheat.sh standalone install.

## Install

1. Install [chubin/cheat.sh](https://github.com/chubin/cheat.sh/blob/master/doc/standalone.md) standalone

2. Copy [kbd.py](kbd.py) to `$HOME/.cheat.sh/lib/adapter/`

3. Add to `$HOME/.cheat.sh/lib/config.py`

```

...

_CONFIG = {

    "adapters.active": [

        "tldr",

        "kbd",

...

    "routing.main": [

        ("", "cheat.sheets"),

        ("", "cheat"),

        ("", "tldr"),

        ("", "kbd"),

...

```

4. Initialize:

```

$HOME/.cheat.sh/ve/bin/python $HOME/.cheat.sh/lib/fetch.py fetch-all

```

## Update

1. Perform after any repo updates:

```

$HOME/.cheat.sh/ve/bin/python $HOME/.cheat.sh/lib/fetch.py update-all

```

## Usage

All cheatsheets for app including keyboard:

```

cht.sh {APP}

```

Only keyboard cheat sheet for app:

```

cht.sh kbd:{APP}

```

### Aliases / Functions

```

if $(command -v cht.sh >/dev/null 2>&1); then

    alias cht='cht.sh'

    kbd() {

        cht.sh kbd:"$1"

    }

    alias kbdl='find $HOME/.cheat.sh/upstream/keyboard/ -name "*.md" -printf "%f\n" | sed "s/.md//" | grep -v README'

fi

```

## Organization

Mostly follows: [tldr-pages/tldr](https://github.com/tldr-pages/tldr)

```

└── pages

    ├── custom     (custom/redefined app shortcuts go here)

        └── APP1.md

    ├── common     (os agnostic app shortcuts go here)

        ├── APP2.md

        └── APP3.md

    ├── linux      (linux app shortcuts go here)

    ├── osx        (osx app shortcuts go here)

    ├── sunos      (sunos app shortcuts go here)

    ├── windows    (windows app shortcuts go here)

    └── android    (android app shortcuts go here - probably unused)

```

## Template

Mostly follows: [tldr-pages/tldr](https://github.com/tldr-pages/tldr)

Note: `☐☐` represents 2 spaces for GitHub newline.

```

# APP_NAME

> DESCRIPTION☐☐

> More information: .

## Optional Section

|Shortcut|Description|

|:--|:--|

|KEY1|FUNCTION|

|SHIFT+ALT+KEY2|FUNCTION|

|1 - 9|Range of functions (skip to chapter 1-9)

|SPACE, K|Toggle play/pause (separate keys/same function)|

## Optional Section

|Shortcut|Description|

|:--|:--|

|KEY3|FUNCTION|

|SHIFT+ALT+KEY4|FUNCTION|

|CTRL+RIGHT / CTRL+LEFT|Previous/Next chapter (consolidate when possible)|

```

---

# APP_NAME

> DESCRIPTION  

> More information: .

## Optional Section

|Shortcut|Description|

|:--|:--|

|KEY1|FUNCTION|

|SHIFT+ALT+KEY2|FUNCTION|

|1-9|Range of functions (skip to chapter 1-9)

|SPACE, K|Toggle play/pause (separate keys/same function)|

## Optional Section

|Shortcut|Description|

|:--|:--|

|KEY3|FUNCTION|

|SHIFT+ALT+KEY4|FUNCTION|

|CTRL+RIGHT / CTRL+LEFT|Previous/Next chapter (consolidate when possible)|

---

## Acknowledgments

- [chubin/cheat.sh](https://github.com/chubin/cheat.sh)

- [tldr-pages/tldr](https://github.com/tldr-pages/tldr)