2020-08-02 18:59:32 +00:00
# Pigeon CLI
A single executable to manage a Pigeon node.
2020-08-11 12:25:45 +00:00
# Project Status
2020-08-23 23:23:17 +00:00
Don't use the Go version yet. If you want something stable, there is a [Ruby version that is feature complete ](https://tildegit.org/PigeonProtocolConsortium/Pigeon-Ruby ).
2020-08-11 12:25:45 +00:00
2020-09-11 12:12:51 +00:00
# Setup
By default, data is stored in `~/.pigeon` .
You can override this value by specifying a `PIGEON_PATH` ENV var.
2020-10-05 13:07:43 +00:00
# Help Wanted
Want to get involved? Below are a few things I need help with.
Email `contact@vaporsfot.xyz` if you have any questions.
* Writing a BNF grammar for message parsing
* Test coverage increases
* Manual QA of features and edge cases
* Cross-compiling windows binaries
* General Golang help (I am a Golang novice- project structure could be improved)
2020-08-11 12:25:45 +00:00
# TODO
2020-08-10 12:19:20 +00:00
2020-10-05 13:07:43 +00:00
**CURRENT TASK:** Write a message parser.
2020-08-19 12:36:37 +00:00
- [ ] Add a real testing lib to DRY things up.
2020-09-01 12:52:44 +00:00
- [ ] Get a good CI system going? Run tests at PR time, provide prebuilt binaries, prevent coverage slips, etc..
2020-09-28 00:15:00 +00:00
- [ ] Add a `transact()` helper to ensure all transactions are closed out.
2020-09-28 00:56:55 +00:00
- [ ] Switch to [SQLX ](https://github.com/jmoiron/sqlx ) for extra sanity.
2020-10-01 13:00:15 +00:00
- [ ] Write docs for all CLI commands / args AFTER completion.
2020-08-10 12:19:20 +00:00
- [ ] Finish all the things below:
2020-09-17 12:59:03 +00:00
|Done?|Noun |Verb | Flag / arg 1 | Flag 2 |
2020-09-15 12:50:48 +00:00
|-----|------------|-----------|---------------|-----------|
2020-10-05 13:07:43 +00:00
| |blob |remove | mhash | |
2020-10-04 20:19:28 +00:00
| |bundle |ingest | | |
| |message |show | message mhash | |
| |message |find | --all | |
| |message |find | --last | |
2020-09-18 12:45:40 +00:00
| |draft |create | | |
2020-09-15 12:50:48 +00:00
| |draft |publish | | |
| |draft |show | | |
| |draft |update | --key=? | --value=? |
2020-09-18 12:45:40 +00:00
| |bundle |create | | |
2020-10-01 13:00:15 +00:00
| X |blob |find | | |
2020-09-30 12:56:20 +00:00
| X |blob |add | file path | |
2020-10-01 13:00:15 +00:00
| X |blob |add | STDIO pipe | |
2020-09-28 01:21:49 +00:00
| X |peer |untrack | peer mhash | |
| X |peers |list | | |
2020-09-18 12:45:40 +00:00
| X |peer |block | peer mhash | |
| X |peer |follow | peer mhash | |
2020-09-15 12:50:48 +00:00
| X |identity |show | | |
| X |identity |create | | |
| X |help | | | |
| X |version | | | |
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
# Run Tests
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
Without coverage:
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
```
2020-09-10 12:29:15 +00:00
./tests.sh
2020-08-11 12:25:45 +00:00
```
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
With coverage:
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
```
2020-09-10 12:29:15 +00:00
./coverage.sh
2020-08-11 12:25:45 +00:00
```
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
# Build Project
2020-08-10 12:19:20 +00:00
2020-08-11 12:25:45 +00:00
```
2020-09-10 12:33:41 +00:00
./build.sh
2020-08-11 12:25:45 +00:00
```
