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_cliGetting started
Tell notes_cli where your notes will be stored
notes --notes_folder path/to/where/you/will/store/notesDefine your first workspace
notes -w workspace_nameSet your default editor
notes -e sublDSL
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_folderis where we decided to store notes -
personal_projectsandworkare workspaces -
social_media_appsandfeaturesare notebooks -
twitter_clone.mdandrequirements.mdare notes
notes_folder/
├── personal_projects
│ └── social_media_apps
│ └── twitter_clone.md
└── work
└── features
└── voice_chat
└── requirements.mdUsage
Check
Checking which workspace you are currently in
notes
'Current workspace is ...'Create
Create a note in the current workspace
notes -n notebook note_titleCreating 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.mdDelete
Delete a note
notes -d notebook note_titleList
Listing all notebooks in your workspace
notes -l .Listing all notes in a given notebook
notes -l notebookOpen
Open a notebook in the context of your favourite editor
notes -o notebookSwitch
Switching workspace
notes -w workspace_nameSwitching workspace and creating a note there
notes -w workspace_name -n notebook note_titleHelp
Display available commands
notes --help