Command-line interface

Push notifications, from your terminal.

Send alerts, manage devices, applications, and webhooks straight from your shell. One static binary, zero dependencies — built for scripts, cron jobs, and CI/CD.

Push in <1sSingle binary · no depsLinux · macOS · Windows
# Fire a notification from anywhere
pocketalert send -t "Deploy finished" -m "v2.4.0 is live 🚀"
✓ delivered  · 1 device · 0.4s
Features

The whole API, one command away

Everything PocketAlert does, wired into the tools you already live in — your shell, your scripts, your pipelines.

Scriptable by design

Drop notifications into any script, Makefile, or one-liner. No browser, no dashboard — just your shell.

Cross-platform

Single static binary for Linux, macOS (Intel & Apple Silicon), and Windows. No runtime, no dependencies.

Built for CI/CD

Wire alerts into GitHub Actions, GitLab CI, Jenkins, or any pipeline. Authenticate once, send everywhere.

Full API access

Everything the API can do: messages, applications, devices, webhooks, and API keys — straight from the terminal.

Secure by default

API key stored at ~/.pocketalert/config.json with 600 perms, sent over HTTPS in the Token header.

Sub-second delivery

Push hits your phone in under a second. Perfect for monitoring scripts, deploys, and system alerts.

Get started

Three steps to your first push

1

Install the binary

Grab the binary for your platform, move it into your PATH, and run pocketalert --help.

2

Authenticate

Run pocketalert auth <your-api-key> once. Your key lands in ~/.pocketalert/config.json.

3

Send your first push

Fire pocketalert send -t "Title" -m "Message" — your phone buzzes a moment later.

Download

Grab your binary

Pick your platform and architecture — pre-built, ready to drop into your PATH.

Linux AMD64Linux ARM64macOS IntelmacOS Apple SiliconWindows AMD64

Installation

Linux / macOS

sudo mv pocketalert /usr/local/bin/
chmod +x /usr/local/bin/pocketalert

Windows

Add the path to the binary to your PATH environment variable.

Then verify it works by running pocketalert --help.

Quick start

1. Authenticate

pocketalert auth <your-api-key>

Get your API key from API Keys. It is stored securely in ~/.pocketalert/config.json.

2. Send a notification

pocketalert send -t "Hello" -m "World!"

For CI/CD integration, cron jobs, and webhook creation, see the full CLI documentation.

FAQ

Questions, answered

PocketAlert CLI is a command-line interface that lets you manage notifications, applications, devices, webhooks, and API keys directly from your terminal. It is a convenient way to interact with the PocketAlert API without a browser.

After installing the CLI, run pocketalert auth <your-api-key> to authenticate. Grab your API key from the PocketAlert Settings page. It is stored securely in ~/.pocketalert/config.json.

PocketAlert CLI ships for Linux (AMD64 and ARM64), macOS (Intel and Apple Silicon), and Windows (AMD64). Pre-built binaries are provided for every supported platform.

Send one with pocketalert send -t "Title" -m "Message". You can also target a specific application, device, or broadcast to all devices using extra flags.

Absolutely — the CLI is built for CI/CD. Send notifications from GitHub Actions, GitLab CI, Jenkins, and more. Authenticate once and call the CLI from your pipeline scripts.

Yes. The CLI stores your API key in ~/.pocketalert/config.json with file permissions 600, inside a config directory created with 700. All traffic goes over HTTPS, and the key is sent in the Token header.

Your terminal just got a notification channel

Grab the binary, authenticate once, and send your first push from the terminal in under a minute.