Skip to content

docs: update snapshot download commands to use new modular flags #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
onbjerg merged 4 commits into from
Apr 9, 2026
Merged

docs: update snapshot download commands to use new modular flags #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60839d3
docs: update snapshot download commands to use new modular flags
decofe Apr 9, 2026
c9d4a94
docs: use --archive flag for RPC node snapshot download
decofe Apr 9, 2026
50f71dc
docs: update download page for storage v2 flags
decofe Apr 9, 2026
d625d14
docs: restore -u/--url flag in reference table
decofe Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions src/pages/cli/download.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,48 @@ tempo download [flags]
| --- | --- |
| `--chain <network>` | Target network (`mainnet`, `moderato`) |
| `--datadir <path>` | Data directory for downloaded state |
| `-u, --url <url>` | Download a specific snapshot URL instead of the latest |
| `-u, --url <url>` | Download a specific snapshot URL |
| `--list` | List available snapshots |
| `--resumable` | Resume an interrupted download |
| `--minimal` | Download minimal snapshot (pruned state only). Do not use if running a validator. |
| `--archive` | Download full archive snapshot. Do not use if running a validator. |
| `--minimal` | Download minimal snapshot (pruned state, suitable for validators) |
| `--archive` | Download full archive snapshot (suitable for RPC nodes) |

## Examples

Download a snapshot from https://snapshots.tempoxyz.dev:
Download the latest archive snapshot (for RPC nodes):

```bash
tempo download -u $SNAPSHOT_URL
tempo download --archive
```

Download the latest minimal snapshot (for validators):

```bash
tempo download --minimal
```

Download a snapshot for a specific chain:

```bash
tempo download --archive --chain moderato
```

List available snapshots:

```bash
tempo download --list
```

List available snapshots for a specific chain:

```bash
tempo download --list --chain moderato
```

Resume an interrupted download:

```bash
tempo download -u $SNAPSHOT_URL --resumable
tempo download --archive --resumable
```

Then start your node with [`tempo node`](/cli/node).
9 changes: 1 addition & 8 deletions src/pages/guide/node/rpc.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ RPC nodes provide API access to the Tempo network without participating in conse

```bash /dev/null/quickstart.sh#L1-15
# Download snapshot (this will help you sync much faster)
#
# See https://snapshots.tempoxyz.dev/ for snapshots.
tempo download -u $SNAPSHOT_URL
tempo download --archive

# Run node
tempo node \
Expand All @@ -27,11 +25,6 @@ An RPC node running in follow mode is a **full node**. It fetches blocks from a

By default, RPC nodes run in archive mode, meaning they do not prune historical state.

## Manually downloading snapshots

Daily snapshots for the persistent testnet can be found at [https://snapshots.tempoxyz.dev](https://snapshots.tempoxyz.dev). You can extract them either using
`tempo download --url <snapshot_url>` or downloading them manually and extracting them using `curl <snapshot_url> | lz4 -d | tar -xzf -`.

## Example Systemd Service

```bash /dev/null/systemd.sh#L1-55
Expand Down
2 changes: 1 addition & 1 deletion src/pages/guide/node/validator.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The signing key is static. Pre-T2, it can only be rotated by removing and re-cre

The process for running a validator node is very similar to [running a full node](/guide/node/rpc).

You should start by downloading the latest snapshot using `tempo download -u <snapshot_url>`. Downloading the snapshot allows your validator to start participating in consensus much faster.
You should start by downloading the latest snapshot using `tempo download --minimal`. Downloading the snapshot allows your validator to start participating in consensus much faster.
Once you've downloaded the snapshot and have been whitelisted on-chain, you can proceed to run the validator node as such:

```bash
Expand Down
Loading