# boomack

> web app for displaying hyper-media items in concert with e.g. an IDE

Latest version **0.15.12** (published 2026-04-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install boomack
pnpm add boomack
yarn add boomack
bun add boomack
```

Provides the command `boomack`.

## Health

**Score 50/100 (C)** — status: active.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; large bundle; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.15.12 |
| Published | 2026-04-11 |
| First published | 2019-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >= 20.0.0 |
| Dependencies | 0 |
| Unpacked size | 25 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tobias Kiertscher |
| Maintainers | mastersign |

## Links

- npm: https://www.npmjs.com/package/boomack
- Repository: https://git.mastersign.de/tk-software/boomack
- npm.io page: https://npm.io/package/boomack

## Recent versions

- 0.15.12 (latest) — 2026-04-11
- 0.15.0-preview7 (preview) — 2025-11-24
- 0.15.11 — 2026-03-03
- 0.15.10 — 2026-02-12
- 0.15.9 — 2026-02-12
- 0.15.8 — 2026-02-12
- 0.15.7 — 2026-02-11
- 0.15.6 — 2026-02-11
- 0.15.5 — 2026-02-11
- 0.15.4 — 2025-12-31
- 0.15.3 — 2025-11-28
- 0.15.2 — 2025-11-28
- 0.15.1 — 2025-11-28
- 0.15.0 — 2025-11-25
- 0.15.0-preview6 — 2025-10-23
- … 68 more at https://npm.io/package/boomack/versions

## README

# Boomack

![Boomack Logo](artwork/logo-with-name.png)

> web app for displaying hyper-media items in concert with e.g. an IDE

Inspired by ideas from Daniel Kiertscher

## Requirements

* NodeJS ≥ 20

## Getting Started

1. Install the _Boomack_ server: `npm i -g boomack` (may require `sudo` on Linux)
2. Start the server listening at default port 3000: `boomack`
3. Open the display page in a browser: `http://127.0.0.1:3000/`
4. Send display requests via the HTTP API:

Bash:

```bash
curl -H "Content-Type: application/json" \
  -d '{"text":"Hello World!"}' \
  http://127.0.0.1:3000/v1/display
```

PowerShell:

```powershell
Invoke-WebRequest http://127.0.0.1:3000/v1/display `
    -Method Post `
    -ContentType application/json `
    -Body '{"text":"Hello World!"}'
```

## Use the Boomack CLI

1. Install the _Boomack_ CLI: `npm i -g boomack-cli` (may require `sudo` on Linux)
2. Send API requests:
    + Send plain text to the default slot in the default panel  
      `boom -s "Hello World!"`
    + Create new panel `demo` with two slots: `head` and `main`:  
      `boom panel add demo "{grid: {rows: 3}, slots: {head: {}, main: {row: 1, rowSpan: 2, history: 10}}}"`
    + List all existing panels:  
      `boom panel ls`
    + Send Markdown to the slot `head` in the panel `demo`:  
      `boom --target demo/head -s "# Demo" -t text/markdown`
    + Send a file to the slot `main` in the panel `demo`:  
      `boom --target demo/main -f ./my-code.js`

## Try out the demos

* Clone the repository
* Start a local _Boomack_ server: `boomack -b --panel default`
* Run scripts in `demo` folder, e. g.: `node demo/display-image.js`

## Development

* Install development dependencies: `npm i`
* Run tests: `npm test`
* Build docs: `npm run docs`
* Make sure, you have Gulp CLI installed: `npm i -g gulp-cli`
* Update vendor libraries
    + Update e.g. lodash: `npm upgrade lodash`
    + Copy web client dependencies from `node_modules` to client folder: `vendor`

---
_Source: https://npm.io/package/boomack · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._