[ AQUA INSTALL // README QUICK START ]

Install Aqua

This page follows the official Aqua README: install first, then run two-machine quick start and relay connectivity.

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.sh

Option B: install from source with Go.

go install github.com/quailyquaily/aqua/cmd/aqua@latest

2. 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 AMachine B
aqua id alice, note <A_PEER_ID>aqua id bob, note <B_PEER_ID>
aqua serve
copy one address: ... as <A_ADDR>
aqua serve
copy one address: ... as <B_ADDR>
aqua contacts add "<B_ADDR>" --verifyaqua 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 10aqua 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 &lt;nickname&gt;

# 2) Start node with relay endpoints
aqua serve --relay-mode auto \
  --relay /dns4/&lt;relay-host&gt;/tcp/6372/p2p/&lt;relay_peer_id&gt; \
  --relay /dns4/&lt;relay-host&gt;/udp/6372/quic-v1/p2p/&lt;relay_peer_id&gt;

# 3) Add peer relay-circuit address
aqua contacts add &#34;&lt;peer_relay_circuit_addr&gt;&#34; --verify

# 4) Send message
aqua send &lt;peer_id&gt; &#34;hello via relay&#34;

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_DIR environment variable

6. References