Documentation

Milkman - An Extensible Request/Response Workbench

Download

• Download latest version in Release Section. Or download Nightly version for latest changes.
• Download plugin archive as well, if you want to use any of those plugins.
• unzip everything into the same directory and start application via either the supplied start-scripts or milkman.exe

Install via Chocolatey (Win)

• To install just Milkman run Choco install milkman
• To install a plugin run Choco install milkman-<plugin name> ex. Choco install milkman-explore
• Install Milkman and all plugins available run Choco install milkman-plugins
• Milkman will be installed under C:\tools\milkman.

Install via Homebrew (MacOs)

• To install, run brew install --cask milkman. All plugins are included.
• To update, run brew upgrade --cask

Changes

latest changes can be seen in the Changelog

FAQ

some resolved issues and FAQs are available in the wiki. If you have any questions, create a new Issue or ask in Discussions.

Features

• Everything is a plugin: Request-types (e.g. Http Request), request-aspects (e.g. Headers, Body, etc), editors for request aspects (e.g. table-based editors for headers), importers, whatever it is, you can extend it. The core application only handles Workspaces with Environments, Collections, Requests and their aspects.
• Http Request Plugin: Several plugins are provided already that extend the core application to be a replacement for postman. Crafting and Executing Http/Rest requests with json highlighting. Support Proxy-server configuration and SSE.
• Grpc Plugin: support of Grpc Services, Server Reflection and Streaming
• Test Runner: run several requests as separate test-scenario
• JavaFX Application: as in: fast (compared to electron at least :D) and skinn-able (you can extend milkman with your own themes using simple CSS).
• Commandline Interface: there is a command line interface for Milkman which allows to edit/execute requests on your command line.
• Slack Command: you can use /milkman <privatebin-url> in slack to share requests in a better way. More Info.
• Some more details of the core application features, such as hotkeys etc.

Existing Plugins:

Note: see respective plugin folder for more details

Http Request Plugin: (included in main distribution)

The Http request plugin packaged with the release contains all means to do http request as well as import collections, environments or dumps from postman. To migrate from postman, just export a dump-file from postman and import it by pasting its content into the Postman (v2.1) Dump-Importer. The Http Request Plugin also comes with Proxy-support. Some proxies require credentials and support for supplying BASIC proxy credentials is built into the plugin. See Options-page to activate that as it is off by default. Additionally, the plugin supports chunked responses, enabling testing of Server-sent events (SSE).

Graphql Plugin

Simple Graphql Plugin to craft GraphQL requests. No Auto-complete or schema valiadtion included.

Grpc Plugin

Grpc plugin with server-reflection support and streaming-support. Can also query via proto-defintion.

JDBC Plugin

This plugin introduces SQL capability to milkman. You can query SQL databases via milkman as well, using JDBC drivers.

Cassandra Plugin:

Allows to execute CQL queries for given cassandra databases.

Git Team Synchronization Plugin

This plugin allows to synchronize workspaces via Git (using Differential Synchronization). Teams can use this plugin to have a shared workspace that synchronizes between members.

Explore Plugin:

This plugin extends Rest-responses by adding an Explore-Tab where you can use JMesPath queries against a JSON response.

Scripting Plugin:

Extends requests by executing a script after request execution. This allows to e.g. set environment variables based on results of json.

PrivateBin Sharing Plugin

Adds capability to share requests via PrivateBin, including Burn After Reading feature

Note Plugin:

This is a sample plugin that allows to add arbitrary description to every request. Serves as a starting point for learning to extend milkman.

Test Plugin

A testrunner plugin that allows to run multiple requests in sequence and verify the results

Auth Plugin

An OAuth Plugin for managing oauth credentials and transparent refreshing of tokens

Websocket Plugin

A websocket plugin for interacting with websocket endpoints

Socket.IO Plugin

A Socket.IO plugin for interacting with Socket.IO endpoints

Showcase

Plugins

No client fits all, so you are encouraged to write your own plugins to e.g. add headers that are necessary for your internal service structures or add importers for internal service registries.

A sample plugin was provided that extends all requests with a Note tab so you can add some description to any kind of requests.

More details about developing plugins can be found in the plugin development guide.

Installation: all plugins are to be copied to the /plugins folder

Changes

latest changes can be seen in the Changelog