Enum noosphere_cli::native::OrbCommand

pub enum OrbCommand {
    Key {
        command: KeyCommand,
    },
    Sphere {
        command: SphereCommand,
    },
    Config {
        command: ConfigCommand,
    },
    Auth {
        command: AuthCommand,
    },
    Serve {
        cors_origin: Option<Url>,
        ipfs_api: Url,
        name_resolver_api: Url,
        interface: IpAddr,
        port: u16,
    },
    Status,
    Diff {
        paths: Vec<PathBuf>,
        base: Option<Cid>,
    },
    Save,
    Sync,
    Publish {
        version: Option<Cid>,
    },
}

Variants

Key

Fields

command: KeyCommand

Sphere

Fields

command: SphereCommand

Config

Fields

command: ConfigCommand

Auth

Fields

command: AuthCommand

Serve

Fields

cors_origin: Option<Url>

Optional origin to allow CORS for

ipfs_api: Url

URL of a Kubo Gateway RPC API

name_resolver_api: Url

URL for a Noosphere name system RPC API

interface: IpAddr

The IP address of the interface that the gateway should bind to

port: u16

The port that the gateway should listen on

Summon a gateway geist to manage the local sphere; it will accept push, fetch and other REST actions from any clients that are authorized to operate on its counterpart sphere. When it receives changes to its counterpart sphere, it will perform various actions such as publishing and/or querying the Noosphere Name System, generating static HTML and/or updating its own sphere with various related information of interest to the counterpart sphere

Status

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

Diff

Fields

paths: Vec<PathBuf>

The specific file or files to show a diff of

base: Option<Cid>

The base revision of the sphere to diff files against

If a difftool is configured, show a diff between files on disk and saved versions in the sphere

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

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

Publish

Fields

version: Option<Cid>

The version of the sphere to publish; if none is specified, the latest saved version will be used

Tell a configured gateway to update the published version of the sphere in the Noosphere name system

Trait Implementations

impl Debug for OrbCommand

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

Formats the value using the given formatter.

impl FromArgMatches for OrbCommand

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 OrbCommand

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand