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 workflow list
wt workflow show wf-12345
wt workflow run fix-tests

Current command surface

Top-level

  • wt init
  • wt status

Config

  • wt config show
  • wt config validate

Workflow

  • wt workflow list (or wt workflow)
  • wt workflow show <id>
  • wt workflow run <name>
  • wt workflow resume <id>

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.dev74.tar.gz (14.3 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.dev74-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: getworktree-0.1.1.dev74.tar.gz
  • Upload date:
  • Size: 14.3 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.dev74.tar.gz
Algorithm Hash digest
SHA256 94d556c4e66406aef1e849e9d2c89b45bd4ba9d050af3ff255759884271b6ee4
MD5 0d0cc0d780fc2535986341d52af6f358
BLAKE2b-256 33f4af4e81ca29038bd563fe4a565727635e6f14c0942e7d7bbc78c6757d6ccf

See more details on using hashes here.

Provenance

The following attestation bundles were made for getworktree-0.1.1.dev74.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.dev74-py3-none-any.whl.

File metadata

File hashes

Hashes for getworktree-0.1.1.dev74-py3-none-any.whl
Algorithm Hash digest
SHA256 55e7443960fd06e700bb706d1b20c05a5985e8317bba34869f03e9dbf99a9bff
MD5 9ab973a17008a2700f9c6fd464ea996f
BLAKE2b-256 6e54a486e113093c475b4f0f7e89fa10d21848c8ed604aa84631c31fa3977b5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for getworktree-0.1.1.dev74-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