dnote/README.md
2017-04-28 12:19:40 +10:00

3.6 KiB

Dnote CLI

Dnote

A command line interface for spontaneously capturing the things you learn while coding

Installation

On macOS, or Linux, run:

curl -s https://raw.githubusercontent.com/dnote-io/cli/master/install.sh | sh

In some cases, you might need sudo. Feel free to inspect install.sh:

curl -s https://raw.githubusercontent.com/dnote-io/cli/master/install.sh | sudo sh

On Windows, download binary

Overview

Dnote categorizes your notes by books.

All your books and notes are stored in $HOME/.dnote as a JSON file.

You can optionally sync your note with Dnote server. Syncing will allow you to interact with your notes using the web frontend at https://dnote.io, and set up digest notifications.

Commands

dnote use [book name]

alias: u

Change the book to write your note in.

e.g.

dnote use linux

dnote new

alias: n

Write a new note.

Usage

  • dnote new "content"

Writes a new note with content to the current book.

  • dnote new [book name] "content"

Writes a new note with content to the book with the name [book name].

e.g.

dnote new "set -e instructs bash to exit immediately if any command has non-zero exit status"
dnote new linux "Use find - recursively walk the directly."

dnote edit

alias: e

Edit a note

Usage

  • dnote edit [note index] "[note content]"

Edits the note with note index in the current book.

  • dnote edit [book name] [note index] "[note content]"

Edits the note with note index in the specified book.

e.g

$ dnote notes
* [0] - Content index 0.
* [1] - Content index 1.
* [2] - Content index 2.

$ dnote edit 1 "New content"
[+] Edited Note : 1

$ dnote notes
* [0] - Content index 0.
* [1] - New content.
* [2] - Content index 2.

$ dnote notes linux
* [0] - Linux Content 0
* [1] - Linux Content 1
* [2] - Linux Content 2

$ dnote edit linux 1 "New Content"
[+] Edited Note : 1

$ dnote notes linux
* [0] - Linux Content 0
* [1] - New Content
* [2] - Linux Content 2

dnote delete

alias: d

Delete either a note or a book

Usage

  • dnote delete [book name] [index]

Deletes the note with index in the specified book.

  • dnote delete -b [book name]

Deletes the book with the book name.

e.g

$ dnote notes JS
* [0] - Content 0.
* [1] - Content 1.
* [2] - Content 2.

$ dnote delete JS 1
[+] Edited Note : 1

$ dnote notes
* [0] - Content 0.
* [1] - Content 2.

$ dnote books
  JS
  linux
  Go

$ dnote delete -b JS
$ dnote books
  linux
  Go

dnote books

alias: b

List all the books that you created

e.g.

$ dnote books
  javascript
* linux
  tmux
  css

dnote notes

List all notes in the current book

Options

  • -b [book name]

Specify the name of the book to read from

e.g.

$ dnote notes
On note JS
* .bind() creates a new function
* arrow function uses less memory than function with .bind()
* the time passed to setTimeout is minimum, no guaranteed time

dnote sync

Sync notes with Dnote server

dnote login

Start a login procedure which will store the APIKey to communicate with the server

License

MIT


Made by sung