treeboot 0.10.0

Bootstrap Git worktrees from one repo-local setup file.
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

<div align="center">

<img width="160px" src="https://github.com/jimeh/treeboot/raw/HEAD/img/treeboot.svg?sanitize=true" alt="treeboot logo">

# treeboot

Bootstrap new Git worktrees from one repo-local setup file.

[![crates.io](https://img.shields.io/crates/v/treeboot?logo=rust&label=crates.io)](https://crates.io/crates/treeboot)
[![License](https://img.shields.io/github/license/jimeh/treeboot?label=License)](https://github.com/jimeh/treeboot/blob/main/LICENSE)

</div>

`treeboot` is a CLI for teams and agents that create lots of Git worktrees. A
new worktree often needs the same local setup every time: copy local env
overrides, link shared tooling, install dependencies, or run a project setup
command.

Instead of repeating those steps across configuration files for Codex, Claude
Code, Conductor, Superset, shell scripts, and team docs, put them in
`.treeboot.toml` and run:

```sh
treeboot
```

## Install

The recommended usage pattern is to make `treeboot` a project-wide [mise][] tool
and provide a standard bootstrap task:

[mise]: https://mise.jdx.dev/

```toml
[tools]
"github:jimeh/treeboot" = "latest"

[tasks.treeboot]
description = "Bootstrap the current worktree with treeboot"
run = "treeboot"
```

Then contributors and agents can run:

```sh
mise run treeboot
```

For a global `mise` install:

```sh
mise use -g github:jimeh/treeboot
treeboot --version
```

Prebuilt binaries are available from
[GitHub Releases](https://github.com/jimeh/treeboot/releases), and Cargo users
can install from crates.io:

```sh
cargo install treeboot
```

## Example

Add a `.treeboot.toml` to the repository root. For example:

```toml
#:schema https://github.com/jimeh/treeboot/releases/latest/download/config.schema.json

copy = [
  ".env.local",
  ".env.development.local",
  ".env.test.local",
  "mise.local.toml",
]

symlink = [
  "config/master.key",
]

commands = [
  "bundle install",
  "pnpm install",
]
```

After creating a new worktree, run:

```sh
treeboot
```

`treeboot` looks for a treeboot config file in the current worktree, discovers
the root checkout, and performs the configured copy, symlink, and command
operations.

Missing copy, symlink, and sync sources are skipped by default, so one config
can safely list several local-only files.

Commands always run, so they should be idempotent or otherwise safe and fast to
run repeatedly.

`treeboot` and `treeboot run` are equivalent. The CLI also includes `status`,
`config`, `check`, `doctor`, `env`, `schema`, `version`, `init`, `copy`,
`symlink`, `sync`, and `completions` subcommands.

See the [repository](https://github.com/jimeh/treeboot) for project details.

## License

MIT