Official tools for .mdz
The format is open; these tools make it practical day-to-day. Apps for everyone come first — if you build software, the developer libraries are at the end.
Apps
MDZip Studio — the desktop app
Create, edit, and package .mdz archives with a full workspace editor — no command line required. The Windows installer also registers the .mdz file type and the File Explorer preview.
Get it: download the latest release (Windows installer), or learn more about Studio first.
mdz — the command line
Create, inspect, and validate archives from the command line: mdz create, mdz ls, mdz validate, plus cat, assets, manifest, and workspace for deeper work. Self-contained builds for Windows, macOS, and Linux — no runtime to install.
Windows (PowerShell):
irm https://raw.githubusercontent.com/mdzip-project/mdzip-cli/main/scripts/install.ps1 | iex
Linux / macOS:
curl -fsSL https://raw.githubusercontent.com/mdzip-project/mdzip-cli/main/scripts/install.sh | sh
A WinGet package (MDZip.Cli) is coming soon. Source and releases: mdzip-project/mdzip-cli.
MDZip Editor for VS Code
Read and write .mdz archives directly in VS Code, including packaged images, split preview/edit mode, and an included MCP server for agent workflows.
Install it from the VS Code Marketplace, search for MDZip in the Extensions view, or install from the terminal:
code --install-extension mdzip-project.mdzip-vscode
Source: mdzip-project/mdzip-vscode
File Explorer preview (Windows)
Native File Explorer preview for .mdz files, so recipients can inspect packaged content without extracting anything. It ships with the MDZip Studio install — nothing extra to set up. macOS and Linux are planned.
Right here, in your browser
No install at all:
- The web previewer opens and renders
.mdzfiles directly, including internal links and packaged assets. - The packager turns a local folder into an
.mdzarchive in the browser — drop a folder, download the archive.
Platform support
| Tool | Windows | macOS | Linux | Notes |
|---|---|---|---|---|
| MDZip Studio | ✅ Available | Planned | Planned | Installer registers .mdz and the File Explorer preview |
mdz CLI |
✅ Available | ✅ Available | ✅ Available | WinGet package coming soon |
| VS Code extension | ✅ Available | ✅ Available | ✅ Available | Marketplace listing |
| File Explorer preview | ✅ Available | Planned | Planned | Ships with the Studio install |
| Web previewer & packager | ✅ | ✅ | ✅ | Any modern browser |
For developers
Everything above is built on these libraries — use them to add .mdz support to your own apps. Just want to use .mdz? You're done; everything you need is above.
JavaScript / TypeScript (npm)
@mdzip/core-js — the core: pack, unpack, validate, and resolve .mdz archives in Node or the browser.
npm install @mdzip/core-js
@mdzip/editor — the embeddable workspace editor used by Studio, the VS Code extension, and this site. Use it from vanilla JavaScript or through a first-class framework wrapper:
@mdzip/editor— JavaScript / TypeScript@mdzip/editor-ng— Angular@mdzip/editor-vue— Vue@mdzip/editor-react— React
See it live — the demo exercises all four.
npm install @mdzip/editor
Source: mdzip-project/mdzip-core-js · mdzip-project/mdzip-editor
.NET (NuGet)
mdzip-core — the C#/.NET core library behind the mdz CLI: read, inspect, validate, edit, and package archives from .NET 8 or .NET 10.
dotnet add package mdzip-core
Source: mdzip-project/mdzip-core
Format details
These tools implement the MDZip specification — read it for the normative format rules, or try the editor to see the format in action.
This page renders from tools.mdz — one self-contained file. Download it, open it in the web editor, or read how these pages are made.