Go to file
Netscape Navigator 73ad2a1c46 Remove pigeon.exe from source control 2020-09-27 19:15:00 -05:00
project Fix issue with uncommited transaction 2020-09-27 08:46:44 -05:00
.gitignore Remove pigeon.exe from source control 2020-09-27 19:15:00 -05:00
LICENSE Hello, world! 2020-08-02 13:59:32 -05:00
README.md Remove pigeon.exe from source control 2020-09-27 19:15:00 -05:00
build.sh Add Windows build to build.sh. Switch from `ql` to `sqlite3`. 2020-09-27 08:25:14 -05:00
coverage.sh getPeerStatus() helper- required for `peer show` command. 2020-09-14 08:11:02 -05:00
tests.sh Directory cleanup 2020-09-10 07:33:41 -05:00

README.md

Pigeon CLI

A single executable to manage a Pigeon node.

Project Status

Don't use the Go version yet. If you want something stable, there is a Ruby version that is feature complete.

Setup

By default, data is stored in ~/.pigeon. You can override this value by specifying a PIGEON_PATH ENV var.

TODO

  • Add a real testing lib to DRY things up.
  • Figure out a system for where to place the default data storage directory
  • Get a good CI system going? Run tests at PR time, provide prebuilt binaries, prevent coverage slips, etc..
  • Add a transact() helper to ensure all transactions are closed out.
  • Finish all the things below:
Done? Noun Verb Flag / arg 1 Flag 2
peers list
peer untrack peer mhash
blob create file path
blob create pipe
blob find
draft create
draft publish
draft show
draft update --key=? --value=?
message find --all
message find --last
message show message mhash
bundle create
bundle ingest
X peer block peer mhash
X peer follow peer mhash
X identity show
X identity create
X help
X version

Run Tests

Without coverage:

./tests.sh

With coverage:

./coverage.sh

Build Project

./build.sh