Enum gooseberry::gooseberry::cli::GooseberryCLI

pub enum GooseberryCLI {
    Sync,
    Search {
        filters: Filters,
        fuzzy: bool,
    },
    Tag {
        filters: Filters,
        delete: bool,
        tag: Option<String>,
    },
    Delete {
        filters: Filters,
        hypothesis: bool,
        force: bool,
    },
    View {
        filters: Filters,
        id: Option<String>,
    },
    Make,
    Complete {
        shell: Shell,
    },
    Config {
        cmd: ConfigCommand,
    },
    Clear {
        force: bool,
    },
    Move {
        group_id: String,
        filters: Filters,
        search: bool,
        fuzzy: bool,
    },
}

Create and manage your Hypothesis knowledge-base

Variants

Sync

Sync newly added or updated Hypothesis annotations.

Search

Opens a search buffer to see, filter, delete, add tags to and delete tags from annotations

Fields of Search

filters: Filtersfuzzy: bool

Toggle fuzzy search

Tag

Tag annotations according to topic.

Fields of Tag

filters: Filtersdelete: bool

Use this flag to remove the given tag from the filtered annotations instead of adding it

tag: Option<String>

The tag to add to / remove from the filtered annotations

Delete

Delete annotations in bulk either just from gooseberry or from both gooseberry and Hypothesis

Fields of Delete

filters: Filtershypothesis: bool

Also delete from Hypothesis. Without this flag, the "gooseberry_ignore" flag is added to the selected annotations to ensure that they are not synced by gooseberry in the future. If the flag is given then the annotations are also deleted from Hypothesis.

force: bool

Don't ask for confirmation

View

View (optionally filtered) annotations

Fields of View

filters: Filtersid: Option<String>

View annotation by ID

Make

Create and update your knowledge-base markdown files

Complete

Generate shell completions

Fields of Complete

shell: Shell

type of shell

Config

Manage data locations. Controlled by $GOOSEBERRY_CONFIG env variable, Use this to have independent knowledge bases for different projects.

Fields of Config

cmd: ConfigCommand

Clear

Clear all gooseberry data "ob oggle sobble obble"

Fields of Clear

force: bool

Don't ask for confirmation

Move

Move (optionally filtered) annotations from a different hypothesis group to Gooseberry's Only moves annotations created by the current user

Fields of Move

group_id: String

Group ID to move from

filters: Filterssearch: bool

Open a search buffer to see and search filtered annotations to further filter them

fuzzy: bool

Toggle fuzzy search

Implementations

impl GooseberryCLI

pub fn complete(shell: Shell)

Generate shell completions for gooseberry

Trait Implementations

impl Debug for GooseberryCLI

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

Formats the value using the given formatter.

impl StructOpt for GooseberryCLI

pub fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

pub fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It's guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for GooseberryCLI

pub fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

pub fn from_subcommand<'a, 'b>(
    sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>

pub fn is_subcommand() -> bool