mynotes-cli 0.3.5

CLI notes manager with tags, colored output, exports and shell autocompletion

📝 mynotes-cli — Simple Terminal Notes Manager

Manage colorful notes with tags, export to TXT/MD/PDF, and enjoy autocompletion in your terminal.

---

🚀 Installation

1️⃣ Clone or unpack the project

git clone https://github.com/antoninsiska/mynotes-cli.git
cd mynotes-cli

Or if you have a ZIP file:

unzip mynotes-cli.zip
cd mynotes-cli

---

2️⃣ Install locally

pip install -e .

This command makes the mynotes command available in your Python environment.

💡 Optional (for PDF export):

pip install reportlab

---

⚙️ Enable autocompletion

mynotes uses argcomplete, which allows shell autocompletion by pressing TAB.

🐚 Bash

Run:

python -m argcomplete.global

Then restart your shell or reload it:

source ~/.bashrc

🌀 Zsh

autoload -U bashcompinit && bashcompinit
eval "$(register-python-argcomplete --shell zsh mynotes)"

To make it persistent, add the last line to your ~/.zshrc.

🐟 Fish

register-python-argcomplete --shell fish mynotes | source

Or permanently:

register-python-argcomplete --shell fish mynotes > ~/.config/fish/completions/mynotes.fish

---

⚡ Shortcut alias my

If you prefer shorter commands:

alias my="mynotes"

To make it persistent:

echo 'alias my="mynotes"' >> ~/.bashrc
source ~/.bashrc

---

🧠 Basic usage

Add a note

mynotes add "Buy milk"
mynotes add "Finish presentation" --tags school fll

List notes

mynotes list
mynotes list --tag school

list shows a colorful table with tags (using Rich).
Use --plain for plain text output.

Edit a note

mynotes edit 2 --text "Buy milk and eggs"
mynotes edit 2 --add-tags ftc --remove-tags school

Delete a note

mynotes delete 1

---

🏷️ Tags

List all tags

mynotes tag list

Add a new tag

mynotes tag add school --color bright_blue

Edit a tag

mynotes tag edit school --new-name School --color yellow

Delete a tag

mynotes tag delete fll

Available colors:
black, red, green, yellow, blue, magenta, cyan, white

• bright variants such as bright_blue, bright_yellow.

Tags are automatically styled for contrast:

• light colors → black text
• dark colors → white text

---

📤 Export

To TXT

mynotes export --format txt --out notes.txt

To Markdown

mynotes export --format md --out notes.md --tag ftc

To PDF

mynotes export --format pdf --out notes.pdf

PDF export uses reportlab (if installed). Otherwise, a simple fallback is used.

---

📦 Storage

• Notes: ~/.mynotes.json
• Tags: ~/.mynotes_tags.json

You can override paths:

MYNOTES_PATH=/custom/path/notes.json MYNOTES_TAGS_PATH=/custom/path/tags.json mynotes list

---

🧩 Autocomplete examples

Try pressing TAB:

mynotes [TAB]          # → add, list, edit, delete, tag, export
mynotes tag [TAB]      # → list, add, edit, delete
mynotes list --tag [TAB]  # → shows existing tags
mynotes edit [TAB]        # → offers existing note IDs

---

💡 Tips

• mynotes --l is a shortcut for mynotes list
• mynotes --a "text" adds a note
• mynotes --d 3 deletes note with ID 3

---

🧰 Troubleshooting

❌ mynotes: command not found

• Make sure your virtual environment is active
• Reinstall:

  pip install -e .
  

• Or run manually:

  python -m mynotes.cli
  

❌ Autocompletion not working

• Run:

  python -m argcomplete.global
  

• Then restart your terminal.

---

🎨 Example output

📒 mynotes
┏━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ ID┃ Note               ┃ Tags       ┃ Created      ┃ Updated      ┃
┣━━━╋━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━━╋━━━━━━━━━━━━━━┫
┃ 1 ┃ Buy milk           ┃ school fll ┃ 5 min ago    ┃ -            ┃
┃ 2 ┃ Finish presentation┃ ftc        ┃ 1 h ago      ┃ 10 min ago   ┃
┗━━━┻━━━━━━━━━━━━━━━━━━━━┻━━━━━━━━━━━━┻━━━━━━━━━━━━━━┻━━━━━━━━━━━━━━┛

---

🧡 Author

Antonín Šiška
CLI utility built in Python using argparse, rich, argcomplete, and reportlab.
Version: 0.3.0

© 2025 Antonín Šiška — Licensed under the MIT License.