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

! Requires python version between 3.12-3.14, it might work on older ones but won't work on 1.14.. because of chroma db bug

  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.1.tar.gz (12.4 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.1-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notee-0.1.1.tar.gz
  • Upload date:
  • Size: 12.4 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.1.tar.gz
Algorithm Hash digest
SHA256 38779d8f4394fccdddd039b451c146c2ef3d14520b966a5ddd5b7039afbbe613
MD5 3792aef1ab230571ef3350f5e5a8caa0
BLAKE2b-256 91b6c6a91df1c1ec145481914b7ec920acc651ab2c1a0f9a2a5123e219de360c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notee-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 23.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e13b3f57e85d4d4f407b8832e529e7c9f4d751d863a60b5160227b2b30593f5
MD5 ac43db4bcca5b3482ceedb5a95d8029c
BLAKE2b-256 dba5bf17faf3c4429cd274f4f106b393966095c0d9bc237385d69572ee4bf366

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