mirror of
https://github.com/denisidoro/navi
synced 2024-12-01 07:49:11 +00:00
75 lines
2.6 KiB
Markdown
75 lines
2.6 KiB
Markdown
## Cheatsheet repositories
|
|
|
|
- [Browsing through cheatsheet repositories](#browsing-through-cheatsheet-repositories)
|
|
- [Importing cheatsheets](#importing-cheatsheets)
|
|
- [Adding your own cheatsheets](#adding-your-own-cheatsheets)
|
|
- [Submitting cheatsheets](#submitting-cheatsheets)
|
|
- [Using cheatsheets from other tools](#using-cheatsheets-from-other-tools)
|
|
- [Auto-updating repositories](#auto-updating-repositories)
|
|
|
|
### Browsing through cheatsheet repositories
|
|
|
|
You can find cheatsheet repositories with:
|
|
|
|
```sh
|
|
navi repo browse
|
|
```
|
|
|
|
### Importing cheatsheets
|
|
|
|
You can import cheatsheets from any git repository that includes `.cheat` files:
|
|
|
|
```sh
|
|
navi repo add https://github.com/denisidoro/cheats
|
|
```
|
|
|
|
### Adding your own cheatsheets
|
|
|
|
You can either start a git repo with cheatsheets and import it as described above or you can add them directly to [data_dir](https://github.com/soc/dirs-rs#Features)`/navi`.
|
|
|
|
### Submitting cheatsheets
|
|
|
|
The main repository for cheatsheets is [denisidoro/cheats](https://github.com/denisidoro/cheats). Feel free to open a PR there for me to include your contributions.
|
|
|
|
In order to add your own repository as a featured cheatsheet repo, please [edit this file](https://github.com/denisidoro/cheats/edit/master/featured_repos.txt). This list will be displayed when `navi repo browse` is run.
|
|
|
|
### Using cheatsheets from other tools
|
|
|
|
|
|
|
|
You can use cheatsheets from [tldr](https://github.com/tldr-pages/tldr) by running:
|
|
|
|
```sh
|
|
navi --tldr <query>
|
|
```
|
|
|
|
You can use cheatsheets from [cheat.sh](https://github.com/chubin/cheat.sh) by running:
|
|
|
|
```sh
|
|
navi --cheatsh <query>
|
|
```
|
|
|
|
### Auto-updating repositories
|
|
|
|
Right now, **navi** doesn't have support for auto-updating out of the box. However, you can achieve this by using `git` and `crontab`.
|
|
|
|
First make sure you cloned your repo using `git` to the correct folder:
|
|
|
|
```sh
|
|
user="<user>"
|
|
repo="<repo>"
|
|
git clone "https://github.com/${user}/${repo}" "$(navi info cheats-path)/${user}__${repo}"
|
|
```
|
|
|
|
Then, add a cron job:
|
|
|
|
```sh
|
|
crontab -e
|
|
*/0 11 * * * bash -c 'cd "$(/usr/local/bin/navi info cheats-path)/<user>__<repo>" && /usr/local/bin/git pull -q origin master'
|
|
```
|
|
|
|
Please note the cron job above is just an example and you should edit it accordingly:
|
|
|
|
- In this example, the cron job is triggered every day at 11am. [crontab guru](https://crontab.guru/) may come in handy if you want to change this value
|
|
- The full paths to `navi` and `git` may differ in your setup. Check their actual values using `which navi` and `which git`
|
|
- Don't forget to replace `<user>__<repo>` with the actual folder name
|