Skip to content

Commit 911a40b

Browse files
Yukaiicursoragent
andcommitted
docs: document interactive TUI keybindings
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 1087e94 commit 911a40b

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ For HackMD Enterprise, pass `--enterprise` or set `HMD_CLI_ENTERPRISE=true`.
6060
| `history` | Browsing history (`GET /history`) |
6161
| `status` | Server stats (`GET /status`) |
6262
| `teams` | List teams (enterprise only) |
63-
| `tui` | Interactive note browser (OpenTUI) |
63+
| `tui` | Interactive note browser (OpenTUI) — tabs, search, preview, delete |
6464
| *(stdin pipe)* | `cat doc.md \| codimd-cli` creates a note |
6565

6666
## CodiMD API mapping
@@ -80,6 +80,22 @@ This CLI targets the [CodiMD](https://github.com/hackmdio/codimd) HTTP surface:
8080

8181
HackMD Enterprise mode (`--enterprise`) uses `/api/overview`, CSRF tokens, and form-encoded note creation instead.
8282

83+
## Interactive TUI
84+
85+
```bash
86+
codimd-cli tui
87+
```
88+
89+
| Key | Action |
90+
|-----|--------|
91+
| `` / `` | Navigate list |
92+
| `Enter` | Preview selected note |
93+
| `Tab` / `` `` | Switch Notes / History tabs |
94+
| `/` | Focus search filter |
95+
| `r` | Refresh current view |
96+
| `d` `d` | Delete selected note (double confirm) |
97+
| `Ctrl+C` | Quit |
98+
8399
## Development
84100

85101
```bash

0 commit comments

Comments
 (0)