About
Easily create, delete, list and open all your notes.
NotesCli lets you create workspaces and notebooks in which you can store notes.
Notes are created as md files for ease of storing code snippets.
Installation
gem install notes_cli
Getting started
Tell notes_cli where your notes will be stored
notes --notes_folder path/to/where/you/will/store/notes
Define your first workspace
notes -w workspace_name
Set your default editor
notes -e subl
DSL
Notes folder
Where you will store all notes, including your workspaces and notebooks as the top layers
Workspace
Where you will store notebooks
Notebook
Where you will store notes
Example
Basic case scenario, where:
-
notes_folder
is where we decided to store notes -
personal_projects
andwork
are workspaces -
social_media_apps
andfeatures
are notebooks -
twitter_clone.md
andrequirements.md
are notes
notes_folder/
├── personal_projects
│ └── social_media_apps
│ └── twitter_clone.md
└── work
└── features
└── voice_chat
└── requirements.md
Usage
Check
Checking which workspace you are currently in
notes
'Current workspace is ...'
Create
Create a note in the current workspace
notes -n notebook note_title
Creating a note in a nested notebook
notes -n path/to/notebook note_title
# e.g
notes -n saving_the_world/doing_charity_work list_of_charities
# will produce
notes_folder/
├── personal_projects
│ ├── saving_the_world
│ │ └── doing_charity_work
│ │ └── list_of_charities.md
│ └── social_media_apps
│ └── twitter_clone.md
└── work
└── features
└── voice_chat
└── requirements.md
Delete
Delete a note
notes -d notebook note_title
List
Listing all notebooks in your workspace
notes -l .
Listing all notes in a given notebook
notes -l notebook
Open
Open a notebook in the context of your favourite editor
notes -o notebook
Switch
Switching workspace
notes -w workspace_name
Switching workspace and creating a note there
notes -w workspace_name -n notebook note_title
Help
Display available commands
notes --help