gwtr 0.2.0

A simple Git worktree manager
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# gwtr - Git Worktree Manager

[![Crates.io](https://img.shields.io/crates/v/gwtr.svg)](https://crates.io/crates/gwtr)
[![Documentation](https://docs.rs/gwtr/badge.svg)](https://docs.rs/gwtr)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A simple Git worktree manager that creates worktrees in a consistent location alongside your main repository.

## Features

- **Consistent Naming**: Creates worktrees with the pattern `{repository_name}_{worktree_name}`
- **Automatic Branch Creation**: Creates a new branch when adding a worktree
- **Simple Commands**: Easy-to-remember commands for common worktree operations
- **Colored Output**: Clear, colored terminal output for better readability
- **Git Integration**: Works seamlessly with existing Git repositories

## How It Works

When you run `gwtr add feature-x` in a repository named `myproject`, it creates a new worktree at `../myproject_feature-x`. This keeps all related worktrees organized at the same directory level as your main repository.

## Installation

### From Crates.io

```bash
cargo install gwtr
```

### From Source

```bash
git clone https://github.com/katsuhirohonda/gwtr.git
cd gwtr
cargo install --path .
```

## Usage

```bash
# Create a new worktree
gwtr add feature-x

# List all worktrees
gwtr list

# Remove a worktree
gwtr remove feature-x
```

### Examples

```bash
# In a repository called "myapp"
$ gwtr add new-feature
Created worktree 'new-feature' at "../myapp_new-feature"

$ gwtr list
Worktrees:
  /Users/you/dev/myapp (main) [main]
  /Users/you/dev/myapp_new-feature [new-feature]

$ gwtr remove new-feature
Removed worktree 'new-feature' at "../myapp_new-feature"
```

## Prerequisites

- Git 2.5.0 or later (for worktree support)
- Rust 1.80.0 or later (for building from source)

## Development

This project follows Test-Driven Development (TDD) practices.

```bash
# Run tests
cargo test

# Build
cargo build

# Run with debug output
cargo run -- --help

# Format code
cargo fmt

# Run clippy
cargo clippy
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to:
- Update tests as appropriate
- Follow the existing code style
- Run `cargo fmt` and `cargo clippy` before submitting

## Release Process

This project uses GitHub Actions for automated releases:
- **crates.io**: Automatically published when a GitHub release is created
- **npm**: Automatically published with pre-compiled binaries for all platforms

See [docs/CRATES_PUBLISHING.md](docs/CRATES_PUBLISHING.md) for details.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

- Inspired by Git's worktree feature
- Built with Rust and the excellent [clap](https://github.com/clap-rs/clap) CLI framework