Table of Contents
Philosophy
Do you inconvenience yourself keeping track of thoughts, references and TODOs while working? Me too! So I decided to do something for us - note-shell.
We need an interactive console client to take quick notes and manage them for us, whether it be a random thought that we come across or a link that we want to revisit later.
This project is built on the grounds of making noting down something (anything) super easy, as well as detailed if needed.
*NOTE: It is currently intended mainly for developers, who do not like to part with their termials, and anyone with a basic idea of using python/pip should be able to enjoy their experience. Browser based GUI coming soon!
About
Note-shell records and manages your notes for you. It is a completely terminal based app, which interactively helps you maintain your daily notes.
*NOTE: some features may not work as intended in a Windows environment. Feel free to raise issues if you face them
Built With
Prerequisites
- python
- pip
- notify-send (this is required for reminder notifications, please install as per OS)
Installation
- Install the module
$ pip install note-shellThats it, start using it!
Usage
This tool is highly interactive, hence it can be figured out on the fly. But lets see the modes it can be used in
- interactive more
Open your command prompt and type note to begin
$ note- cli options
Type -h suffix to get help, it has all the features of interactive mode.
$ note -hLicense
Distributed under the MIT License. See LICENSE for more information.
Contact
Nirabhra Tapaswi - nirabhratapaswi@gmail.com
