mirror of
https://github.com/dnote/dnote
synced 2026-03-15 06:55:49 +01:00
f6a4c6344c* Remove public from CLI * Write migration and test * Use in-memory db for a test server * Simplify CLI test db teardown * Restructure packages to reduce duplication
107 lines
1.5 KiB
Markdown
107 lines
1.5 KiB
Markdown
# Commands
|
|
|
|
- [add](#dnote-add)
|
|
- [view](#dnote-view)
|
|
- [edit](#dnote-edit)
|
|
- [remove](#dnote-remove)
|
|
- [find](#dnote-find)
|
|
- [sync](#dnote-sync)
|
|
- [login](#dnote-login)
|
|
- [logout](#dnote-logout)
|
|
|
|
## dnote add
|
|
|
|
_alias: a, n, new_
|
|
|
|
Add a new note to a book.
|
|
|
|
```bash
|
|
# Launch a text editor to add a new note to the specified book.
|
|
dnote add linux
|
|
|
|
# Write a new note with a content to the specified book.
|
|
dnote add linux -c "find - recursively walk the directory"
|
|
```
|
|
|
|
## dnote view
|
|
|
|
_alias: v_
|
|
|
|
- List books or notes.
|
|
- View a note detail.
|
|
|
|
```bash
|
|
# List all books.
|
|
dnote view
|
|
|
|
# List all notes in a book.
|
|
dnote view golang
|
|
|
|
# See details of a note
|
|
dnote view 12
|
|
```
|
|
|
|
## dnote edit
|
|
|
|
_alias: e_
|
|
|
|
Edit a note or a book.
|
|
|
|
```bash
|
|
# Launch a text editor to edit a note with the given id.
|
|
dnote edit 12
|
|
|
|
# Edit a note with the given id in the specified book with a content.
|
|
dnote edit 12 -c "New Content"
|
|
|
|
# Launch a text editor to edit a book name.
|
|
dnote edit js
|
|
|
|
# Edit a book name by using a flag.
|
|
dnote edit js -n "javascript"
|
|
```
|
|
|
|
## dnote remove
|
|
|
|
_alias: rm, d_
|
|
|
|
Remove either a note or a book.
|
|
|
|
```bash
|
|
# Remove a note with an id.
|
|
dnote remove 1
|
|
|
|
# Remove a book with the `book name`.
|
|
dnote remove js
|
|
```
|
|
|
|
## dnote find
|
|
|
|
_alias: f_
|
|
|
|
Find notes by keywords.
|
|
|
|
```bash
|
|
# find notes by a keyword
|
|
dnote find rpoplpush
|
|
|
|
# find notes by multiple keywords
|
|
dnote find "building a heap"
|
|
|
|
# find notes within a book
|
|
dnote find "merge sort" -b algorithm
|
|
```
|
|
|
|
## dnote sync
|
|
|
|
_alias: s_
|
|
|
|
Sync notes with Dnote server.
|
|
|
|
## dnote login
|
|
|
|
Start a login prompt.
|
|
|
|
## dnote logout
|
|
|
|
Log out of Dnote.
|