A CLI tool that allows you to chat with your markdown notes. MDChat uses a large language model (LLM) and a method called "Retrieval Augmented Generation" to allow you to have intelligent conversations with an expert on your content.
The primary goal of this project is to be both easy to get started with and educational to what modern AI systems can achieve. There are lots of tools like this out there but, in my opinion, they get a bit too into the weeds on the tech or require too much setup.
To get started with MDChat you just need to install it, configure it, and get to chattin!
pip install mdchatThen you can point mdchat at your notes through th interactive config and select a model (GPT-4 is more accurate, GPT-3.5-turbo is much cheaper and faster)
mdchat configAfter that's done, all you need to do is start a chat with your notes! You can start a new chat thread with the following command:
mdchat chatOr if you want to chat with a specific note
mdchat chat --file "/path/to/your/file.md"- Allows you to "chat" with any folder of markdown files or a single markdown file.
- Answers will include "sources" to the notes used in generating them when possible.
- summarizing the most recent notes on a certain topic (given your notes are dated)
- summarizing what you've been working on in the last day, or week (given your notes are dated)
- Making novel connections on topics you previously hadn't thought were related
MDChat is open-source and open to contributions! if you're looking to contribute to this project please:
- Create an issue to discuss your idea
- Fork this repo
- Create a new branch for your change
- Make the chnage discussed in your issue
- Send a pull request
poetry lock
poetry installpoetry run mdchat <your-command>poetry run pytestMDChat is released under the MIT License