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

feat: split CLI implementation into a new iroh-cli crate #2076

Merged
merged 10 commits into from
Mar 14, 2024
Merged
4 changes: 2 additions & 2 deletions iroh-cli/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub(crate) mod start;
pub(crate) mod tag;

/// iroh is a tool for syncing bytes
/// https://iroh.computer/docs
/// <https://iroh.computer/docs>
#[derive(Parser, Debug, Clone)]
#[clap(version, verbatim_doc_comment)]
pub(crate) struct Cli {
Expand Down Expand Up @@ -69,7 +69,7 @@ pub(crate) enum Commands {
/// Open the iroh console
///
/// 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 more info on available commands, see <https://iroh.computer/docs/api>
Console,

#[clap(flatten)]
Expand Down
6 changes: 3 additions & 3 deletions iroh-cli/src/commands/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ pub enum DlPolicyCmd {
/// Set the general download policy for this document.
kind: FetchKind,
/// Add an exception to the download policy.
/// An exception must be formatted as <matching_kind>:<encoding>:<pattern>.
/// An exception must be formatted as `<matching_kind>:<encoding>:<pattern>`.
///
/// - <matching_kind> can be either `prefix` or `exact`.
/// - `<matching_kind>` can be either `prefix` or `exact`.
///
/// - <encoding> can be either `utf8` or `hex`.
/// - `<encoding>` can be either `utf8` or `hex`.
#[clap(short, long, value_name = "matching_kind>:<encoding>:<pattern")]
except: Vec<FilterKind>,
},
Expand Down
4 changes: 2 additions & 2 deletions iroh-cli/src/commands/rpc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub enum RpcCommands {
/// Manage documents
///
/// Documents are mutable, syncable key-value stores.
/// For more on docs see https://iroh.computer/docs/layers/documents
/// For more on docs see <https://iroh.computer/docs/layers/documents>
Doc {
#[clap(subcommand)]
command: DocCommands,
Expand All @@ -36,7 +36,7 @@ pub enum RpcCommands {
/// Manage blobs
///
/// Blobs are immutable, opaque chunks of arbitrary-sized data.
/// For more on blobs see https://iroh.computer/docs/layers/blobs
/// For more on blobs see <https://iroh.computer/docs/layers/blobs>
Blob {
#[clap(subcommand)]
command: BlobCommands,
Expand Down
Loading