Enum WikiCommand 

pub enum WikiCommand {
    Get {
        page: String,
    },
    List {
        page: String,
        cursor: Option<String>,
    },
    Find {
        text: String,
        kind: Option<String>,
        page: u32,
    },
    Comments {
        page: String,
        thread: Option<u64>,
        status: Option<String>,
        cursor: Option<String>,
    },
    Attachments {
        page: String,
        cursor: Option<String>,
    },
    Grids {
        page: String,
        cursor: Option<String>,
    },
    Grid {
        grid: String,
        filter: Option<String>,
        sort: Option<String>,
        columns: Option<String>,
        rows: Option<String>,
        revision: Option<u64>,
    },
    Resources {
        page: String,
        kind: Option<String>,
        query: Option<String>,
        cursor: Option<String>,
    },
    Create {
        page: String,
        title: String,
        from: Option<String>,
        silent: bool,
    },
    Update {
        page: String,
        title: Option<String>,
        from: Option<String>,
        merge: bool,
        silent: bool,
    },
    Append {
        page: String,
        from: String,
        top: bool,
        anchor: Option<String>,
        silent: bool,
    },
    Delete {
        page: String,
        recursive: bool,
    },
    Restore {
        token: String,
    },
    Comment {
        page: String,
        text: String,
        reply_to: Option<u64>,
        quote: Option<String>,
    },
    DeleteComment {
        page: String,
        comment: u64,
    },
    Access {
        page: String,
    },
    Grant {
        page: String,
        role: String,
        user: Option<String>,
        uid: Option<String>,
        cloud_uid: Option<String>,
        group: Option<String>,
        no_inherit: bool,
        allow_selflock: bool,
    },
    Regrant {
        page: String,
        access: String,
        role: Option<String>,
        inheritance: Option<String>,
        allow_selflock: bool,
    },
    Revoke {
        page: String,
        access: Option<String>,
        all: bool,
        allow_selflock: bool,
    },
    ClonePage {
        page: String,
        target: String,
        title: Option<String>,
        subscribe: bool,
        no_wait: bool,
    },
    CloneGrid {
        grid: String,
        target: String,
        title: Option<String>,
        with_data: bool,
        no_wait: bool,
    },
    Operation {
        kind: String,
        id: String,
    },
    CreateGrid {
        page: String,
        title: String,
    },
    UpdateGrid {
        grid: String,
        title: Option<String>,
        sort: Option<String>,
        revision: Option<String>,
    },
    DeleteGrid {
        grid: String,
    },
    RowsAdd {
        grid: String,
        from: String,
        after: Option<String>,
        position: Option<u64>,
        revision: Option<String>,
    },
    RowsDelete {
        grid: String,
        rows: Vec<String>,
        revision: Option<String>,
    },
    RowsMove {
        grid: String,
        row: String,
        after: Option<String>,
        position: Option<u64>,
        count: Option<u64>,
        revision: Option<String>,
    },
    ColumnsAdd {
        grid: String,
        from: String,
        position: Option<u64>,
        revision: Option<String>,
    },
    ColumnsDelete {
        grid: String,
        columns: Vec<String>,
        revision: Option<String>,
    },
    ColumnsMove {
        grid: String,
        column: String,
        position: u64,
        count: Option<u64>,
        revision: Option<String>,
    },
    CellsSet {
        grid: String,
        set: Vec<String>,
        revision: Option<String>,
    },
    Upload {
        page: String,
        files: Vec<PathBuf>,
    },
    DeleteAttachment {
        page: String,
        file: String,
    },
    Download {
        page: String,
        file: Option<String>,
        out: PathBuf,
        force: bool,
    },
}

Variants

Get

Show one page: its title and last change, then its text.

Fields

page: String

The page’s slug, or its address as copied from the browser.

List

List the pages under one.

Fields

page: String

The page’s slug, or its address.

cursor: Option<String>

Where the previous page of this listing ended, as its tally named it.

Find

Search pages and files.

Fields

text: String

Words to look for.

kind: Option<String>

Only pages, or only attached files.

page: u32

Which page of hits, from 1; the Wiki’s search stops at 500.

Comments

Show a page’s comments.

