Enum SphereCommand 

pub enum SphereCommand {
    Create {
        owner_key: String,
    },
    Join {
        local_key: String,
        gateway_url: Url,
        authorization: Option<String>,
        id: Did,
        render_depth: Option<u32>,
    },
    Status {
        id: bool,
    },
    Save {
        render_depth: Option<u32>,
    },
    Sync {
        auto_retry: u32,
        render_depth: Option<u32>,
    },
    Render {
        render_depth: Option<u32>,
    },
    History,
    Follow {
        command: FollowCommand,
    },
    Config {
        command: ConfigCommand,
    },
    Auth {
        command: AuthCommand,
    },
}

Create a new sphere or connect another device to an existing one

Variants

Create

Initialize a new sphere and assign a key as its owner

Fields

owner_key: String

The pet name of a key to assign as the owner of the sphere

Join

Join an existing sphere by its ID and set up a local working copy

Fields

local_key: String

The pet name of a key to use when requesting access to the sphere

gateway_url: Url

The URL for a gateway API host that the owner key of this sphere is authorized to use

authorization: Option<String>

The identity of the authorization that allows the specified key to join the sphere (if already known)

id: Did

The identity of an existing sphere to join

render_depth: Option<u32>

The maximum depth to traverse through followed spheres when rendering updates

Status

Show details about files in the sphere directory that have changed since the last time the sphere was saved

Fields

id: bool

Only output the orb id

Save

Saves changed files to a sphere, creating and signing a new revision in the process; does nothing if there have been no changes to the files since the last revision

Fields

render_depth: Option<u32>

The maximum depth to traverse through followed spheres when rendering updates

Sync

Synchronizes the local sphere with the copy in a configured gateway; note that this is a “conflict-free” sync that may cause local changes to be overwritten in cases where two or more clients have made changes to the same files

Fields

auto_retry: u32

Automatically retry the attempt to sync this number of times

render_depth: Option<u32>

The maximum depth to traverse through followed spheres when rendering updates

Render

Force a render of local sphere content as well as the peer graph; note that this will overwrite any unsaved changes to local sphere content

Fields

render_depth: Option<u32>

The maximum depth to traverse through followed spheres when rendering updates

History

Print a changelog of sphere in a human readable format

Follow

Fields

command: FollowCommand

Config

Fields

command: ConfigCommand

Auth

Fields

command: AuthCommand

Trait Implementations

impl Debug for SphereCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for SphereCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for SphereCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand