Skip to content

Latest commit

 

History

History
128 lines (87 loc) · 2.54 KB

README.md

File metadata and controls

128 lines (87 loc) · 2.54 KB

apns

A command line tool to send push notifications using the Apple Push Notification Service.

Compatible with macOS 13+

Documentation

Send alert notifications

This command sends a user visible push notification to the device, with the given title and body:

apns send alert \
    -k private-key.p8 \
    --key-id ABCD123456 \
    --team-id ABCD123456 \
    -t com.example.app \
    -d <device-identifier> \
    --title "Hello world!" \
    --body "How are you?" \
    --sound

By default, it uses the sandbox APNS server. Add the -p flag to switch to production.

You can add a custom JSON payload to your notification:

apns send alert \
    -k private-key.p8 \
    --key-id ABCD123456 \
    --team-id ABCD123456 \
    -t com.example.app \
    -d <device-identifier> \
    --title "Hello world!" \
    --body "How are you?" \
    --sound \
    '{"hello":42}'

For more information:

apns send alert --help

Send background notifications

This command sends a background push notification to the device, with the given custom payload:

apns send background \
    -k private-key.p8 \
    --key-id ABCD123456 \
    --team-id ABCD123456 \
    -t com.example.app \
    -d <device-identifier> \
    '{"hello":42}'

For more information:

apns send background --help

Installation

Homebrew

You can install the CLI using Homebrew:

brew install tdimeco/apps/apns

This is the recommended way to install the CLI. The CLI auto updates with Homebrew.

Manual

You can download a precompiled executable from the Releases page. The installer package is signed and notarised by Apple, it just installs the apns executable into /usr/local/bin.

To uninstall, just remove /usr/local/bin/apns.

The CLI does not auto update in this case.

Build

Requirements

  • Xcode 15.4+ with Swift 5.10

Build for local deployment

Build the executable using:

make

Then move the .build/release/apns executable to one of your $PATH directory. You can run make install to do it for you in the /usr/local/bin/ directory:

sudo make install

To uninstall, just run:

sudo make uninstall

Build for public distribution

For distribution, build the universal fat-executable using:

make build-universal

The universal executable is located at .build/apple/Products/Release/apns.

This allows the executable to run on both Intel and Apple Silicon Macs.