Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Worktree (wt)

CI License Issues Last commit PyPI version Python versions Stars

Isolated git worktree developer loops 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 loop runs:
    • Cursor: CURSOR_API_KEY (+ getworktree[cursor])
    • Gemini: Gemini CLI on PATH + GEMINI_API_KEY
    • Copilot: GitHub CLI (gh) on PATH + GH_TOKEN or GITHUB_TOKEN

Quick start

wt init
wt status
wt config validate
wt loop list
wt loop show fix-tests
wt loop run fix-tests

Current command surface

Top-level

  • wt init
  • wt status

Config

  • wt config show
  • wt config validate

Loop

  • wt loop list
  • wt loop show <name>
  • wt loop run <name>

Agent providers for loop runs

Loop definitions support these providers:

  • local
  • ollama
  • cursor
  • gemini
  • copilot

Provider behavior:

  • local and ollama return unified diffs
  • cursor, gemini, and copilot run as direct-mutation providers with shared safety gates before patches are accepted

Project layout

Worktree initializes and uses:

  • .worktree/config.json
  • .worktree/loops/*.yml
  • .worktree/sessions/
  • .worktree/artifacts/

Development

pip install -e .[dev]
inv test
ruff format .
ruff check .

Documentation

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

getworktree-0.1.1.dev71.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

getworktree-0.1.1.dev71-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file getworktree-0.1.1.dev71.tar.gz.

File metadata

  • Download URL: getworktree-0.1.1.dev71.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for getworktree-0.1.1.dev71.tar.gz
Algorithm Hash digest
SHA256 4196460f009e07882eb6ca4c56494460ad50c07d6067c51aa24dbb4b4648fc0a
MD5 2f861036537c22c8454feb8c5502de0d
BLAKE2b-256 2b97debdb2de18c187898a48430f6c845ce48be04514fc2f9cf265693145b05b

See more details on using hashes here.

Provenance

The following attestation bundles were made for getworktree-0.1.1.dev71.tar.gz:

Publisher: dev-publish.yml on getworktree/getworktree

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file getworktree-0.1.1.dev71-py3-none-any.whl.

File metadata

File hashes

Hashes for getworktree-0.1.1.dev71-py3-none-any.whl
Algorithm Hash digest
SHA256 0cb9b9226097c0fc4d8d99ba4d3cb8426f54e9a07e2144acd4c87a984736cdba
MD5 3cf556388c9a9a4fd5dc34f6ac88c727
BLAKE2b-256 fe5c9c3283bbd7dec722dddd141ef5e8c0354552d2bac45ac1812e0e939ba84c

See more details on using hashes here.

Provenance

The following attestation bundles were made for getworktree-0.1.1.dev71-py3-none-any.whl:

Publisher: dev-publish.yml on getworktree/getworktree

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page