Fields

page: String

The page’s slug, or its address.

thread: Option<u64>

Every post in one comment’s thread, by the comment’s id.

status: Option<String>

Only resolved, or only unresolved, comments.

cursor: Option<String>

Where the previous page of this listing ended, as its tally named it.

Attachments

List a page’s attachments.

Fields

page: String

The page’s slug, or its address.

cursor: Option<String>

Where the previous page of this listing ended, as its tally named it.

Grids

List the grids — dynamic tables — on a page.

Fields

page: String

The page’s slug, or its address.

cursor: Option<String>

Where the previous page of this listing ended, as its tally named it.

Grid

Show one grid: its columns, then its rows.

Fields

grid: String

The grid’s id, as wiki grids lists it.

filter: Option<String>

Only matching rows, in the Wiki’s syntax: [slug] ~ text AND [n] < 3.

sort: Option<String>

Order of the rows: slug, -other.

columns: Option<String>

Only these columns, by slug, comma-separated.

rows: Option<String>

Only these rows, by id, comma-separated.

revision: Option<u64>

The grid as it was at this revision.

Resources

List what a page holds: files and grids together.

Fields

page: String

The page’s slug, or its address.

kind: Option<String>

Only files, or only grids.

query: Option<String>

Only those whose name or title matches.

cursor: Option<String>

Where the previous page of this listing ended, as its tally named it.

Create

Create a page; its parent is whatever the slug’s path says.

Fields

page: String

Where the page goes: users/me/notes, or an address.

title: String

from: Option<String>

The page’s text: a file, or - for stdin.

silent: bool

Do not notify subscribers.

Update

Replace a page’s text, or retitle it.

Fields

page: String

The page’s slug, or its address.

title: Option<String>

from: Option<String>

The page’s new text in full: a file, or - for stdin.

merge: bool

Fold in edits made since, rather than be refused over them.

silent: bool

Do not notify subscribers.

Append

Add text to a page: at the bottom, the top, or an anchor.

Fields

page: String

The page’s slug, or its address.

from: String

The text to add: a file, or - for stdin.

top: bool

At the top rather than the bottom.

anchor: Option<String>

At this anchor in the page, such as #deploy.

silent: bool

Do not notify subscribers.

Delete

Delete a page, printing the token that restores it.

Fields

page: String

The page’s slug, or its address.

recursive: bool

Its subpages too. Needs –yes.

Restore

Restore a deleted page by the token its deletion printed.

Fields

token: String

Comment

Comment on a page, or reply to a comment.

Fields

page: String

The page’s slug, or its address.

text: String

The comment; - reads it from stdin.

reply_to: Option<u64>

Reply to this comment, by its id.

quote: Option<String>

The passage of the page the comment is about.

DeleteComment

Delete a comment. There is no undo, so it needs –yes.

Fields

page: String

The page’s slug, or its address.

comment: u64

The comment’s id, as wiki comments shows it.

Access

Show who can read and edit a page.

Fields

page: String

The page’s slug, or its address.

Grant

Give a user or a group a role on a page.

Fields

page: String

The page’s slug, or its address.

role: String

reader, editor, extra_editor (may also manage access) or author.

user: Option<String>

A login; its uid is looked up in Tracker.

uid: Option<String>

A user’s uid, as the organisation’s directory has it.

cloud_uid: Option<String>

A user’s Yandex Cloud id.

group: Option<String>

A group, as SOURCE:ID; the source is dir, cloud, com or staff.

no_inherit: bool

Keep the role off the subpages.

allow_selflock: bool

Allow a change that could lock you yourself out of the page.

Regrant

Change a grant’s role, or whether subpages inherit it.

Fields

page: String

The page’s slug, or its address.

access: String

The grant’s id, as wiki access lists it.

role: Option<String>

inheritance: Option<String>

allow_selflock: bool

Allow a change that could lock you yourself out of the page.

Revoke

Remove a grant, or every personal grant on a page.

Fields

page: String

The page’s slug, or its address.

access: Option<String>

The grant’s id, as wiki access lists it.

all: bool

Every personal grant on the page. Needs –yes.

allow_selflock: bool

Allow a change that could lock you yourself out of the page.

ClonePage

Copy a page to a new address, and wait for the copy.

Fields

page: String

The page’s slug, or its address.

target: String

Where the copy goes; a page there already is a refusal.

title: Option<String>

The copy’s title, when it should not keep the original’s.

subscribe: bool

Subscribe to the copy.

no_wait: bool

Print the operation and return, rather than wait for the copy.

CloneGrid

Copy a grid onto a page, and wait for the copy.

Fields

grid: String

The grid’s id, as wiki grids lists it.

target: String

The page the copy goes on; created if it is not there.

title: Option<String>

with_data: bool

Copy the rows too, not only the columns.

no_wait: bool

Print the operation and return, rather than wait for the copy.

Operation

Show where a clone has got to.

Fields

kind: String

clone for a page, clone_inline_grid for a grid.

id: String

CreateGrid

Create an empty grid on a page.

Fields

page: String

The page’s slug, or its address.

title: String

UpdateGrid

Retitle a grid, or set the order its rows show in.

Fields

grid: String

The grid’s id, as wiki grids lists it.

title: Option<String>

sort: Option<String>

Default order: slug:asc,other:desc.

revision: Option<String>

The revision the change is made against; read first when omitted.

DeleteGrid

Delete a grid. There is no undo, so it needs –yes.

Fields

grid: String

The grid’s id, as wiki grids lists it.

RowsAdd

Add rows from JSON: an array of objects keyed by column slug.

Fields

grid: String

The grid’s id, as wiki grids lists it.

from: String

The rows as JSON: a file, or - for stdin.

after: Option<String>

Put them after this row.

position: Option<u64>

Put them at this position, from 0.

revision: Option<String>

The revision the change is made against; read first when omitted.

RowsDelete

Delete rows by id. There is no undo, so it needs –yes.

Fields

grid: String

The grid’s id, as wiki grids lists it.

rows: Vec<String>

revision: Option<String>

The revision the change is made against; read first when omitted.

RowsMove

Move a row — and the rows after it, with –count.

Fields

grid: String

The grid’s id, as wiki grids lists it.

row: String

after: Option<String>

After this row.

position: Option<u64>

To this position, from 0.

count: Option<u64>

How many rows to move, starting with this one.

revision: Option<String>

The revision the change is made against; read first when omitted.

ColumnsAdd

Add columns from JSON: an array of column definitions.

Fields

grid: String

The grid’s id, as wiki grids lists it.

from: String

The columns as JSON: a file, or - for stdin.

position: Option<u64>

Put them at this position, from 0.

revision: Option<String>

The revision the change is made against; read first when omitted.

ColumnsDelete

Delete columns by slug. There is no undo, so it needs –yes.

Fields

grid: String

The grid’s id, as wiki grids lists it.

columns: Vec<String>

revision: Option<String>

The revision the change is made against; read first when omitted.

ColumnsMove

Move a column to a position.

Fields

grid: String

The grid’s id, as wiki grids lists it.

column: String

position: u64

Where to, from 0.

count: Option<u64>

How many columns to move, starting with this one.

revision: Option<String>

The revision the change is made against; read first when omitted.

CellsSet

Set cells: –set ROW:SLUG=VALUE, as many as needed.

Fields

grid: String

The grid’s id, as wiki grids lists it.

set: Vec<String>

revision: Option<String>

The revision the change is made against; read first when omitted.

Upload

Attach files to a page.

Fields

page: String

The page’s slug, or its address.

files: Vec<PathBuf>

DeleteAttachment

Delete a file attached to a page. There is no undo, so it needs –yes.

Fields

page: String

The page’s slug, or its address.

file: String

The file’s id or name, as wiki attachments lists them.

Download

Download one file attached to a page.

Fields

page: String

The page’s slug or address — or the file’s own, <slug>/.files/<name>.

file: Option<String>

The file’s id or name, as wiki attachments lists them; not needed when the first argument is the file’s address.

out: PathBuf

Directory to write into.

force: bool

Overwrite a file that is already there.

Trait Implementations

impl Debug for WikiCommand

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

Formats the value using the given formatter.

impl FromArgMatches for WikiCommand

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 WikiCommand

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