<div align="center">
# medi ✒️
[](https://crates.io/crates/medi)
[](https://crates.io/crates/medi)
</div>
## `medi`, a speedy CLI driven Markdown manager
**A fast, editor-centric, command-line notes manager.**
`medi` is a simple and powerful tool for creating and managing your notes, articles, and documentation directly from the terminal. It's built for developers, writers, and anyone who loves the speed and focus of a command-line workflow.
## Philosophy
`medi` is built on a few guiding principles:
- **CLI-first**: Everything is done through the terminal. No GUIs or TUIs, no distractions.
- **Editor-centric**: Your text editor (`$EDITOR`) is where you write. `medi` gets you there quickly and saves your work securely.
- **Local & private**: All content is stored on your local machine in a high-performance embedded database. No cloud services, no network access.
- **Zero-config start**: Install it and start writing immediately.
## Features ✨
- **Create & Manage Notes**: Quickly create new notes using a simple command (`medi new <note-key>`). You can add content directly with a flag, pipe it from other commands, or open your favorite text editor for more detailed entries.
- **Powerful Organisation**: Keep your notes tidy with tags. Add multiple tags when creating a note (`--tag`) and easily add or remove them later (`medi edit --add-tag ...`).
- **Integrated Task Management**: Turn your notes into actionable to-do lists. Add tasks to any note (`medi task add ...`), list all your pending items, mark them as complete (`medi task done ...`), and set priorities to focus on what's important.
- **Full-text Search**: Instantly find what you're looking for with a powerful search command (`medi search <term>`) that scans the content of all your notes.
- **Import & Export**: `medi` is not a data silo. You can easily import entire directories of Markdown files to get started, and export all your notes back to Markdown or JSON at any time.
- **List & Review**: Get a clean, sorted list of all your notes (`medi list`) or view the content of any specific note (`medi get <note-key>`).
- **Colorful & Clear Output**: Uses colored output to clearly distinguish between success messages, information, warnings, and errors.
## How It Works, DB as Source-of-Truth
`medi` uses a database-first approach. All your notes are stored in a `sled` key-value database, making access fast and reliable. This database is the single source of truth.
To version control your work with Git, `medi` provides a simple and deliberate workflow:
- **Write**: Use `medi new` and `medi edit` to manage your notes.
- **Export**: Run `medi export ./my-notes` to write all your notes to a local directory as `.md` files.
- **Commit**: Use Git to commit the exported directory, giving you a complete, version-controlled snapshot of your work.
### Installation
You need [Rust and Cargo](https://www.rust-lang.org/tools/install) installed.
#### Installing from crates.io
The easiest way to install `medi` is to download it from [crates.io](https://crates.io/crates/medi). You can do it using the following command:
```bash
cargo install medi
```
If you want to update `medi` to the latest version, execute the following command:
```bash
medi update
```
#### Building from source
Alternatively you can build `medi` from source using Cargo:
```bash
git clone https://github.com/cladam/medi.git
cd medi
sudo cargo install --path . --root /usr/local
```
## Configuration
On the first run, `medi` will automatically create a default configuration file at the standard location for your operating system:
* **macOS**: `~/Library/Application Support/medi/config.toml`
* **Linux**: `~/.config/medi/config.toml`
* **Windows**: `C:\Users\<user>\AppData\Roaming\medi\config.toml`
You can edit this file to customize `medi`'s behaviour.
### Example `config.toml`
```toml
# Path to the database file.
# You can change this to store your notes in a different location,
# for example, inside a cloud-synced folder like Dropbox.
db_path = "/Users/cladam/Library/Application Support/medi/medi_db"
# Default directory for the `medi export` command.
# If this is set, you can run `medi export` without specifying a path.
# Leave it as an empty string ("") if you don't want a default.
default_export_dir = "/Users/cladam/Documents/medi_backups"
```
## Usage
### Creating and Editing Notes
* **Create a new note**
`medi` provides three ways to create a new note:
1. **Interactively (default)**: Opens your default editor for long-form content.
```bash
medi new "my-long-article"
medi new "my-long-article" --tag tag1 --tag tag2
medi new "my-long-article" --title "My Long Article"
```
2. **With a direct message**: Perfect for quick, one-line notes.
```bash
medi new quick-idea -m "Remember to buy milk"
```
3. **From a pipe**: Use the output of other commands as your note content.
```bash
echo "This is a note from a pipe" | medi new piped-note
```
* **Edit an existing note**
```bash
medi edit "my-long-article"
medi edit "my-long-article" --add-tag tag1 --add-tag tag2
medi edit "my-long-article" --rm-tag tag1 --rm-tag tag2
```
### Viewing and listing notes
- **Get a note's content**
Prints the note directly to the console. This is perfect for piping to other tools.
```bash
medi get "my-first-article"
medi get "my-first-article" | mdcat
medi get "my-first-article" --json
medi get --tag my-tag
```
* **List all notes**
The `list` command provides a rich overview of your notes, including their keys and tags.
```bash
medi list
```
*Output:*
```
Notes:
- medi-readme [#medi #README]
- tbdflow-readme [#tbdflow #README]
- tbdflow-gif-post [#blog]
```
* **Sort your notes**
You can sort the list by creation or last modification date using the `--sort-by` flag. The default is to sort alphabetically by key.
```bash
medi list --sort-by modified
medi list --sort-by created
```
### Searching & Indexing
`medi` includes a full-text search engine (`tantivy`) that lets you find notes by their content, title, or tags.
**Search for a note**
```bash
# Find all notes containing the word "rust"
medi search rust
# Search for a phrase
medi search "database design"
```
_Output_:
```markdown
<ul>**Search Results:**</ul>
- medi-blogpost
- rust-cli-ideas
```
**Rebuild the search index**
If your search index ever gets out of sync or you're setting up `medi` for the first time with an existing database, you can rebuild the entire index.
```bash
medi reindex
```
### Deleting a Note
- **Delete a note**
You will be prompted for confirmation.
```bash
medi delete "my-first-article"
medi delete "my-first-article" --force
```
### Versioning with Export/Import
- **Export all notes to a directory**
Creates a version-controllable snapshot of your database.
```bash
medi export ./my_notes_backup
cd my_notes_backup
tbdflow init
```
- **Export all notes to a Json document**
```bash
medi export medi-export --format json
```
- **Export notes via a tag**
```bash
medi export medi-export --tag my-tag
```
- **Import notes from a directory**
Restores notes from a directory of .md files.
```bash
medi import --dir /path/to/notes
medi import --file /path/to/note.md --key my-note
medi import --file /path/to/note.md --key my-note --overwrite
```
### Shell Completion
To make `medi` even faster to use, you can enable shell completion. Add one of the following lines to your shell's configuration file.
For Zsh (`~/.zshrc`):
```bash
eval "$(medi generate-completion zsh)"
```
For Bash (`~/.bashrc`):
```bash
eval "$(medi generate-completion bash)"
```
For Fish (`~/.config/fish/config.fish`):
```bash
## Project Roadmap 🗺️
This section tracks the implementation status of `medi`'s features. Contributions are welcome!
- [x] All core commands (new, get, list, edit, delete, import, export).
- [x] Configuration file for settings (e.g., database path).
- [x] Support for note metadata (tags, creation dates).
- [x] `export` notes by tag.
- [x] Full-text search over note content.
- [x] Implement a `task` command for tracking the status of notes.
- [ ] ...