worktree 0.5.1

A powerful CLI tool for managing git worktrees with enhanced features including centralized storage, automatic config file synchronization, and intelligent branch management
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use anyhow::Result;
use std::path::{Path, PathBuf};

/// Trait for Git operations to enable mocking in tests
pub trait GitOperations {
    fn get_repo_path(&self) -> PathBuf;
    /// Checks if a branch exists in the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn branch_exists(&self, branch_name: &str) -> Result<bool>;
    /// Creates a new worktree for the specified branch
    ///
    /// # Errors
    /// Returns an error if:
    /// - Failed to create the worktree
    /// - Branch doesn't exist and create_branch is false
    /// - Git operations fail
    fn create_worktree(
        &self,
        branch_name: &str,
        worktree_path: &Path,
        create_branch: bool,
    ) -> Result<()>;
    /// Creates a new worktree for the specified branch from a specific starting point
    ///
    /// # Errors
    /// Returns an error if:
    /// - Failed to create the worktree
    /// - Branch doesn't exist and create_branch is false
    /// - Failed to resolve the starting reference
    /// - Git operations fail
    fn create_worktree_from(
        &self,
        branch_name: &str,
        worktree_path: &Path,
        create_branch: bool,
        from_ref: Option<&str>,
    ) -> Result<()>;
    /// Removes a worktree from the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn remove_worktree(&self, worktree_name: &str) -> Result<()>;
    /// Lists all worktrees in the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn list_worktrees(&self) -> Result<Vec<String>>;
    /// Deletes a branch from the repository
    ///
    /// # Errors
    /// Returns an error if:
    /// - Branch doesn't exist
    /// - Git operations fail
    fn delete_branch(&self, branch_name: &str) -> Result<()>;

    /// Enables worktree-specific configuration and copies parent repo's effective config
    ///
    /// # Errors
    /// Returns an error if:
    /// - Failed to enable worktree configuration
    /// - Failed to read parent repository configuration
    /// - Failed to set worktree-specific configuration
    fn inherit_config(&self, worktree_path: &Path) -> Result<()>;

    /// Lists all local branches in the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn list_local_branches(&self) -> Result<Vec<String>>;
    /// Lists all remote branches in the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn list_remote_branches(&self) -> Result<Vec<String>>;
    /// Lists all tags in the repository
    ///
    /// # Errors
    /// Returns an error if git operations fail
    fn list_tags(&self) -> Result<Vec<String>>;
}