Introduction
peeroxide-cli is a command-line toolkit for interacting with the peeroxide P2P networking stack. It provides a set of tools for peer discovery, connectivity diagnostics, and decentralized data transfer, all while maintaining full wire-compatibility with the existing Hyperswarm and HyperDHT networks.
The binary is named peeroxide.
Core Tools
The toolkit consists of five primary commands:
- lookup: Query the DHT to find peers announcing a specific topic.
- announce: Announce your presence on a topic so others can discover you.
- ping: Diagnose reachability through bootstrap checks, NAT classification, or targeted peer pings.
- cp: Transfer files directly between peers over an encrypted swarm connection.
- deaddrop: Perform anonymous store-and-forward messaging via the DHT.
Key Concepts
To use peeroxide effectively, it helps to understand the underlying architecture:
- DHT and Routing: How the Kademlia-based Distributed Hash Table handles peer discovery and routing.
- Keys and Identity: How Ed25519 keypairs define peer identity and secure connections.
- Topics and Discovery: How peers group together using 32-byte topic keys.