README.md

pi [pí]

Description

pi ([pí]) is a CLI tool for Pixela (pixe.la)

Installation

% go install github.com/a-know/pi/cmd/pi@latest

OR

% brew install a-know/tap/pi

And, there is explanation blog entry; "草APIサービス" Pixela のコマンドラインツールを作ったので、OSごとのインストール・使い方を書きます！ (in Japanese)

Synopsis

% pi users create --username a-know --token thisissecret --agree-terms-of-service yes --not-minor yes
% export PIXELA_USER_TOKEN=thisissecret
% export PIXELA_USER_NAME=a-know
% pi graphs create -g my-first-graph -n "My first graph" -i commits -t int -c shibafu -z "Asia/Tokyo" -s none
% pi pixel post -g my-first-graph -d 20190101 -q 5 -o "{\"key\":\"value\"}"
% pi graphs svg -g my-first-graph | xargs open

Available commands

  graphs    operate Graphs
  pixel     operate Pixel in Graph
  users     operate Users
  version   display version
  webhooks  operate Webhooks

Subcommands

users

  create  create User
  delete  delete User
  update  update User Token

graphs

  create  create Graph
  delete  delete Graph
  detail  get Graph detail URL
  get     get Graph Definitions
  pixels  get Graph Pixels
  svg     get SVG Graph URL
  update  update Graph Definition
  stats   get Graph stats

pixel

  decrement  decrement a Pixel
  delete     delete a Pixel
  get        get a Pixel
  increment  increment a Pixel
  post       post a Pixel
  update     update a Pixel

webhooks

  create  create a Webhook
  delete  delete a Webhook
  get     get registered Webhooks
  invoke  invoke Webhook

Options

Please see the running result each subcommands with -h.

CI running count

References

Pixela API Document

Author

a-know