macOS
Homebrewverified · 100%
brew install mdshprovider-native install command
brew / rank 10673
Install mdsh with Homebrew
Markdown shell pre-processor. Version 0.9.2 via Homebrew; verified from local package data.
install
Additional install commands
overview
Package summary
Markdown shell pre-processor
Project links
Commands and aliases
- mdsh
history
Project history and usage
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.
Project history
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.
Adoption history
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.
How it is used
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.
Why package nerds care
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.
Timeline
- 2019: Public GitHub repository created.
- 2019: README license block identifies copyright for zimbatm and contributors.
- 2026: Repository metadata showed continued updates and availability through Cargo, Nix, Homebrew, and dnf-related packaging facts.
Related projects
- The README compares mdsh with literate programming, Jupyter Notebooks, active code/Pandoc filters, and Enola.dev ExecMD.
- The project deliberately chooses in-place Markdown updates rather than a separate rendered-document pipeline.
Sources
- https://api.github.com/repos/zimbatm/mdsh
- https://github.com/zimbatm/mdsh#readme
- https://zimbatm.github.io/mdsh/
- source_facts.package-manager
security posture
Risk level: yellow
generalized runtime or code generation signal.
Risk classifier
yellow risk · medium confidence · runtime
Why
- generalized runtime or code generation signal
Signals
- text:shell
Install behavior
- No Homebrew bottle metadata was recorded.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
mdsh | executable | indexed executable | Discovered from the local executable index. |
freshness
Version and 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.
page generated2026-08-03
manager version0.9.2
manager updated
local dataunknown
upstreamnot available
latest detectednot detected
- okNo freshness warnings were generated.
install metadata
Package metadata
| Package key | brew:mdsh |
|---|---|
| Version | 0.9.2 |
| Package manager | Homebrew |
| Homepage | https://zimbatm.github.io/mdsh/ |
| Repository | https://github.com/zimbatm/mdsh |
| Bottle | not recorded |
| Service | none declared |
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- curated package history
- pkgdb category and tag curation