Skip to main content

Cmd

Enum Cmd 

Source
pub enum Cmd {
Show 16 variants Login { no_browser: bool, name: Option<String>, }, Logout, Whoami, Push(PushArgs), Watch(WatchArgs), Wait(WaitArgs), Say { doc: String, text: String, reply_to: Option<i64>, }, Ls { query: Option<String>, tag: Option<String>, kind: Option<String>, project: Option<String>, limit: u32, }, Show { doc: String, }, Get { doc: String, path: Option<String>, rev: Option<i64>, output: Option<PathBuf>, }, Tag { doc: String, changes: Vec<String>, }, Rm { doc: String, }, Open { doc: String, }, Keys(KeysCmd), Project(ProjectCmd), Skill,
}

Variants§

§

Login

Sign in through the browser and store an API key for this machine

Fields

§no_browser: bool

Print the URL instead of opening a browser; paste the code shown after approval

§name: Option<String>

Name for the new key (default: cli@HOSTNAME)

§

Logout

Revoke and forget the stored key

§

Whoami

Show the server, user and key in use

§

Push(PushArgs)

Publish a file or folder; replaces the remembered document if there is one

§

Watch(WatchArgs)

Re-push whenever files change (debounced 500 ms)

§

Wait(WaitArgs)

Block until feedback arrives from the page

§

Say

Show a message in the open page

Fields

§doc: String

Document id or URL

§text: String

Text to show

§reply_to: Option<i64>

Event id this message answers

§

Ls

List or search the documents you can open

Fields

§query: Option<String>

Full-text search

§tag: Option<String>

Only documents with this tag

§kind: Option<String>

md, html or bundle

§project: Option<String>

Only documents in this project (its id)

§limit: u32
§

Show

Metadata, files and revisions of a document

Fields

§doc: String

Document id or URL

§

Get

Download raw content

Fields

§doc: String

Document id or URL

§path: Option<String>

File inside a bundle (default: the entry page)

§rev: Option<i64>

Revision (default: latest)

§output: Option<PathBuf>

Write to a file instead of stdout

§

Tag

Edit tags: +add -remove (a bare name adds)

Fields

§doc: String

Document id or URL

§changes: Vec<String>
§

Rm

Delete a document

Fields

§doc: String

Document id or URL

§

Open

Open a document in the browser

Fields

§doc: String

Document id or URL

§

Keys(KeysCmd)

Manage your API keys

§

Project(ProjectCmd)

Make a folder a project, list your projects, and arrange a project’s tree

§

Skill

Print a short usage guide to paste into an agent’s instructions

Trait Implementations§

Source§

impl Debug for Cmd

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Cmd

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Cmd

Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

§

impl Freeze for Cmd

§

impl RefUnwindSafe for Cmd

§

impl Send for Cmd

§

impl Sync for Cmd

§

impl Unpin for Cmd

§

impl UnsafeUnpin for Cmd

§

impl UnwindSafe for Cmd

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more