.png)
2 hours ago
2
A command-line tool to convert handwritten notes into a clean and readable Markdown file.
noted.md is a CLI tool that uses LLMs to convert your handwritten text into markdown files. It's an interactive program that accepts pdfs, jpg, jpeg, png as an input and processes them accordingly. It can recognize mathematical equations too and can correctly format them in LaTeX. And if you have bunch of files to convert them at once, noted.md supports batch processing too!
notedmd.mp4noted.md can be installed on macOS, Linux, and Windows.
For the easiest installation on macOS and Linux, use Homebrew:
To update noted.md to the latest version:
For Windows, download the latest .zip archive from the Releases page. Extract the contents and add the bin directory to your system's PATH.
If you prefer to build from source, clone the repository and use Cargo:
The typical workflow is:
- Configure your AI provider: Use notedmd config --edit for a guided setup.
- Convert your files: Use notedmd convert <path> to process your notes.
| notedmd convert | Converts a file or all supported files in a directory into Markdown. |
| notedmd config | Manages the AI provider configuration. Shows the current config if no flags are used. |
For first-time users, the interactive setup is the easiest way to get started. Run:
This will guide you through selecting an AI provider (Gemini, Claude, or Ollama) and entering the necessary credentials, such as API keys or server details.
You can choose between three AI providers.
You will need an API key from your chosen provider:
- Gemini API: Google AI Studio
- Claude API: Anthropic's website
Make sure Ollama is installed and running on your local machine. You can download it from Ollama's website.
You can also manage your configuration directly using flags.
| --set-provider <provider> | Set the active provider (gemini, claude, ollama). |
| --set-api-key <key> | Set the API key for Gemini. |
| --set-claude-api-key <key> | Set the API key for Claude. |
| --show | Display the current configuration. |
| --show-path | Show the path to your configuration file. |
| --edit | Start the interactive configuration wizard. |
Examples:
- Set the active provider to Claude:
notedmd config --set-provider claude
- Set your Gemini API key:
notedmd config --set-api-key YOUR_GEMINI_API_KEY
Once configured, you can convert your handwritten notes.
| -o, --output <dir> | Specify a directory to save the converted Markdown file(s). |
| -p, --prompt <prompt> | Add a custom prompt to override the default instructions for the LLM. |
| --api-key <key> | Temporarily override the stored API key for a single convert command. |
Examples:
-
Convert a single file: The converted file will be saved in the same directory with a .md extension (e.g., my_document.md).
notedmd convert my_document.pdf -
Convert a file with a custom prompt:
notedmd convert my_notes.png --prompt "Transcribe this into a bulleted list." -
Convert a file and save it to a different directory:
notedmd convert my_document.pdf --output ./markdown_notes/ -
Convert all supported files in a directory:
notedmd convert ./my_project_files/ -
Convert all files in a directory to a specific output directory:
notedmd convert ./my_project_files/ --output ./markdown_notes/
Contributions are welcome! If you have a feature request, bug report, or want to contribute to the code, please feel free to open an issue or a pull request on our GitHub repository.
This project is licensed under the MIT License. See the LICENSE file for details.
