Skip to content

Commit e47ff19

Browse files
committed
Document shorthand aliases
1 parent 149879e commit e47ff19

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,23 @@ By default your notes live in ~/notes, but you can change that to anywhere you l
3333

3434
### `notes new <note-name>`
3535

36-
Opens your `$EDITOR` of choice for a new note, with the given name. The name can include slashes, if you want to put your note in a subfolder.
36+
Opens your `$EDITOR` of choice for a new note, with the given name. The name can include slashes, if you want to put your note in a subfolder. Shorthand alias also available with `notes n`.
3737

3838
### `notes find <part-of-a-note-name>`
3939

40-
Searches note filenames and paths for the given string, and returns all the matches.
40+
Searches note filenames and paths for the given string, and returns all the matches. Shorthand alias also available with `notes f`.
4141

4242
### `notes grep <part-of-some-note-content>`
4343

44-
Searches all note content for the given string and returns all the matches.
44+
Searches all note content for the given string and returns all the matches. Shorthand alias also available with `notes g`.
4545

4646
### `notes open`
4747

48-
Opens your notes folder in your default configured file explorer.
48+
Opens your notes folder in your default configured file explorer. Shorthand alias also available with `notes o`.
4949

5050
### `notes open <note-name>`
5151

52-
Opens a given note in your `$EDITOR`. Name can be an absolute path, or a relative path in your notes (.md suffix optional).
52+
Opens a given note in your `$EDITOR`. Name can be an absolute path, or a relative path in your notes (.md suffix optional). Shorthand alias also available with `notes o`.
5353

5454
### `notes grep/find <pattern> | notes open`
5555

@@ -64,7 +64,6 @@ All the above works. Here's what's coming next:
6464
- [ ] Make the file extension optional
6565
- [ ] Bash/zsh command autocompletion
6666
- [ ] Bash/zsh note name autocompletion
67-
- [ ] Shorthand aliases `notes o`, `notes g`, `notes n`
6867
- [ ] Interactive mode? `notes` could open a scrollable list of notes, open your editor when you pick one, and reappear after you close it.
6968
- [ ] Tree view.
7069
- [ ] Easy way to see short notes snippets in find/grep/tree? Could be option (`--snippets`) or by piping to a command (`notes find | notes snippets`). Maybe call it `head`?

0 commit comments

Comments
 (0)