This release is a pre-release and may not be stable for production use.
Worktree (wt)
Isolated git worktree developer workflows and autonomous AI agent workspaces.
Worktree helps humans and agents build, test, and remediate in parallel without disturbing your active local branch.
Installation
pip install getworktree
Optional provider extras:
pip install "getworktree[cursor]"
Requirements
- Python 3.13+
- Git
- For provider-specific workflow runs:
- Cursor:
CURSOR_API_KEY(+getworktree[cursor]) - Gemini: Gemini CLI on
PATH+GEMINI_API_KEY - Copilot: GitHub CLI (
gh) onPATH+GH_TOKENorGITHUB_TOKEN
- Cursor:
Quick start
wt init
wt status
wt config validate
wt workflow list
wt workflow show wf-12345
wt workflow run fix-tests
Current command surface
Top-level
wt initwt status
Config
wt config showwt config validate
Workflow
wt workflow list(orwt workflow)wt workflow show <id>wt workflow run <name>wt workflow resume <id>
Agent providers for workflow runs
Workflow definitions support these providers:
localollamacursorgeminicopilot
Provider behavior:
localandollamareturn unified diffscursor,gemini, andcopilotrun as direct-mutation providers with shared safety gates before patches are accepted
Project layout
Worktree initializes and uses:
.worktree/config.json.worktree/workflows/*.yml.worktree/sessions/.worktree/artifacts/
Development
pip install -e .[dev]
inv test
ruff format .
ruff check .
Documentation
- CLI plan: docs/cli-plan.md
- Schemas and config: docs/agents/schemas-and-config.md
- Architecture: docs/agents/architecture.md
Project status
This README reflects the currently implemented surface in main.
Additional commands listed in docs/cli-plan.md may still be in progress.
License
Distributed under the MIT License. See LICENSE for details.
Links
- Website: getworktree.io
- GitHub Organization: github.com/getworktree
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file getworktree-0.1.1.dev87.tar.gz.
File metadata
- Download URL: getworktree-0.1.1.dev87.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cd1eff0a4720bd0db0ed0416df1bba3ac0df7b3631730b6a461786294a055ce6
|
|
| MD5 |
ab413a93358d51ece8d2d9caae848d61
|
|
| BLAKE2b-256 |
4d76e7c98b9cdbdb1137750eaa73adf3b073e06920eeca9923357196f66b9a71
|
Provenance
The following attestation bundles were made for getworktree-0.1.1.dev87.tar.gz:
Publisher:
dev-publish.yml on getworktree/getworktree
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
getworktree-0.1.1.dev87.tar.gz -
Subject digest:
cd1eff0a4720bd0db0ed0416df1bba3ac0df7b3631730b6a461786294a055ce6 - Sigstore transparency entry: 2356737121
- Sigstore integration time:
-
Permalink:
getworktree/getworktree@0d2373684ea9d12f597a8abfb309dd1c7671d945 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/getworktree
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
dev-publish.yml@0d2373684ea9d12f597a8abfb309dd1c7671d945 -
Trigger Event:
push
-
Statement type:
File details
Details for the file getworktree-0.1.1.dev87-py3-none-any.whl.
File metadata
- Download URL: getworktree-0.1.1.dev87-py3-none-any.whl
- Upload date:
- Size: 15.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
990b681147dbd4a5ac22c54249c9f08f1621277aaf402e552a1957999576218b
|
|
| MD5 |
cfd6a6e77d6305421068a2e5ce5b6a54
|
|
| BLAKE2b-256 |
7596e2549c83c0d1d230f9a2aa23eefdd548084a2bc25542d61059d162aecd5a
|
Provenance
The following attestation bundles were made for getworktree-0.1.1.dev87-py3-none-any.whl:
Publisher:
dev-publish.yml on getworktree/getworktree
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
getworktree-0.1.1.dev87-py3-none-any.whl -
Subject digest:
990b681147dbd4a5ac22c54249c9f08f1621277aaf402e552a1957999576218b - Sigstore transparency entry: 2356737499
- Sigstore integration time:
-
Permalink:
getworktree/getworktree@0d2373684ea9d12f597a8abfb309dd1c7671d945 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/getworktree
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
dev-publish.yml@0d2373684ea9d12f597a8abfb309dd1c7671d945 -
Trigger Event:
push
-
Statement type:
