For the complete documentation index, see llms.txt. This page is also available as Markdown.

CLI Reference

Every flag the Provider binary accepts.

Synopsis

space-router-node [GLOBAL OPTIONS]
space-router-node --receipts [RECEIPT OPTIONS]
space-router-node --claim [CLAIM OPTIONS]

Global options

Flag
Default
Purpose

--version, -V

Print the version and exit.

--reset

Wipe config + identity key, then re-run setup.

--setup

Re-run setup interactively without wiping the identity key.

--port PORT

9090

Port the node listens on.

--public-url HOST

auto

Public hostname or IP advertised to the gateway (tunnel/manual mode).

--public-port PORT

auto

Public port advertised (tunnel/manual mode).

--no-upnp

false

Disable UPnP. You must set --public-url / --public-port.

--staking-address ADDR

identity

EVM address of your staking wallet.

--collection-address ADDR

staking

EVM address that receives claimed SPACE.

--password-file PATH

Read identity-key passphrase from this file (headless installs).

--log-level LEVEL

INFO

One of DEBUG, INFO, WARNING, ERROR.

--label NAME

Human-readable label shown in logs and dashboards.

Receipt options

Use --receipts to inspect the local receipt store. The daemon does not need to be running.

Flag
Purpose

--receipts

List outstanding receipts as a table.

--failed

Show only failed_retryable and failed_terminal rows.

--json

Emit a stable JSON payload instead of a table (suitable for scripts).

--reap

Run one reaper tick before listing — reconciles stuck CLAIM_TX_TIMEOUT rows against on-chain state.

Example:

Claim options

Use --claim to submit a claim transaction. The daemon does not need to be running, but you must have set the identity passphrase if your key is encrypted.

Flag
Purpose

--claim

Submit all claimable receipts in one batch.

--include-retryable

Also retry failed_retryable receipts (respects attempt cap).

--uuid UUID

Claim only the receipt with this request UUID. Refuses on failed_terminal.

Example:

Environment variables

Variable
Purpose

SR_IDENTITY_PASSPHRASE

Decrypt the identity key without prompting.

SR_RECEIPT_MAX_SIGN_ATTEMPTS

Cap on signing retries (default 2). Don't change unless instructed.

SR_RECEIPT_MAX_CLAIM_ATTEMPTS

Cap on claim retries (default 2).

SR_RECEIPT_REAPER_INTERVAL_SECONDS

Reaper tick interval (default 300).

SR_RECEIPT_REAPER_GRACE_SECONDS

How long before a stuck row is eligible for reconciliation (default 300).

systemd unit (Linux .deb / .rpm)

The package installs the binary at /opt/spacerouter/space-router-node and a systemd unit named space-router-node.service. The service runs as the unprivileged spacerouter user, whose home is /var/lib/spacerouter:

Edit settings.json directly under /var/lib/spacerouter/.spacerouter/, then sudo systemctl restart space-router-node. Pass extra flags via the EnvironmentFile at /etc/spacerouter/spacerouter.env.

Last updated

Was this helpful?