Enum WorktreeAction 

pub enum WorktreeAction {
    List {
        target: Utf8PathBuf,
        json: bool,
    },
    Add {
        branch: String,
        target: Utf8PathBuf,
        base: Option<String>,
        apply: bool,
        json: bool,
    },
    Prune {
        target: Utf8PathBuf,
        repo: Option<String>,
        forge: Option<String>,
        verify: bool,
        apply: bool,
        quiet: bool,
        json: bool,
    },
}

The worktree verbs, mode-free by design: they behave identically under the worktree and branches workflows.

Variants

List

Report every worktree of the repository, offline.

Fields

target: Utf8PathBuf

The repository to read; any of its worktrees names it.

json: bool

Emit one JSON object on stdout instead of the human report.

Add

Create or adopt one branch’s worktree at the sibling path ../<project>@<flattened branch>; preview by default.

Fields

branch: String

The branch to seat: an existing local branch is adopted, a lone matching remote tip becomes a tracking branch, and anything else is created from –base or the refreshed trunk.

target: Utf8PathBuf

The repository to act on; any of its worktrees names it.

base: Option<String>

The commit-ish a new branch starts from; required for a release/* line, which is cut from a tag and never the tip.

apply: bool

Create the worktree; without it the intent is reported and nothing is touched.

json: bool

Emit one JSON object on stdout instead of the human report.

Prune

Report the worktrees a squash merge retired — stale records and gone upstreams, never healthy seats — and remove only the forge-confirmed ones, and only under –apply.

Fields

target: Utf8PathBuf

The repository to read; any of its worktrees names it.

repo: Option<String>

Override the detected project path (owner/name) for the forge confirmation.

forge: Option<String>

Override the detected forge: github or gitlab.

verify: bool

Confirm each candidate against the forge’s merged requests, removing nothing.

apply: bool

Confirm each candidate, then remove the worktree before its branch, and clear the stale records.

quiet: bool

Print nothing when there is nothing to report, for the post-merge hook.

json: bool

Emit one JSON object on stdout instead of the human report.

Trait Implementations

impl Debug for WorktreeAction

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

Formats the value using the given formatter.

impl FromArgMatches for WorktreeAction

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 WorktreeAction

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