Pigeon CLI

[Incubating]

A CLI tool for project Pigeon.

Getting Start

Download

if you have node.js installed upon you machine, you can install pigeon-cli via npm by use the command below

$ npm install -g @pigeon-cp/pigeon-cli

otherwise download the executable binary file from releases.

Create Plugin

$ pigeon-cli plugin [type]      # create new empty plugin project

Plugin Debug

$ cd /path/to/plugin        # cd plugin project dir
$ vim debug.properties      # config Pigeon application
$ pigeon-cli debug          # start Pigeon application on debug mode

Manage Pigeon Instance

$ pigeon-cli
> pigeon.messages.send()

Migrate DB

$ pigeon-cli migrate [type]     # type: mysql or sqlite

and then select db version you want to migrate to.

References

$ pigeon-cli --help
$ pigeon-cli [sub-command] --help

run command above for more informations.