zbr 0.1.1

ZSH abbreviations
Documentation 
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
91
92
93
94
95
96
97
98
99

# zbr

<!-- Note: This is a duplicated version of the README -->

zbr is a tool for managing auto-expanding abbreviations for ZSH. With the
default configuration, typing `gco`<kbd>Space</kbd> into ZSH results in `git
checkout `; the abbreviation is expanded in place. Don't want an abbreviation
to expand? Just use <kbd>Ctrl</kbd><kbd>Space</kbd> instead.

Quoting from the README of [zsh-abbr][zsh-abbr]:

> Why? Like aliases, abbreviations **save keystrokes**. Unlike aliases, abbreviations can leave you with a **transparently understandable command history** ready for using on a different computer or sharing with a colleague. And where aliases can let you forget the full command, abbreviations may **help you learn** the full command even as you type the shortened version.

## Features

### Extraction

zbr supports *extracting* abbreviations from command-line tools. Running

```sh
zbr extract cargo conf/cargo.toml
```

generates a configuration file that contains all of the following abbreviations
and more!

```
cg --> cargo
cg -e --> cargo --explain
cg -f --> cargo --frozen
cg -h --> cargo --help
...
cga --> cargo add
cgb --> cargo build
cgbe --> cargo bench
cgc --> cargo check
...
cargo -e --> cargo --explain
cargo -f --> cargo --frozen
cargo -h --> cargo --help
...
cargo a --> cargo add
cargo b --> cargo build
cargo be --> cargo bench
cargo c --> cargo check
...
```

### Discoverability

zbr will also *show you abbreviations as you type*, typing `git s` will display
applicable abbreviations just below the command prompt:

```
git s --> git status
git see --> git send-email
git sep --> git send-pack
...
```

### Smart abbreviations

zbr detects the build system of the project you're working on, and creates
the abbreviations `b` for "build", `r` for "run", and `t` for "test". For
example, when working in a directory with a `Cargo.toml`, zbr will use the
abbreviations

```
b --> cargo build
r --> cargo run
t --> cargo test
```

but when working on a Haskell project, `cargo` would be replace by `cabal`.

### Unique prefixes for subcommands

In addition to pithy abbreviations like `gsu --> git submodule`, zbr
abbreviates all uniquely identifying prefixes of subcommands. For example, it
will automatically abbreviate

```
git sub --> git submodule
git subm --> git submodule
git submo --> git submodule
```

and so on, meaning you can just press <kbd>Space</kbd> at any point to expand
to the full subcommand name.

## Related tools

- [zsh-abbr][zsh-abbr] is quite similar, but doesn't support extracting
  abbreviations nor contextual abbreviations.
- [zabrze][zabrze] is quite similar, but doesn't support extracting
  abbreviations

[zabrze]: https://github.com/Ryooooooga/zabrze
[zsh-abbr]: https://github.com/olets/zsh-abbr