Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 909 Bytes

README.md

File metadata and controls

28 lines (21 loc) · 909 Bytes

Pavlok CLI and API wrapper written in Go

This package provides a simple CLI and Go API wrapper for the Pavlok smartwatch's API.

CLI Installation

Install Go and run the following:

go install github.com/carreter/pavlok-go/cmd/pavlok-cli@latest

Also ensure that $GOPATH/bin is in your PATH.

Now you're all set to start zapping away!

Usage:

Get an API key by signing in to the Pavlok API docs with the same email as the Pavlok account your device is registered to.

To send a stimulus, run pavlok-cli [flags] <stimulus type>.

Allowable stimulus types:

  • zap: Zaps the user.
  • beep: Emits a beep.
  • vibe: Vibrates the device.

Flags:

  • --apikey (string, required): The API key.
  • --reason (string): The reason for the stimulus.
  • --value (int): The value (strength) of the stimulus.