Install Thrum

The Thrum CLI lets you manage HEARTBEAT snippets from your terminal.

npm install -g thrumhub

Once installed, the CLI command is thrum.

Quick Start

  1. 1

    Initialize your HEARTBEAT.md file

    thrum init
  2. 2

    Find a snippet from the registry

    thrum search weather
  3. 3

    Add the snippet to your HEARTBEAT

    thrum add <snippet-id>

Commands

thrum init

Initialize a HEARTBEAT.md file in the current directory with thrum-zone markers. This sets up the file structure that Thrum uses to manage your snippets.

thrum init

thrum search

Search the ThrumHub registry for snippets. Filter results by category or frequency.

thrum search <query>
thrum search weather -c utilities
thrum search backup -f daily

thrum add

Install a snippet from the registry into your HEARTBEAT.md. If the snippet has variables, you'll be prompted to fill them in.

thrum add <snippet-id>

thrum remove

Remove an installed snippet from your HEARTBEAT.md.

thrum remove <snippet-id>

thrum list

List all snippets currently installed in your HEARTBEAT.md.

thrum list

thrum doctor

Validate your HEARTBEAT.md setup. Checks for correct thrum-zone markers, snippet formatting, and potential issues.

thrum doctor