https://github.com/a-know/pi

Official CLI tool for Pixela
https://github.com/a-know/pi

golang pixela

Last synced: about 2 months ago
JSON representation

Official CLI tool for Pixela

• Host: GitHub
• URL: https://github.com/a-know/pi
• Owner: a-know
• License: mit
• Created: 2019-02-16T03:17:02.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T12:39:20.000Z (almost 2 years ago)
• Last Synced: 2024-06-19T00:33:55.445Z (7 months ago)
• Topics: golang, pixela
• Language: Go
• Homepage: https://pixe.la
• Size: 3.66 MB
• Stars: 38
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# pi [pí]

[![Travis Build Status](https://travis-ci.org/a-know/pi.svg?branch=master)][travis]

[![pixela][pixela-badge]][pixela]

[travis]: https://travis-ci.org/a-know/pi

[pixela-badge]: https://pixe.la/v1/users/pi/graphs/ci-count.svg?mode=badge

[pixela]: https://pixe.la/v1/users/pi/graphs/ci-count.html

## Description

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

![](https://user-images.githubusercontent.com/1097533/53243207-84d04680-36ea-11e9-8465-f73d62b4b502.png)

## 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ごとのインストール・使い方を書きます！](https://blog.a-know.me/entry/2019/02/24/214142) (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

```sh

  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

[![CI running count](https://pixe.la/v1/users/pi/graphs/ci-count)][ci-count]

[ci-count]: https://pixe.la/v1/users/pi/graphs/ci-count.html

## References

[Pixela API Document](https://docs.pixe.la/)

## Author

[a-know](https://github.com/a-know)