• Pricing
  • CLI
  • FAQ
  • Blog
  • Docs
    • Sign InSign Up

    PocketAlert CLI

    Choose your platform and architecture to download the pre-built binary.

    Linux AMD64
    Linux ARM64
    macOS Intel
    macOS Apple Silicon
    Windows AMD64

    Installation Instructions

    Linux/macOS:

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

    Windows:

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

    After installation, verify it works by running: pocketalert --help

    Quick Start

    1. Authenticate:

    pocketalert auth <your-api-key>

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

    2. Send a notification:

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

    For more examples including CI/CD integration, cron jobs, and webhook creation, see the full CLI Documentation.

    Why Use PocketAlert CLI?

    Automate Your Workflow

    Integrate notifications directly into your scripts, CI/CD pipelines, and automation tools. No need to open a browser or use a web interface.

    Full API Access

    Manage all aspects of your PocketAlert account from the command line: messages, applications, devices, webhooks, and API keys.

    Fast and Efficient

    Send notifications instantly from your terminal. Perfect for monitoring scripts, deployment notifications, and system alerts.

    FAQ

    What is PocketAlert CLI?

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

    How do I authenticate with the CLI?

    After installing the CLI, run `pocketalert auth ` to authenticate. You can get your API key from the PocketAlert Settings page. The API key is stored securely in `~/.pocketalert/config.json`.

    What platforms are supported?

    PocketAlert CLI is available for Linux (AMD64 and ARM64), macOS (Intel and Apple Silicon), and Windows (AMD64). Pre-built binaries are provided for all supported platforms.

    How do I send a notification?

    You can send a notification using the `pocketalert send -t "Title" -m "Message"` command. You can also specify an application, device, or send to all devices using additional flags.

    Can I use CLI in CI/CD pipelines?

    Yes! The CLI is perfect for CI/CD integration. You can send notifications from GitHub Actions, GitLab CI, Jenkins, and other CI/CD systems. Just authenticate once and use the CLI commands in your pipeline scripts.

    Is the CLI secure?

    Yes, the CLI stores your API key securely in `~/.pocketalert/config.json` with file permissions 600. The config directory is created with permissions 700. All tokens are transmitted via HTTPS, and the API key is sent in the Token header.