experimental-cli/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](https://tildegit.org/PigeonProtocolConsortium/Pigeon-Ruby).

# Setup

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

# Help Wanted

Want to get involved? Below are a few things I need help with.

Email `contact@vaporsoft.xyz` if you have any questions.

 * Writing a BNF grammar for message parsing
 * Test coverage increases
 * Manual QA of features and edge cases
 * Providing constructive feedback on documentation
 * Cross-compiling windows binaries
 * Security auditing and vulnerability discovery. Please send security concerns to `contact@vaporsoft.xyz` privately.

# TODO

 - [ ] Add forgery protection tests
 - [ ] Add a real testing lib to DRY things up.
 - [ ] Validate and scrutinize `depth`, `prev` fields when ingesting message bundles to account for poorly written peer clients.
 - [ ] 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.
 - [ ] Switch to [SQLX](https://github.com/jmoiron/sqlx) for extra sanity.
 - [ ] Write docs for all CLI commands / args AFTER completion.
 - [ ] Start using the `check` helper instead of `error != nil`.
 - [ ] Update spec to only allow UPPERCASE MULTIHASHES
 - [ ] Implement `query.pgn` protocol, as outlined [here](%CSBzyskUxqbFSgOBh8OkVLn18NqX3zu3CF58mm2JHok=.sha256) and [here](%KWETmo1cmlfYK4N6FVL9BHYfFcKMy49E94XGuZSPGCw=.sha256).
 - [ ] Add a note about "shallow" vs. "deep" verification.
 - [ ] Finish all the things below

 |Done?|Noun        |Verb       | Flag / arg 1  | Flag 2    |
 |-----|------------|-----------|---------------|-----------|
 |     |bundle      |ingest     |               |           |
 |     |message     |show       | message mhash |           |
 |     |message     |find       | --all         |           |
 |     |blob        |remove     | mhash         |           |
 |     |message     |find       | --last        |           |
 |     |draft       |create     |               |           |
 |     |draft       |publish    |               |           |
 |     |draft       |show       |               |           |
 |     |draft       |update     | --key=?       | --value=? |
 |     |bundle      |create     |               |           |
 |  X  |blob        |find       |               |           |
 |  X  |blob        |add        | file path     |           |
 |  X  |blob        |add        | STDIO pipe    |           |
 |  X  |peer        |untrack    | peer mhash    |           |
 |  X  |peers       |list       |               |           |
 |  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
```
Hello, world! 2020-08-02 18:59:32 +00:00			`# Pigeon CLI`

			`A single executable to manage a Pigeon node.`

Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`# Project Status`

Minor typos, gitignore updates, removals 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).`
Add coverage profile stuff 2020-08-11 12:25:45 +00:00
Use a default data directory. 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.

Begin building message parser 2020-10-05 13:07:43 +00:00			`# Help Wanted`

			`Want to get involved? Below are a few things I need help with.`

Continue implementing and test bundle imports 2020-10-28 13:06:56 +00:00			Email `contact@vaporsoft.xyz` if you have any questions.
Begin building message parser 2020-10-05 13:07:43 +00:00
			`* Writing a BNF grammar for message parsing`
			`* Test coverage increases`
			`* Manual QA of features and edge cases`
:clap::tada: Message verification works on the Golang version! Hooray! 2020-10-15 12:30:30 +00:00			`* Providing constructive feedback on documentation`
Begin building message parser 2020-10-05 13:07:43 +00:00			`* Cross-compiling windows binaries`
:clap::tada: Message verification works on the Golang version! Hooray! 2020-10-15 12:30:30 +00:00			* Security auditing and vulnerability discovery. Please send security concerns to `contact@vaporsoft.xyz` privately.
Begin building message parser 2020-10-05 13:07:43 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`# TODO`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Remove Lipmaaa references 2020-11-08 21:34:29 +00:00			`- [ ] Add forgery protection tests`
Add B32Decode() 2020-08-19 12:36:37 +00:00			`- [ ] Add a real testing lib to DRY things up.`
Remove Lipmaaa references 2020-11-08 21:34:29 +00:00			- [ ] Validate and scrutinize `depth`, `prev` fields when ingesting message bundles to account for poorly written peer clients.
WIP need to re-do modules I think. 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..`
Remove pigeon.exe from source control 2020-09-28 00:15:00 +00:00			- [ ] Add a `transact()` helper to ensure all transactions are closed out.
`-- peer list` command 2020-09-28 00:56:55 +00:00			`- [ ] Switch to [SQLX](https://github.com/jmoiron/sqlx) for extra sanity.`
Blob stuff works. NEXT: Ingest a bundle. 2020-10-01 13:00:15 +00:00			`- [ ] Write docs for all CLI commands / args AFTER completion.`
Continue implementing and test bundle imports 2020-10-28 13:06:56 +00:00			- [ ] Start using the `check` helper instead of `error != nil`.
			`- [ ] Update spec to only allow UPPERCASE MULTIHASHES`
			- [ ] Implement `query.pgn` protocol, as outlined [here](%CSBzyskUxqbFSgOBh8OkVLn18NqX3zu3CF58mm2JHok=.sha256) and [here](%KWETmo1cmlfYK4N6FVL9BHYfFcKMy49E94XGuZSPGCw=.sha256).
			`- [ ] Add a note about "shallow" vs. "deep" verification.`
			`- [ ] Finish all the things below`
Stub out an `importBundle` file 2020-10-19 12:33:20 +00:00
Re-organized CLI args. TODO: Validate mHash input, finish `peer block`. 2020-09-17 12:59:03 +00:00			`\|Done?\|Noun \|Verb \| Flag / arg 1 \| Flag 2 \|`
addPeer() helper. TODO: Switch back to `noun verb` CLI args because I dont like verb noun 2020-09-15 12:50:48 +00:00			`\|-----\|------------\|-----------\|---------------\|-----------\|`
Start moving stuff into `/testdata` 2020-10-04 20:19:28 +00:00			`\| \|bundle \|ingest \| \| \|`
			`\| \|message \|show \| message mhash \| \|`
			`\| \|message \|find \| --all \| \|`
Stub out an `importBundle` file 2020-10-19 12:33:20 +00:00			`\| \|blob \|remove \| mhash \| \|`
Start moving stuff into `/testdata` 2020-10-04 20:19:28 +00:00			`\| \|message \|find \| --last \| \|`
TODO: Bugfix: Prevent simultaneous BLOCK + FOLLOW. 2020-09-18 12:45:40 +00:00			`\| \|draft \|create \| \| \|`
addPeer() helper. TODO: Switch back to `noun verb` CLI args because I dont like verb noun 2020-09-15 12:50:48 +00:00			`\| \|draft \|publish \| \| \|`
			`\| \|draft \|show \| \| \|`
			`\| \|draft \|update \| --key=? \| --value=? \|`
TODO: Bugfix: Prevent simultaneous BLOCK + FOLLOW. 2020-09-18 12:45:40 +00:00			`\| \|bundle \|create \| \| \|`
Blob stuff works. NEXT: Ingest a bundle. 2020-10-01 13:00:15 +00:00			`\| X \|blob \|find \| \| \|`
Blob creation works 2020-09-30 12:56:20 +00:00			`\| X \|blob \|add \| file path \| \|`
Blob stuff works. NEXT: Ingest a bundle. 2020-10-01 13:00:15 +00:00			`\| X \|blob \|add \| STDIO pipe \| \|`
`.. peer untrack` command 2020-09-28 01:21:49 +00:00			`\| X \|peer \|untrack \| peer mhash \| \|`
			`\| X \|peers \|list \| \| \|`
TODO: Bugfix: Prevent simultaneous BLOCK + FOLLOW. 2020-09-18 12:45:40 +00:00			`\| X \|peer \|block \| peer mhash \| \|`
			`\| X \|peer \|follow \| peer mhash \| \|`
addPeer() helper. TODO: Switch back to `noun verb` CLI args because I dont like verb noun 2020-09-15 12:50:48 +00:00			`\| X \|identity \|show \| \| \|`
			`\| X \|identity \|create \| \| \|`
			`\| X \|help \| \| \| \|`
			`\| X \|version \| \| \| \|`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`# Run Tests`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`Without coverage:`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```
Remove coverage data from source control 2020-09-10 12:29:15 +00:00			`./tests.sh`
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`With coverage:`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```
Remove coverage data from source control 2020-09-10 12:29:15 +00:00			`./coverage.sh`
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			`# Build Project`
Begin `create identity` 2020-08-10 12:19:20 +00:00
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```
Directory cleanup 2020-09-10 12:33:41 +00:00			`./build.sh`
Add coverage profile stuff 2020-08-11 12:25:45 +00:00			```