Enum Commands 

pub enum Commands {
    List {
        fast: bool,
    },
    New {
        name: String,
        from: Option<String>,
        path: Option<PathBuf>,
        print_path: bool,
        open: bool,
        no_fetch: bool,
        no_push: bool,
    },
    Go {
        name: String,
    },
    Pick,
    Rm {
        name: String,
        force: bool,
        delete_branch: bool,
    },
    Clean {
        merged: bool,
        gone: bool,
        stale: Option<u32>,
        dry_run: bool,
    },
    Init {
        shell: String,
        wrap_git: bool,
        no_cd: bool,
    },
    Doctor,
    Completions {
        shell: Shell,
    },
    Pr {
        number: u32,
        print_path: bool,
        open: bool,
    },
    Fetch {
        all: bool,
    },
    Sync {
        dry_run: bool,
        fetch: bool,
    },
    InstallMan,
}

Variants

List

Show dashboard of all worktrees (default)

Fields

fast: bool

Skip dirty file check for faster output

New

Create a new workspace

Fields

name: String

Branch name for the new workspace

from: Option<String>

Base branch or commit to create from

path: Option<PathBuf>

Custom path for the worktree

print_path: bool

Print only the created path to stdout

open: bool

Open the worktree in configured editor

no_fetch: bool

Skip fetching from remote before creating

no_push: bool

Skip pushing to set upstream after creating

Go

Print path to a worktree by name

Fields

name: String

Worktree name (branch name or directory name)

Pick

Interactively select a worktree (fuzzy finder)

Rm

Remove a workspace

Fields

name: String

Worktree name to remove

force: bool

Remove even if worktree has uncommitted changes

delete_branch: bool

Also delete the branch after removing worktree

Clean

Remove merged or stale worktrees

Fields

merged: bool

Remove worktrees whose branch is merged into base

gone: bool

Remove worktrees whose upstream branch was deleted

stale: Option<u32>

Remove worktrees not touched in N days

dry_run: bool

Show what would be removed without removing

Init

Print shell integration script

Fields

shell: String

Shell to generate script for (bash, zsh, fish, powershell)

wrap_git: bool

Generate git wrapper that auto-cds

no_cd: bool

Disable cd helpers (completions only)

Doctor

Diagnose common issues

Completions

Generate shell completions

Fields

shell: Shell

Shell to generate completions for

Pr

Create a worktree for a GitHub PR (requires gh CLI)

Fields

number: u32

PR number

print_path: bool

Print only the created path to stdout

open: bool

Open the worktree in configured editor

Fetch

Fetch from remotes (updates tracking info for all worktrees)

Fields

all: bool

Fetch from all remotes, not just origin

Sync

Rebase all clean worktrees onto their upstream

Fields

dry_run: bool

Show what would be done without doing it

fetch: bool

Fetch from origin before syncing

InstallMan

Install manpage to ~/.local/share/man/man1

Trait Implementations

impl FromArgMatches for Commands

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 Commands

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