Clients

The following table lists Boomack API clients ordered by platform or programming language respectively.

The Boomack API can be used directly, e. g. with cURL or with an HTTP client library in the programming language of your choice. But, using one of the client tools or libraries listed here makes your life much easier.

For starters, the Client CLI (boom) is certainly a good choice, to get familiar with the system. It can be used in a shell or command line, and therefore, in shell scripts. If the NodeJS-based client is too slow for your usecase, try the Fast Client CLI (bo). But it might not implement all features, the NodeJS-based CLI provides.

If you like to interact with a Boomack Server from your programming language, you need to check if a library for your language is already listed here. If not, you can still use the API Reference to use a generic HTTP client library in you language to make the desired requests — only with a little less comfort.

Boomack Client CLI (boom)

The Boomack Client CLI (boom command) is implemented in JavaScript for NodeJS, and is based on the BoomackJS library. It precedes the faster Rust version and serves as a reference implementation. New features for the client CLI are first implemented and evaluated in the NodeJS version, before they get eventually ported to the faster Rust version.

Take a look at the documentation for a description of the CLI with its sub-commands and options.

npm package

npm install --global boomack-cli

You can find the documentation here: https://boomack.com/docs/boomack-client-cli.html

Boomack Fast Client CLI (bo)

The Boomack Fast Client CLI (bo command) is implemented in Rust.

Take a look at the documentation for a description of the CLI with its sub-commands and options.

To install it under Linux, run the following one-liner. It will download the compressed binary, verify the checksum, extract the archive, and install the binary into /usr/local/bin.

wget -q -O - https://download.boomack.com/fast-client-cli/install.sh | sh

Additionally, you can manually download the compressed binary from the download page.

If you have a Rust development environment, you can also install it from source:

cargo install boomack-cli

The Rust version might miss some features the NodeJS based Boomack Client CLI provides. But in general the command line arguments are kept compatible. Therefore, in most cases it can serve as a faster drop-in replacement. Its main purpose is to allow performant shell scripted interactions with the Boomack Server.

You can find the documentation here: https://boomack.com/docs/boomack-client-cli.html

Boomack VS Code Extension

The Boomack VS Code Extension allows interacting with a Boomack Server from within the Visual Studio Code IDE. It also includes the Boomack Server, so that a local server can be run from within the IDE as well.

The extension ID is mastersign.boomack-vscode.

The extension can be installed from within VS code by simply searching for Boomack in the extension panel.

BoomackJS

A JavaScript library for NodeJS.

npm package

npm install --save boomack-js

You can find the documentation here: https://docs.boomack.com/client/boomack-js

NBoomackClient

A OS independent .NET library for .NET Standard 2.0 and therefore, usable in .NET Framework ≥ 4.6.1, .NET Core ≥ 2.0, .NET ≥ 5.0, Mono, and Xamarin.

NuGet Gallery

dotnet add package NBoomackClient

You can find the documentation here: https://docs.boomack.com/client/NBoomackClient

Boomack Library for Rust

A Rust library, based on ureq and serde, making it easy to communicate with a Boomack Server.

Crate

Add the following line(s) to your Cargo.toml:

[dependencies]
boomack = 0.3

Or, call cargo add:

cargo add boomack

You can find the documentation here: https://docs.rs/boomack/