Go Puffery 🐡

Read and send push notifications to your iOS device from your command line with Puffery.

If you want to build an app on top of Puffery, you can also use github.com/vknabel/puffery-go as a library.

In case you need inspiration or help, head over to our GitHub discussions!

Installation

The easiest way to install and update Puffery on macOS or linux is Homebrew.

brew install vknabel/install/puffery

Using Go

If you are a gopher and want to install it globally, just run:

go install github.com/vknabel/go-puffery@latest

In case you plan to write custom tooling on top of Puffery, start by adding to to your Go module.

go get github.com/vknabel/go-puffery@latest

Manual installation

If you are neither using Homebrew nor Go, head over to the GitHub releases page and pick the latest version that fits your operating system and architecture.

Unpack the archive and move it to a location of your choice, preferably into a directory in your $PATH.

Current Status

Currently go puffery is still in early development and doesn't yet support all features of the Puffery iOS App.

• Logging in and out
• Displaying all channels
• Displaying all messages
• Sending push notifications
• Sending push notifications with colors
• Creating and subscribing to channels
• Displaying stats of a channel

Embedding puffery in your app

The main puffery module exports the whole API and all of its models. Start by creating a new Api

import (
    puffery "github.com/vknabel/go-puffery"
)

var pufferyApi = puffery.New()

err := pufferyApi.Hello()
if err != nil {
    panic(err)
}

Most endpoints require setting the token - either by confirming a login challenge (*Api) ConfirmLogin or by registering a new user (*Api) Register.

If you want to handle the session yourself, feel free to call (*Api) SetToken manually.

License

go-puffery is licensed under the MIT license.