mipy1/mipnote

A Highly Configurable CLI Note-taking App, Based Around Git

✨ mipnote ✨

A Highly Configurable CLI Note-Taking App, Based Around Git

Use in class, at work, or to keep track of ideas

A work in progress (yes, I know apps like nb and obsidian exist)

Installation 🐡:

To install, just run:

git clone https://github.com/mipy1/mipnote.git &&
cd mipnote &&
./installer &&
cd && rm -r mipnote

Usage 🐼:

To configure mipnote, edit the mipnote.conf file

To create a new note, or edit an existing one:

mipnote

To initialise a notes repository:

mipnote -i # OR --init

To get a preview of a note:

mipnote -p # OR --preview

To get help:

mipnote -h # OR --help

Future Features / Ideas 🐌:

May not be up-to-date; see TODO.md

• Multiple notes topics (ideas, classes, or whatever)
  • directories, and ability to switch between??
  • different branches in same directory??
• Better method of checking default editor
• Settings
  • remote repository
• Somehow have images
• Search for different notes containing phrases
• Encryption
• Remove dependencies