docs: update README with the watch feature

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I6a6a69640e1c77cc479b40f276ba77b736040504
This commit is contained in:
raf 2025-08-12 19:04:58 +03:00
commit d9029ef8b7
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF

View file

@ -7,7 +7,7 @@ line.
## Features
- Stores clipboard entries with automatic MIME detection
- Fast persistent storage using sled
- Fast persistent storage using SQLite
- List, search, decode, delete, and wipe clipboard history
- Backwards compatible with Cliphist TSV format
- Import clipboard history from TSV (e.g., from `cliphist list`)
@ -42,13 +42,13 @@ stash decode --input "1234"
### Delete entries matching a query
```bash
stash delete-query --query "some text"
stash delete --type query --arg "some text"
```
### Delete multiple entries by ID (from a file or stdin)
```bash
stash delete < ids.txt
stash delete --type id < ids.txt
```
### Wipe all entries
@ -57,6 +57,15 @@ stash delete < ids.txt
stash wipe
```
### Watch clipboard for changes and store automatically
```bash
stash watch
```
This runs a daemon that monitors the clipboard and stores new entries
automatically.
### Options
Some commands take additional flags to modify Stash's behavior. See each
@ -79,7 +88,7 @@ must handle the migration yourself, with one simple command.
```bash
$ cliphist list --db ~/.cache/cliphist/db | stash --import-tsv
# > Imported 750 records from TSV into database.
# > Imported 750 records from TSV into SQLite database.
```
Alternatively, you may first export from Cliphist and _then_ import the
@ -88,5 +97,5 @@ database.
```bash
$ cliphist list --db ~/.cache/cliphist/db > cliphist.tsv
$ stash --import-tsv < cliphist.tsv
# > Imported 750 records from TSV into database.
# > Imported 750 records from TSV into SQLite database.
```