Skip to main content

Python CLI to create md files with terminal in seconds

Project description

Notee

Notee is python CLI that is able to fully replace your note making app or just be your fast way to create notes in terminal with additional functionality.

Sometimes I have an idea that comes from nowhere and to note it I have to open my obsidian app, create file and only then write my note, it's too slow. I created python CLI that will allow you to start writing your notes just after one command of 9 characters. Also there is functionality like ai module or search with vector database included.

Technologies

  • Typer - to realize CLI functionality.
  • Chroma DB - vector db for AI context and extendet search through your notes.
  • MdUtils - for the md files creation.
  • Rich - to make prints prettier.

How to use

  1. Install package by running pipx install notee.
  2. Run notee setup and go throught instuctions in the console.

Done! Now you can use it freely🎉


Commands

  • setup - setup notee before using it.
  • idea - create idea note.
  • movie - create movie review note.
  • book - create book review note.
  • source - create note about source to something.
  • todo - create todo note.
  • search QUERY - search notes related to your query.
  • open - open your note in the terminal.
  • scan - scan your vault and add new notes to the database.
  • obsidian_mode --on/--off - use to manage obsidian mode(only affects how tags are created).
  • different_folders --on/--off - toggle between creating folder for each tipe of template or store all notes in core folder.
  • ai_module --on/-off - toggle between using ai module or not.
  • setup_ai - change Ai provider/api key.
  • ask QUERY - ask AI question and it'll answer it based on your notes.
  • change_ai_model AI_MODEL_NAME - change default ai model. Please be careful and make sure that you're passing correct model name.
AI provider Default model
Open AI gpt-4.1-mini-2025-04-14
Google Gemini gemini-2.5-flash
Hack Club AI API google/gemini-2.5-flash

Found error?

Please let me know about it by submitting issue on the github repository. I'll try to fix it as fast as possible!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notee-0.1.0.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

notee-0.1.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file notee-0.1.0.tar.gz.

File metadata

  • Download URL: notee-0.1.0.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for notee-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fd3196729b7b51313a9a808b929cb22f43a363fe653caa8d7adb8744004f11e4
MD5 1726b628eed557d4711d507d3d108f68
BLAKE2b-256 ed7f80436e1723d08997579d42a26cee4111ddd3a827d8df52e1c692e2265075

See more details on using hashes here.

File details

Details for the file notee-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: notee-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for notee-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0542c7955f111d68b969a79153bbdb5f74a3ad8e721c0c56ef2296c2791949b3
MD5 3d9d06fd3e0af10016fab098b629e9ab
BLAKE2b-256 86edaaae8f2d9a7bcb7f1eeaee6950b129b9af276fd0f20b42f7cff85251c944

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page