Skip to main content

Isolated git worktree developer loops and AI agent workspaces.

Project description

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 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 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

Project details


Release history Release notifications | RSS feed

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.dev62.tar.gz (13.7 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.dev62-py3-none-any.whl (13.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: getworktree-0.1.1.dev62.tar.gz
  • Upload date:
  • Size: 13.7 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.dev62.tar.gz
Algorithm Hash digest
SHA256 7e0c0ed478a4c5752a160f4fad87f3e788b08edc3222e6976cf2d5808e9c64f1
MD5 faf42985ef0652ddb71d50bb38149100
BLAKE2b-256 551f0061b72494aeb8ca9fa3ab3a1ba37e499431f3e6dcc9e856bde2efbed79e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for getworktree-0.1.1.dev62-py3-none-any.whl
Algorithm Hash digest
SHA256 d113e0c9f5fe8109c0af2845c33d80f19c5ee017f4d41819b55ed70af4c859f4
MD5 c7dd3ab13bc3b1f09f2b577f6ce5ae49
BLAKE2b-256 92a2a4cd46cb808820f9affc2a38723b6bf1921e36d682ff924ccdd5cdf6b9f2

See more details on using hashes here.

Provenance

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

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