Wanted to provide an update around the CLI runner that we shipped a few days ago. This was already on beta for quite some time so now that its on stable, I thought of giving it another go in the community.
For those who are not familiar with the tool and what the h#$@ I am talking about: Voiden is an offline, git-native API tool built on Markdown.
We built it (and then open sourced it) because API tooling sucked (and we work a lot of APIs enough to care to do something about it). I will just name a few issues: cloud dependencies, forced accounts, proprietary formats plus many more.
Long story short, this is Voiden: instead of keeping API requests inside a cloud workspace, Voiden stores them as .void files that can live with your codebase, be versioned in Git, reviewed in PRs, and reused across a team. Plus everything is plain executable markdown. By “everything” I mean really everything: API specs, tests, docs, context…everything.
We have now released the @voiden/runner, which is a headless CLI for running those .void files outside the desktop app.
The runner executes the requests, prints the results, and exits with a standard exit code that CI systems can use.
Things to note:
- 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.
The ultimate goal is to make .void files executable API workflows, not just files used inside the desktop app.
The Github repo: https://github.com/VoidenHQ/voiden
Voiden CLI Runner : https://github.com/VoidenHQ/voiden/tree/beta/packages/voiden-runner
Visit Voiden here : https://voiden.md/
P.S this post is mainly around the Runner but every feedback outside that is also welcome, especially coming from any postman or insomnia power users in the room :)
Hey yes will do. Flatpak is something we see considering/working on.
Notion in the sense that it adapts to the user. We like this idea : that you can use Notion for literally Amy document you want.
In the same way, when one open Voiden they can “program” the interface with slash commands and add headers, auth, documentation etc in any way they like. So in Voiden we bring specs, tests and docs together in one single file. In the same way that you can use notion to bring different lists, blogs, ideas etc into the same place and collaborate. The difference and the power of Voiden is that everything you add in the Voiden doc is executable, meaning you can run the tests in the same place and keep the docs and the context (that might be on slack or anywhere else devs talk) together.
Basically the notion like refers to the philosophy of the tool to not force a fixed UI to the user and allow for different use cases and scenarios. Does it make sense?
We are also calling it Lego for APIs for the same reason plus because of the fact that you can use blocks to compose requests but also reuse them for multiple requests that share some similar components.