mirror of
https://github.com/dnote/dnote
synced 2026-03-16 23:45:52 +01:00
* Make easier to copy paste to execute * Make migration work * Bump edit_note action schema to v3 * Use UnixNano for timstamps * Fix schema
67 lines
1.5 KiB
Markdown
67 lines
1.5 KiB
Markdown
# Dnote CLI
|
|
|
|
A command line interface for spontaneously capturing the things you learn while coding.
|
|
|
|

|
|
|
|
## Install
|
|
|
|
On macOS, you can install using Homebrew:
|
|
|
|
```sh
|
|
brew tap dnote/dnote
|
|
brew install dnote
|
|
|
|
# to upgrade to the latest version
|
|
brew upgrade dnote
|
|
```
|
|
|
|
On Linux or macOS, you can use the installation script:
|
|
|
|
curl -s https://raw.githubusercontent.com/dnote/cli/master/install.sh | sh
|
|
|
|
In some cases, you might need an elevated permission:
|
|
|
|
curl -s https://raw.githubusercontent.com/dnote/cli/master/install.sh | sudo sh
|
|
|
|
Otherwise, you can download the binary for your platform manually from the [releases page](https://github.com/dnote/cli/releases).
|
|
|
|
## Overview
|
|
|
|
Write technical notes without getting distracted from programming. The reasons are:
|
|
|
|
- We forget exponentially unless we write down what we learn and come back.
|
|
- Ideas cannot be grokked unless we can put them down in clear words.
|
|
|
|
## Examples
|
|
|
|
- Add a note to a book named `linux`
|
|
|
|
```
|
|
dnote add linux -c "find - recursively walk the directory"
|
|
```
|
|
|
|
- See the notes in a book
|
|
|
|
```
|
|
dnote view linux
|
|
|
|
• on book linux
|
|
(0) find - recursively walk the directory
|
|
```
|
|
|
|
## Commands
|
|
|
|
Please refer to [commands](/COMMANDS.md).
|
|
|
|
## Links
|
|
|
|
- [Dnote](https://dnote.io)
|
|
- [Dnote Cloud](https://dnote.io/pricing)
|
|
- [Browser Extension](https://github.com/dnote/browser-extension)
|
|
|
|
## License
|
|
|
|
MIT
|
|
|
|
[](https://travis-ci.org/dnote/cli)
|