Getting Started

Installation

Homebrew (macOS)

The easiest way to install mddir on macOS:

brew install AliOsm/tap/mddir

This taps the repository and installs the latest version. To upgrade later:

brew upgrade mddir

Standalone Binary (macOS & Linux)

Download the latest binary for your platform from the GitHub releases page. Available binaries:

• macOS arm64 (Apple Silicon)
• Linux arm64
• Linux amd64

macOS

# Remove the quarantine flag set by macOS
xattr -d com.apple.quarantine mddir

# Make it executable
chmod +x mddir

# Move it to your PATH
sudo mv mddir /usr/local/bin/

Linux

# Make it executable
chmod +x mddir

# Move it to your PATH
sudo mv mddir /usr/local/bin/

RubyGems

If you prefer installing via RubyGems, mddir requires Ruby >= 3.2.0.

If you don't have Ruby installed, mise is the easiest way to get it:

mise use --global ruby@3

Then install the gem:

gem install mddir

Quick Start

Save a web page to a collection:

mddir add ruby https://docs.ruby-lang.org/en/3.3/String.html

List your collections:

mddir ls

Search across everything:

mddir search "freeze"

Open the built-in web UI:

mddir open

Next Steps

• CLI Reference — Full command reference
• Web UI — Browse and read saved pages
• Agent Integration — Use mddir with AI agents
• Configuration — Customize settings