light_mode
dark_mode

Clients

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

Platform / Language Client
Shell Boomack Client CLI
Shell Boomack Client CLI (NodeJS)
JavaScript BoomackJS
.NET, C# NBoomackClient
Rust Boomack Library for Rust

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 Boomack Client CLI 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 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

The Boomack Client CLI (boom command) implemented in Rust.

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

The Boomack Client CLI is part of the Windows MSI Installer package.

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/boom/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 currently supports the same feature set and command line arguments as the NodeJS based Boomack Client CLI, and can therefore 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 Client CLI (NodeJS)

The NodeJS version of the Boomack Client CLI (boom command), based on the BoomackJS library. It precedes the faster Rust implementation and serves as a reference implementation.

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

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/