22
33[ ![ Crates.io] ( https://img.shields.io/crates/v/terris.svg )] ( https://crates.io/crates/terris ) [ ![ Docs.rs] ( https://img.shields.io/docsrs/terris.svg )] ( https://docs.rs/terris ) [ ![ CI] ( https://github.com/mfornet/terris/actions/workflows/ci.yml/badge.svg )] ( https://github.com/mfornet/terris/actions/workflows/ci.yml ) [ ![ License] ( https://img.shields.io/crates/l/terris.svg )] ( LICENSE )
44
5-
65A small, friendly Git worktree manager for everyday use.
76
7+
88## What it does
99- Create new worktrees quickly (or jump to existing ones)
1010- List existing worktrees
@@ -13,49 +13,37 @@ A small, friendly Git worktree manager for everyday use.
1313- Simplify workflows with autonomous agents that work in the terminal in the same repository
1414
1515## Install
16- From crates.io (once published) :
16+ From crates.io:
1717``` bash
1818cargo install terris
1919```
2020
2121From source:
2222``` bash
23+ git clone https://github.com/mfornet/terris.git
24+ cd terris
2325cargo install --path .
2426```
2527
26- Update:
27- ``` bash
28- cargo install --path . --force
29- ```
30-
3128## Usage
32- ``` bash
33- terris < branch>
34- terris --list
35- terris --delete < branch>
36- ```
3729
38- ## How it works
39- - ` terris <branch> ` creates the worktree if missing and prints the path every time.
40- - If the branch exists, it is used directly.
41- - If the branch does not exist, it is created from the current HEAD.
42- - Default path is ` ~/.terris-worktrees/<repo-name>/<branch>-<8-random-lowercase-letters> ` .
43-
44- ## Examples
4530``` bash
46- # Create or open a worktree ( branch "feature-a")
47- terris feature-a
31+ # Jump to a worktree. Create branch and worktree if missing.
32+ cd " $( terris feature-a) "
4833
4934# List worktrees
5035terris --list
5136
52- # Jump to a worktree
53- cd " $( terris feature-a) "
54-
5537# Delete a worktree
5638terris --delete feature-a
5739```
5840
41+ ## How it works
42+ - ` terris <branch> ` creates the worktree if missing and prints the path every time.
43+ - If the branch exists, it is used directly.
44+ - If the branch does not exist, it is created from the current HEAD.
45+ - Default path is ` ~/.terris-worktrees/<repo-name>/<branch>-<random-key> ` .
46+
5947## Notes
6048- Works from any directory inside a git repo.
6149- The tool shells out to ` git ` , so ` git ` must be installed and available in ` PATH ` .
0 commit comments