API

Iroh has a single application programming interface (API), implemented in numerous languages. This reference covers what each API method does, with code examples for supported languages.

Documents

Manage & manipulate documents: syncable, multi-writer key-value stores.

docs delete

Delete all document entries below a key prefix.

docs drop

Delete an entire document from the local node

docs export

Export the most recent data for a key from a document

docs get

Get entries in a document.

docs import

Import data into a document.

docs join

Join a document from a ticket.

docs keys

List all keys in a document.

docs list

List documents on this node.

docs create

Create a new blank document.

docs set

Set an entry in a document

docs share

Share a document with peers.

docs switch

Set the active document (only works within the Iroh console).

docs watch

Watch for changes and events on a document

Authors

Authors manage & view documents.

authors switch

Set the active author (only works within the Iroh console)

authors create

Create a new author

authors delete

Delete an author

authors export

Export an author

authors import

Import an author

authors default

Print the default author for this node

authors list

List authors

Gossip

Gossip broadcasts messages to a group of nodes.

gossip subscribe

Subscribe to a gossip topic

Blobs

Blobs are opaque content-addressed byte sequences.

blobs add

Add data from PATH to the running node

blobs download

Download data to the running node's database and provide it

blobs export

Export a blob from the internal blob store to the local filesystem

blobs list blobs

List the available blobs on the running provider

blobs list incomplete-blobs

List the blobs on the running provider that are not full files

blobs list collections

List the available collections on the running provider

blobs validate

Validate hashes on the running node

blobs consistency-check

Perform a database consistency check on the running node

blobs delete blob

Delete the given blobs

blobs share

Get a ticket to share this blob

Net

Manage remote node connections

net remote-list

Get information about the different remote nodes

net remote

Get information about a particular remote node

net node-addr

Get the node addr of this node

net add-node-addr

Add this node addr to the known nodes

net home-relay

Get the relay server we are connected to