Voiden.md

Why Voiden

Voiden is an offline API client that helps developers, QA and technical writers build, test, collaborate and document APIs in one place. With a programmable interface (/slash commands) and an agent-friendly CLI, Voiden adapts to how engineers already work. Voiden is built with Electron, Typescript and Javascript, and it doesnt require an account to use it.

No telemetry, no VC funding, and no cloud lock-in.

✨ Features:

Voiden supports all major API protocols:

• Supports REST, GraphQL, Grpc, Web-Sockets. All these are plugins that you can install or uninstall according to your needs. Community plugins available: https://voiden.md/plugins
• Import collections from Postman, Insomnia and Swagger/ OpenAPI.

Single Source of truth for all API work in the same file:

• Keep API requests, tests, notes and docs together in the same executable.void files. Keep everything in one format and one workflow.
• Requests can be composed by API building blocks (endpoint, auth, params, body). Decompose requests into blocks. Reuse the same blocks across files, like functions.
• Work in Markdown and structured blocks instead of opaque collections locked inside an app.
• Test and document APIs without leaving the editor.

Workflows:

• Scripting: Execute JavaScript, Python, or Shell scripts before sending requests and after receiving responses.
• Stitch runner: Batch-execute multiple .void files sequentially. Supports glob patterns, stop-on-failure, variable isolation, configurable delays, and environment selection.

Collaboration:

• Collaborate with Git branches and pull requests instead of proprietary team workspaces.
• Stay local-first with no signup and no required cloud sync.

AI Friendly:

• No proprietary workspace. No binary exports. Pure text all the way down, diffable like code, greppable, AI-editable, and merge-friendly.
• Supports Voiden skills for Claude and Codex agents.
• MCP support — connect Claude Code or Codex directly to a project so they can run your .void requests themselves, or serve your own requests as tools other agents can call. See the MCP docs.

Voiden Runner: A headless CLI for running those .void files outside the desktop app, directly in the terminal.

• runs on Node.js 18+
• works in terminal, CI/CD, Docker, and cron jobs
• supports REST, WebSocket, gRPC, and GraphQL
• supports request chaining through runtime variables
• works with core Voiden plugins like scripting, assertions, faker, advanced auth, + more.

Install

Current version: 2.3.3 (stable)

Download installers for macOS, Windows, and Linux from voiden.md/download. Direct downloads are available for Apple Silicon and Intel macOS, Windows .exe, and Linux .deb, .rpm, and .AppImage builds.

Windows note (starting v2.1.1): the Windows installer is now signed via Azure Trusted Signing instead of our previous certificate provider. Because of this change, you may see a "Windows protected your PC" SmartScreen dialog during install — the installer is signed and verified, this is expected while the app builds up download reputation with Microsoft. Click "More info" → "Run anyway" to proceed.

Package managers

Platform	Stable	Early access
macOS	Homebrew, Nix	Homebrew (voiden@beta), Nix
Windows	winget, Chocolatey	winget (Voiden.Voiden-Beta)
Linux	Flatpak, Homebrew, apt, snap, Nix	Beta apt and snap channels, Nix

macOS

Homebrew

brew install voiden

# beta
brew install voiden@beta

Windows

winget

winget install --id Voiden.Voiden -e

Chocolatey

choco install voiden

# beta (winget)
winget install --id Voiden.Voiden-Beta -e

Linux

Flatpak (any distro)

flatpak remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak install flatpark md.voiden.Voiden

Homebrew on Linux

brew tap voidenhq/voiden
brew trust voidenhq/voiden
brew install voidenhq/voiden/voiden

APT (Ubuntu / Debian)

curl -fsSL https://voiden.md/apt/stable/voiden.gpg | sudo gpg --dearmor -o /etc/apt/keyrings/voiden.gpg
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/voiden.gpg] https://voiden.md/apt/stable stable main" | sudo tee /etc/apt/sources.list.d/voiden.list
sudo apt update && sudo apt install voiden

# beta
curl -fsSL https://voiden.md/apt/beta/voiden.gpg | sudo gpg --dearmor -o /etc/apt/keyrings/voiden-beta.gpg
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/voiden-beta.gpg] https://voiden.md/apt/beta beta main" | sudo tee /etc/apt/sources.list.d/voiden-beta.list
sudo apt update && sudo apt install voiden

Snap

sudo snap install voiden
# beta
sudo snap install voiden --channel=beta

Nix (Linux / macOS)

One-time setup — trust the voiden Cachix binary cache so Nix fetches a prebuilt result instead of compiling Electron and native modules from source (the default multi-user Nix install won't honor a flake's own substituter config without this):

nix run nixpkgs#cachix -- use voiden

Then run Voiden directly using Nix Flakes:

nix run github:VoidenHQ/voiden

If you skip the cachix use step, nix run still works — Nix just falls back to building from source, which is slower.

Looking for newer builds? Check the early access section on voiden.md/download.

Get started with Voiden

1. Install Voiden and open it. No signup or login is required.
2. Create a .void file in any folder and add your request, docs, and reusable blocks.
3. Run the request with Cmd+Enter or Ctrl+Enter, then commit the file to Git.

This is the beginning of the README. Read the rest at the original. Read the full README ↗