simple-cheatsheet 0.2.0

Simple CLI Tool to define and display your own cheatsheets
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

# Simple Cheatsheet

**Obs.: This CLI Tool is in a really early stage.**

Small, Straightforward CLI Tool to interact with your own Cheatsheets o/

# How to Install

## Using Cargo

```bash
cargo install <TBD>
```

# Settings

You are able to configure three different settings by using environment variables:

- **SCHEAT_CHEATSHEETS_PATH** -> Path where you will store the Cheatsheets
- **SCHEAT_WIDTH**            -> Total Width to be used when displaying in terminal
- **SCHEAT_EDITOR**           -> Editor to use when editing Cheatsheets

## Defaults

- Cheatsheet Path -> `$HOME/.cheatsheets`
- Width           -> `80`
- Editor          -> `$EDITOR`

# How to Use

## 1. Define a Cheatsheet

A **Cheatsheet** contains **Sections**.
A **Section** contains **Cheats**.

To define a Cheatsheet, you need to specify a `yaml` file with the following format:

`cheatsheet.yaml`
```yaml
<Section Name>:
  - description: <Command Description>
    command: <Command>
```

Example:

`nvim.yaml`
```yaml
Tree:
  - description: Toggle Tree
    command: <leader>nt
  - description: Add File
    command: a
```

## 2. Use the CLI

### List all Cheatsheets

```bash
scheat list
```

### Show a Cheatsheet

```bash
scheat show <CHEATSHEET>
```

```bash
scheat show <CHEATSHEET> -s <SECTION>
```

### Edit a Cheatsheet

```bash
scheat edit <CHEATSHEET>
```

# Roadmap

[X] Define own Cheatsheets in Yaml
[X] List Cheatsheets
[X] Display a Cheatsheet
[X] Display a Section of a Cheatsheet
[X] Edit a Cheatsheet
[] Proper Testing :sweaty_smile:
[] Decent Documentation :sweaty_smile:
[] Create a new Cheatsheet
[] Define own Cheatsheets in a less verbose format