Enum the_way::the_way::cli::TheWaySubcommand

pub enum TheWaySubcommand {
    New,
    Cmd {
        code: Option<String>,
    },
    Search {
        filters: Filters,
        exact: bool,
        stdout: bool,
        force: bool,
    },
    Sync {
        cmd: SyncCommand,
        force: bool,
    },
    List {
        filters: Filters,
    },
    Import {
        file: Option<PathBuf>,
        gist_url: Option<String>,
        the_way_url: Option<String>,
    },
    Export {
        file: Option<PathBuf>,
        filters: Filters,
    },
    Clear {
        force: bool,
    },
    Complete {
        shell: Shell,
    },
    Themes {
        cmd: ThemeCommand,
    },
    Config {
        cmd: ConfigCommand,
    },
    Edit {
        index: Option<usize>,
        filters: Filters,
        exact: bool,
    },
    Del {
        index: Option<usize>,
        filters: Filters,
        exact: bool,
        force: bool,
    },
    Cp {
        index: Option<usize>,
        filters: Filters,
        exact: bool,
        stdout: bool,
    },
    View {
        index: Option<usize>,
        filters: Filters,
        exact: bool,
    },
    Tags {
        filters: Filters,
    },
    Languages {
        filters: Filters,
    },
}

Variants

New

Add a new code snippet

Cmd

Fields

code: Option<String>

shell snippet code

Add a new shell snippet

Search

Fields

filters: Filters

exact: bool

Use exact search instead of fuzzy

stdout: bool

Print to stdout instead of copying (with Enter)

force: bool

Don’t ask for confirmation when deleting

Search to find a snippet and copy, edit or delete it

Sync

Fields

cmd: SyncCommand

force: bool

Don’t ask for confirmation before deleting local snippets

Sync snippets to a Gist

Controlled by $THE_WAY_GITHUB_TOKEN env variable. Set this to an access token with the “gist” scope obtained from https://github.com/settings/tokens/new

List

Fields

filters: Filters

Lists (optionally filtered) snippets

Import

Fields

file: Option<PathBuf>

filename, reads from stdin if not given

gist_url: Option<String>

URL to a Gist, if provided will import snippets from given Gist

Multiple files will be converted to separate snippets. Snippet description is created based on Gist description and file name with the format “<gist_description> - <gist_id> - <file_name>”. Each snippet will be tagged with “gist” and its Gist ID. Works for both secret and public gists.

the_way_url: Option<String>

URL to a gist file produced by the-way sync. If provided will import snippets with descriptions and tags taken from the index.md index file in the gist.

Imports code snippets from JSON.

Looks for description, language, and code fields.

Export

Fields

file: Option<PathBuf>

filename, writes to stdout if not given

filters: Filters

Saves (optionally filtered) snippets to JSON.

Clear

Fields

force: bool

Don’t ask for confirmation

Clears all data

Complete

Fields

shell: Shell

Shell to generate completions for

Generate shell completions

Themes

Fields

cmd: ThemeCommand

Manage syntax highlighting themes

Config

Fields

cmd: ConfigCommand

Manage the-way data locations.

Controlled by $THE_WAY_CONFIG env variable, use this to have independent snippet sources for different projects.

Edit

Fields

index: Option<usize>

Index of snippet to change, opens a search window if not given

filters: Filters

exact: bool

Use exact search instead of fuzzy

Change snippet

Del

Fields

index: Option<usize>

Index of snippet to delete, opens a search window if not given

filters: Filters

exact: bool

Use exact search instead of fuzzy

force: bool

Don’t ask for confirmation

Delete snippet

Cp

Fields

index: Option<usize>

Index of snippet to copy, opens a search window if not given

filters: Filters

exact: bool

Use exact search instead of fuzzy

stdout: bool

Print to stdout instead of copying

Copy snippet to clipboard

View

Fields

index: Option<usize>

Index of snippet to show, opens a search window if not given

filters: Filters

exact: bool

Use exact search instead of fuzzy

View snippet

Tags

Fields

filters: Filters

Lists (optionally filtered) tags

Languages

Fields

filters: Filters

Lists (optionally filtered) languages

Trait Implementations

impl CommandFactory for TheWaySubcommand

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for TheWaySubcommand

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

Formats the value using the given formatter.

impl FromArgMatches for TheWaySubcommand

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 Parser for TheWaySubcommand

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for TheWaySubcommand

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