Skip to content

CLI Reference

Guppy provides a command-line interface for uploading, retrieving, and managing data on the Storacha network.

Usage

guppy [command] [flags]

Global Flags

Flag Description Default
--data-dir <path> Directory for config and data store ~/.storacha/guppy
--database-url <url> PostgreSQL connection URL (uses SQLite if not set)
--config <path> Path to config file
--network, -n <name> Network preset name (forge, hot, warm-staging)
--ui Use the Guppy TUI
--upload-service-did <did> Override network upload service DID
--upload-service-url <url> Override network upload service URL
--receipts-url <url> Override receipts service URL
--indexer-did <did> Override indexing service DID
--indexer-url <url> Override indexing service URL

Commands

login

Authenticate with a Storacha account.

whoami

Print information about the local agent.

version

Print the version of Guppy.

reset

Reset agent proofs (log out from all accounts).

list

List uploads in a space.

retrieve

Retrieve a file or directory by its CID.

verify

Verify a DAG's integrity and correctness.

account

Manage logged-in accounts.

space

Create and manage spaces.

upload

Upload data to the Storacha network.

delegation

Delegate capabilities to other agents.

proof

Manage proofs delegated to this agent.

gateway

Run an IPFS Gateway on the Storacha network.

blob

List blobs in a space.

unixfs

Inspect UnixFS content in a space.