1. Install Aqua
Option A: use the release installer script.
curl -fsSL -o /tmp/install.sh https://raw.githubusercontent.com/quailyquaily/aqua/refs/heads/master/scripts/install.sh; \
sudo bash /tmp/install.shOption B: install from source with Go.
go install github.com/quailyquaily/aqua/cmd/aqua@latest2. Verify installation and set nickname
aqua version
aqua id <nickname>If aqua version works, your install is ready.
3. Quick start (Machine A and Machine B)
| Machine A | Machine B |
|---|---|
aqua id alice, note <A_PEER_ID> | aqua id bob, note <B_PEER_ID> |
aqua servecopy one address: ... as <A_ADDR> | aqua servecopy one address: ... as <B_ADDR> |
aqua contacts add "<B_ADDR>" --verify | aqua contacts add "<A_ADDR>" --verify |
aqua send <B_PEER_ID> "hello from A" | aqua send <A_PEER_ID> "hello from B" |
aqua inbox list --unread --limit 10 | aqua inbox list --unread --limit 10 |
4. Relay quick start (cross-network)
With --relay-mode auto, Aqua tries direct connectivity first and falls back to relay when needed.
# 1) Get peer ID on each machine
aqua id <nickname>
# 2) Start node with relay endpoints
aqua serve --relay-mode auto \
--relay /dns4/<relay-host>/tcp/6372/p2p/<relay_peer_id> \
--relay /dns4/<relay-host>/udp/6372/quic-v1/p2p/<relay_peer_id>
# 3) Add peer relay-circuit address
aqua contacts add "<peer_relay_circuit_addr>" --verify
# 4) Send message
aqua send <peer_id> "hello via relay"Official relay endpoints:
- TCP:
/dns4/aqua-relay.mistermorph.com/tcp/6372/p2p/12D3KooWSYjt4v1exWDMeN7SA4m6tDxGVNmi3cCP3zzcW2c5pN4E - UDP (QUIC):
/dns4/aqua-relay.mistermorph.com/udp/6372/quic-v1/p2p/12D3KooWSYjt4v1exWDMeN7SA4m6tDxGVNmi3cCP3zzcW2c5pN4E
5. Data directory
Default data directory: ~/.aqua
Override with:
--dir <path>AQUA_DIRenvironment variable