A Pigeon Protocol client written in Ruby.

Raise an issue to ask questions or get involved. Your feedback is solicited and appreciated. Seriously! We look forward to hearing from you.

• CLI (docs via pigeon-cli help) and Ruby API available (docs here)
• Minimal dependencies - only outside deps are thor (for CLI) and ed25519 (for signatures).
• Thoroughly unit tested.

FEATURE COMPLETE, BUT IN HIBERNATION. Pigeon was an exploration of ideas that I embarked on in 2020. Now (2021) I am changing my focus. If more people are interested in the project I might start work on it again. Please let me know by raising an issue. For now, I am shifting my focus to other areas.

Please see the "TODO" section for a list of incomplete tasks. As of early 2021, the next big TODO item is to finish bundle imports.

• Implementation is assumed to be stable, but does not have much production use.
• Windows support is unknown (and unlikely to work in current state). Please report bugs.
• Single threaded use is assumed. Built for a single user per OS process. Many design tradeoffs were made around that use case.
• Bundling operations need performance tuning. Optimizations are planned and help is welcome.

Add this to you Gemfile:

gem "pigeon",
  git: "https://github.com/PigeonProtocolConsortium/pigeon-cli-ruby/",
  tag: "v0.2.0"

Then run

bundle install

See pigeon-cli help for documentation. See kitchen_sink.sh examples.

Docs available here

• Stop using old nested blob bundles. Start using "flat" blobs.
• Ability to unblock someone.
• Ability to delete a key from a draft.
• 100% class / module documentation
• Run a terminology extraction tool on the documentation and write a glossary of terms.
• Ability to list all blocked users.
• Ability to unblock a user.

• Add --since=/--until= args to bundle create for sending partial / "slice" bundles.
• Interest and Disinterest Signalling for document routing: Create a $blob_status message to express have, want signalling. This can steer bundle creation and an eventual --for flag at bundle creation time to customize a bundle to a particular user.
• Add a schema for $peer_status. Eg: block, unblock, follow, unfollow.

• Ability to add map/reduce plugins to support custom indices?
• Bundling via Optar or Colorsafe
• Ability to add map/reduce plugins to support custom indices?
• Ability to add a blob in one swoop using File objects and Message#[]=, maybe?
• Bundling via Optar or Colorsafe