Iroh commands are the primary API for interacting with an iroh node, implemented in numerous languages. This reference covers what commands do, with code examples.
Each language has it's own environment-specific setup that's assumed in each example:
The console is the best way to learn the API without writing code, and serves double duty as a diagnostics tool when you're building applications. It's a read-evaluate-print loop (REPL) that communicates with an iroh node for realtime updates.
For a tour of the console check out the quickstart. Start the console with the
iroh console command:
$ iroh console
Commands for managing & manipulating documents
Set the active document (only works within the Iroh console).
Create a new blank document.
Join a document from a ticket.
List documents on this node.
Share a document with peers.
Set an entry in a document
Get entries in a document.
List all keys in a document.
Author commands manage document editors & viewers.
Blobs are content-addressed objects.
Add data from PATH to the running provider's database.
Download data to the running provider's database and provide it.
List the available blobs on the running provider.
List the blobs on the running provider that are not full files.
List the available collections on the running provider.
Validate hashes on the running node.