# Install mdless with Homebrew Provides a formatted and highlighted view of Markdown files in Terminal. Version 2.1.68 via Homebrew; verified 2026-06-25. ## Install ```sh sudo av install brew:mdless ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install mdless ``` Evidence: local Homebrew formula metadata ## Package facts - **Package key:** brew:mdless - **Package manager:** Homebrew - **Package manager page:** - **Version:** 2.1.68 - **Source summary:** Provides a formatted and highlighted view of Markdown files in Terminal - **Homepage:** - **Repository:** - **License:** MIT - **Source archive:** - **Last updated:** 2026-06-25T15:48:53Z - **Generated:** 2026-08-04T22:13:35+00:00 ## Executables - mdless (cli) - mdless (alias) ## Dependencies - ruby ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-08-04 - Package-manager version: 2.1.68 - Package-manager updated: 2026-06-25 - Local data: ok - Upstream repository: https://github.com/ttscoff/mdless - Upstream latest detected: 2.1.68 (current) ## Project history and usage mdless is a Ruby terminal Markdown viewer and pager by Brett Terpstra. It provides formatted, highlighted Markdown output in the terminal, with pager behavior, syntax highlighting support, table formatting, themes, images through helper tools, and TaskPaper-related features. ### Project history The GitHub repository was created in August 2015, and the README explains the original motivation: the author wanted a quick terminal way to view Markdown files without using `qlmanage -p` from an iTerm2 visor workflow. The changelog shows a long-lived 1.x and 2.x project. Version 1.0.0 marked an early maturity point, version 2.0.0 switched to Redcarpet parsing and added the `~/.config/mdless/config.yml` file, and later 2.1.x releases added and refined TaskPaper, metadata, image, theme, table, Ruby compatibility, and terminal-copy behavior. ### Adoption history mdless spread through RubyGems and Homebrew. The README documents both `gem install mdless` and `brew install mdless`, while RubyGems reported more than 360,000 downloads and Homebrew tracked stable version 2.1.68 in 2026. Unlike some newer Rust terminal viewers, mdless is strongly tied to the Ruby CLI ecosystem and Brett Terpstra's macOS-terminal workflow, but it remains packaged as a standalone Homebrew formula. ### How it is used Typical use is `mdless [options] path` or piping Markdown into it with `cat path | mdless`. The pager is selected from `$PAGER`, `less`, `more`, `cat`, or `pager`. The first run writes `~/.config/mdless/config.yml`, and customization uses `~/.config/mdless/mdless.theme` plus optional named theme files. The README documents persistent options for colors, links, images, syntax highlighting, TaskPaper behavior, width, wiki links, and related rendering choices. ### Why package nerds care mdless is significant as an early dedicated Markdown pager for terminal users, especially before richer Rust and Go terminal Markdown renderers became common. It made Markdown viewing feel like a natural extension of `less` instead of a browser or preview-app task. For packagers, mdless is a classic Ruby CLI with optional external helpers: Pygments for code highlighting and imgcat or chafa for image rendering. That makes it simple to install but richer when companion tools are present. ### Timeline - 2015: GitHub repository created and mdless introduced as a terminal Markdown viewer. - 2015: README documents Homebrew availability and RubyGems installation. - Version 2.0.0: Switched to Redcarpet parsing and introduced `~/.config/mdless/config.yml`. - 2026: RubyGems and Homebrew tracked version 2.1.68. ### Related projects - mdless overlaps with mdcat and mdfried as a terminal Markdown viewer, but it comes from the Ruby/macOS command-line ecosystem. - It integrates with common terminal helpers and tools including less, more, cat, Pygments, imgcat, chafa, Ranger preview scripts, and TaskPaper workflows. ### Sources - - - - - source_facts.package-manager ## Security Notes No matching local secret-handling manifest was found for mdless. Package metadata is still published here so future coverage has a stable package URL. ## Configuration and credential file locations These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval. ## Configuration files - Unix: ~/.config/mdless/config.yml, ~/.config/mdless/mdless.theme ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** mdless - **Version Scheme:** 0 - **Revision:** 0 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## Related links - [Source-control packages](https://pkg.so/source-control-tools/) - Belongs to a source-control command family. - [Package publisher tools](https://pkg.so/package-publishers/) - Belongs to a package publishing or registry command family. - [Terminal utility packages](https://pkg.so/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://pkg.so/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [ruby](https://pkg.so/brew/ruby/) - Runtime dependency declared by Homebrew. - [mdfried](https://pkg.so/brew/mdfried/) - Shares pkgdb curated category or tags: cli, markdown, markdown-viewers, productivity, terminal. - [mdcat](https://pkg.so/brew/mdcat/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal, viewer. - [treemd](https://pkg.so/brew/treemd/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal, viewer. - [md-tui](https://pkg.so/brew/md-tui/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal, viewer. - [presenterm](https://pkg.so/brew/presenterm/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal. - [slides](https://pkg.so/brew/slides/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal. - [ekphos](https://pkg.so/brew/ekphos/) - Shares pkgdb curated category or tags: cli, markdown, productivity, terminal. - [inlyne](https://pkg.so/brew/inlyne/) - Shares pkgdb curated category or tags: cli, markdown, productivity, viewer. ## Combined YAML source View the package source record on GitHub. [combined/mdless.yml](https://github.com/mxcl/pkgdb/blob/main/combined/mdless.yml) ## Sources - pkg.so package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - pkgdb category and tag curation - package relationship graph - cross-ecosystem install command graph