@arthony/keybook 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -3
- package/dist/cli.js +1115 -379
- package/package.json +3 -3
- package/seed/nano.yaml +53 -12
package/README.md
CHANGED
|
@@ -9,19 +9,31 @@ shortcuts along the way.
|
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
|
12
|
+
```bash
|
|
13
|
+
brew install ariyapong/tap/keybook
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Or via npm:
|
|
17
|
+
|
|
12
18
|
```bash
|
|
13
19
|
npm install -g @arthony/keybook
|
|
14
20
|
# or run without installing:
|
|
15
|
-
npx @arthony/keybook
|
|
21
|
+
npx -p @arthony/keybook keybook
|
|
16
22
|
```
|
|
17
23
|
|
|
18
|
-
Requires
|
|
19
|
-
|
|
24
|
+
Requires macOS. The Homebrew tap installs Node 22 automatically; the npm
|
|
25
|
+
route assumes you already have Node 22+. Both install the `keybook`
|
|
26
|
+
command and the `kb` alias.
|
|
27
|
+
|
|
28
|
+
**Terminal.app users:** if `⌥⌫` doesn't delete a word in the search input,
|
|
29
|
+
enable *Terminal → Settings → Profiles → Keyboard → "Use Option as Meta
|
|
30
|
+
key"*, or use `⌃W` (works in any terminal).
|
|
20
31
|
|
|
21
32
|
## Usage
|
|
22
33
|
|
|
23
34
|
```bash
|
|
24
35
|
keybook # launch the TUI (alias: kb)
|
|
36
|
+
keybook add # add a new entry (interactive form)
|
|
25
37
|
keybook path # print the data directory
|
|
26
38
|
keybook edit # open the data directory in $EDITOR
|
|
27
39
|
keybook check # validate your data files
|
|
@@ -30,6 +42,10 @@ keybook check # validate your data files
|
|
|
30
42
|
In the TUI: type to fuzzy-search, ↑/↓ to move, ⏎ to copy the shortcut (or a
|
|
31
43
|
recipe's command) to the clipboard, ⎋ to quit.
|
|
32
44
|
|
|
45
|
+
Press `⌃O` in the TUI to add an entry without leaving the search screen. Or
|
|
46
|
+
script it: `keybook add --app Fork --action 'Push' --keys 'shift cmd p' --tags push`
|
|
47
|
+
(`--keys` accepts glyphs or words; recipes use repeatable `--step`).
|
|
48
|
+
|
|
33
49
|
## Your data
|
|
34
50
|
|
|
35
51
|
Shortcuts live in plain YAML files you own — by default `~/.config/keybook/`
|