Skip to content
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.

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

docs(iroh-cli): point to the configuration refernce from each iroh subcommand #2571

Merged
merged 1 commit into from
Aug 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions iroh-cli/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ pub(crate) enum Commands {
/// start optionally takes a `--add SOURCE` option, which can be a file or a folder
/// to serve on startup. Data can also be added after startup with commands like
/// `iroh blob add` or by adding content to documents.
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Start {
/// Optionally add a file or folder to the node.
///
Expand All @@ -99,6 +101,8 @@ pub(crate) enum Commands {
///
/// The console is a REPL for interacting with a running iroh node.
/// For more info on available commands, see https://iroh.computer/docs/api
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Console,

#[clap(flatten)]
Expand Down
10 changes: 10 additions & 0 deletions iroh-cli/src/commands/rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ pub enum RpcCommands {
///
/// Documents are mutable, syncable key-value stores.
/// For more on docs see https://iroh.computer/docs/layers/documents
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Docs {
#[clap(subcommand)]
command: DocCommands,
Expand All @@ -24,6 +26,8 @@ pub enum RpcCommands {
/// Manage document authors
///
/// Authors are keypairs that identify writers to documents.
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Authors {
#[clap(subcommand)]
command: AuthorCommands,
Expand All @@ -32,6 +36,8 @@ pub enum RpcCommands {
///
/// Blobs are immutable, opaque chunks of arbitrary-sized data.
/// For more on blobs see https://iroh.computer/docs/layers/blobs
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Blobs {
#[clap(subcommand)]
command: BlobCommands,
Expand All @@ -44,6 +50,8 @@ pub enum RpcCommands {
/// Manage gossip
///
/// Gossip is a way to broadcast messages to a group of nodes.
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Gossip {
#[clap(subcommand)]
command: GossipCommands,
Expand All @@ -57,6 +65,8 @@ pub enum RpcCommands {
/// a tag.
///
/// Any data iroh fetches without a tag will be periodically deleted.
///
/// For general configuration options see <https://iroh.computer/docs/reference/config>.
Tags {
#[clap(subcommand)]
command: TagCommands,
Expand Down
Loading