experimental-cli/README.md

61 lines
2.1 KiB
Markdown
Raw Normal View History

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
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
# TODO
2020-08-10 12:19:20 +00:00
- [ ] Finish http://go-database-sql.org/nulls.html
2020-09-01 12:52:44 +00:00
- [ ] Fix go module nonsense. Read a tut or sth https://thenewstack.io/understanding-golang-packages/
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-08-10 12:19:20 +00:00
- [ ] Finish all the things below:
|Done?|Verb |Noun | Flag / arg 1 | Flag 2 |
|-----|------------|--------|---------------|-----------|
| |show |peers | | |
| |show |peers | --blocked | |
| |unfollow |peer | | |
| |follow |peer | user mhash | |
| |unblock |peer | user mhash | |
| |block |peer | user mhash | |
| |show |blob | | |
| |create |blob | file path | |
2020-08-10 12:19:20 +00:00
| |create |blob | pipe | |
| |create |draft | | |
| |update |draft | --key=? | --value=? |
| |show |draft | | |
| |publish |draft | | |
2020-08-10 12:19:20 +00:00
| |create |bundle | | |
| |find |message | --all | |
| |find |message | --last | |
| |ingest |bundle | | |
| |show |message | message mhash | |
| X |show |identity| | |
2020-09-09 12:42:56 +00:00
| X |create |identity| | |
2020-08-10 12:19:20 +00:00
| X |help | | | |
| X |version | | | |
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
```
./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
```
./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
```