macOS
brew install mdshlocal Homebrew formula metadata
brew
Markdown shell pre-processor. Version 0.9.2 via Homebrew; verified from local package data.
install
brew install mdshlocal Homebrew formula metadata
sudo dnf install mdshFedora Rawhide package metadata · mdsh · source: dl.fedoraproject.org
nix profile install nixpkgs#mdshnixpkgs package indexes · pkgs/by-name/md/mdsh/package.nix · source: api.github.com
overview
Markdown shell pre-processor
history
mdsh is a Rust Markdown shell preprocessor that updates Markdown files in place by including files, executing commands, and refreshing generated blocks. The project describes itself as similar to literate programming or notebooks, but for shell commands in Markdown.
The public repository was created on 2019-02-15. Its README explains the original problem as keeping README snippets, command output, and embedded file contents synchronized without manually copying text.
Unlike many preprocessors that emit a separate generated file, mdsh is designed around idempotent in-place updates. The README and project site document a compact Markdown extension for command blocks, comments, links, raw Markdown output, code-block output, and shell variable expansion.
Official installation instructions recommend `cargo install mdsh`, Nix installation, Nix flakes, and use as a pre-commit hook. The input package-manager facts list Homebrew, dnf, and Nix packages.
GitHub metadata showed ongoing maintenance through 2026 and a modest but real open-source footprint, with repository topics around Markdown, pre-processing, and shell.
By default, `mdsh` processes `./README.md`; `--inputs`, `--output`, and `--work-dir` let users choose files and execution directories. The `--frozen` mode is intended for CI checks that fail when generated documentation is stale.
The README documents commands for reading files, executing shell commands, producing raw Markdown or code blocks, expanding environment variables, cleaning generated blocks, and installing mdsh as a pre-commit hook.
mdsh matters to package-oriented developers because it turns a README into a reproducible build artifact without leaving Markdown. It is small, scriptable, CI-friendly, and sits in the same culture as literate shell docs, generated examples, and pre-commit-enforced documentation freshness.
security posture
generalized runtime or code generation signal.
yellow risk · medium confidence · runtime
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
mdsh | cli | global executable |
freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
https://github.com/zimbatm/mdsh
install metadata
| Package key | brew:mdsh |
|---|---|
| Version | 0.9.2 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/mdsh |
| Homepage | https://zimbatm.github.io/mdsh/ |
| Repository | https://github.com/zimbatm/mdsh |
| Upstream docs | https://github.com/zimbatm/mdsh#readme |
| License | MIT |
| Source archive | https://github.com/zimbatm/mdsh/archive/refs/tags/v0.9.2.tar.gz |
| Build dependencies | rust |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | mdsh |
| Version Scheme | 0 |
| Revision | 0 |
| Head Version | HEAD |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source database matches
Matches are pulled from external package-manager indexes and kept separate from local Automic Vault package links.
mdsh
nix profile install nixpkgs#mdshmdsh 0.7.0-8.fc44
Markdown shell pre-processor
sudo dnf install mdshsource trail
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
View the package source record on GitHub.