Enum git_branchless::opts::Command

pub enum Command {
    Amend {
        move_options: MoveOptions,
    },
    BugReport,
    Checkout {
        checkout_options: CheckoutOptions,
    },
    Gc,
    Hide {
        commits: Vec<String>,
        recursive: bool,
    },
    HookDetectEmptyCommit {
        old_commit_oid: String,
    },
    HookPreAutoGc,
    HookPostCheckout {
        previous_commit: String,
        current_commit: String,
        is_branch_checkout: isize,
    },
    HookPostCommit,
    HookPostMerge {
        is_squash_merge: isize,
    },
    HookPostRewrite {
        rewrite_type: String,
    },
    HookReferenceTransaction {
        transaction_state: String,
    },
    HookRegisterExtraPostRewriteHook,
    HookSkipUpstreamAppliedCommit {
        commit_oid: String,
    },
    Init {
        uninstall: bool,
        main_branch_name: Option<String>,
    },
    Move {
        source: Option<String>,
        base: Option<String>,
        dest: Option<String>,
        move_options: MoveOptions,
    },
    Next {
        traverse_commits_options: TraverseCommitsOptions,
    },
    Prev {
        traverse_commits_options: TraverseCommitsOptions,
    },
    Restack {
        commits: Vec<String>,
        move_options: MoveOptions,
    },
    Reword {
        commits: Vec<String>,
        messages: Vec<String>,
        discard: bool,
    },
    Smartlog {
        show_hidden_commits: bool,
        only_show_branches: bool,
    },
    Sync {
        update_refs: bool,
        force: bool,
        move_options: MoveOptions,
        commits: Vec<String>,
    },
    Undo {
        interactive: bool,
    },
    Unhide {
        commits: Vec<String>,
        recursive: bool,
    },
    Wrap {
        git_executable: Option<PathBuf>,
        command: WrappedCommand,
    },
}

FIXME: write man-page text

Variants

Amend

Fields

move_options: MoveOptions

Options for moving commits.

Amend the current HEAD commit.

BugReport

Gather information about recent operations to upload as part of a bug report.

Checkout

Fields

checkout_options: CheckoutOptions

Options for checking out a commit.

Check out a given commit.

Gc

Run internal garbage collection.

Hide

Fields

commits: Vec<String>

Zero or more commits to hide.

Can either be hashes, like abc123, or ref-specs, like HEAD^.

recursive: bool

Also recursively hide all visible children commits of the provided commits.

Hide the provided commits from the smartlog.

HookDetectEmptyCommit

Fields

old_commit_oid: String

The OID of the commit currently being applied, to be checked for emptiness.

Internal use.

HookPreAutoGc

Internal use.

HookPostCheckout

Fields

previous_commit: String

The previous commit OID.

current_commit: String

The current commit OID.

is_branch_checkout: isize

Whether or not this was a branch checkout (versus a file checkout).

Internal use.

HookPostCommit

Internal use.

HookPostMerge

Fields

is_squash_merge: isize

Whether or not this is a squash merge. See githooks(5).

Internal use.

HookPostRewrite

Fields

rewrite_type: String

One of amend or rebase.

Internal use.

HookReferenceTransaction

Fields

transaction_state: String

One of prepared, committed, or aborted. See githooks(5).

Internal use.

HookRegisterExtraPostRewriteHook

Internal use.

HookSkipUpstreamAppliedCommit

Fields

commit_oid: String

The OID of the commit that was skipped.

Internal use.

Init

Fields

uninstall: bool

Uninstall the branchless workflow instead of initializing it.

main_branch_name: Option<String>

Use the provided name as the name of the main branch.

If not set, it will be auto-detected. If it can’t be auto-detected, then you will be prompted to enter a value for the main branch name.

Initialize the branchless workflow for this repository.

Move

Fields

source: Option<String>

The source commit to move. This commit, and all of its descendants, will be moved.

base: Option<String>

A commit inside a subtree to move. The entire subtree, starting from the main branch, will be moved, not just the commits descending from this commit.

dest: Option<String>

The destination commit to move all source commits onto. If not provided, defaults to the current commit.

move_options: MoveOptions

Options for moving commits.

Move a subtree of commits from one location to another.

By default, git move tries to move the entire current stack if you don’t pass a --source or --base option (equivalent to writing --base HEAD).

By default, git move attempts to rebase all commits in-memory. If you want to force an on-disk rebase, pass the --on-disk flag. Note that post-commit hooks are not called during in-memory rebases.

Next

Fields

traverse_commits_options: TraverseCommitsOptions

Options for traversing commits.

Move to a later commit in the current stack.

Prev

Fields

traverse_commits_options: TraverseCommitsOptions

Options for traversing commits.

Move to an earlier commit in the current stack.

Restack

Fields

commits: Vec<String>

The IDs of the abandoned commits whose descendants should be restacked. If not provided, all abandoned commits are restacked.

move_options: MoveOptions

Options for moving commits.

Fix up commits abandoned by a previous rewrite operation.

Reword

Fields

commits: Vec<String>

Zero or more commits to reword. If not provided, defaults to “HEAD”.

Can either be hashes, like abc123, or ref-specs, like HEAD^.

messages: Vec<String>

Message to apply to commits. Multiple messages will be combined as separate paragraphs, similar to git commit.

discard: bool

Throw away the original commit messages.

If commit.template is set, then the editor is pre-populated with that; otherwise, the editor starts empty.

Reword commits.

Smartlog

Fields

show_hidden_commits: bool

Also show commits which have been hidden.

only_show_branches: bool

Only show commits that exist on a branch.

Display a nice graph of the commits you’ve recently worked on.

Sync

Fields

update_refs: bool

Run git fetch to update remote references before carrying out the sync.

force: bool

Force rebasing commits even if they’re already based on top of their destination.

move_options: MoveOptions

Options for moving commits.

commits: Vec<String>

The commits whose stacks will be moved on top of the main branch. If no commits are provided, all draft commits will be synced.

Can either be hashes, like abc123, or ref-specs, like HEAD^.

Move any local commit stacks on top of the main branch.

Undo

Fields

interactive: bool

Interactively browse through previous states of the repository before selecting one to return to.

Browse or return to a previous state of the repository.

Unhide

Fields

commits: Vec<String>

Zero or more commits to unhide.

Can either be hashes, like abc123, or ref-specs, like HEAD^.

recursive: bool

Also recursively unhide all children commits of the provided commits.

Unhide previously-hidden commits from the smartlog.

Wrap

Fields

git_executable: Option<PathBuf>

The git executable to invoke.

command: WrappedCommand

The arguments to pass to git.

Wrap a Git command inside a branchless transaction.

Trait Implementations

impl CommandFactory for Command

fn into_app<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command_for_update

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build an Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build an Command that can update self.

impl FromArgMatches for Command

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Assign values from ArgMatches to self.

impl Parser for Command

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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 Command

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand