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.dev55.tar.gz (13.4 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.dev55-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: getworktree-0.1.1.dev55.tar.gz
  • Upload date:
  • Size: 13.4 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.dev55.tar.gz
Algorithm Hash digest
SHA256 71ff9d55b06ab7d159b2164ad1a1c4d0af02950fde77e7394de4b9f104dccd37
MD5 f1efb8177d07e40858172d4884782d48
BLAKE2b-256 80e8d876b51a324d7cb6f2ffa3a2b6ab23466bfa8fa00d779e055b10854ac1cd

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for getworktree-0.1.1.dev55-py3-none-any.whl
Algorithm Hash digest
SHA256 d3ee88ecb37397ede46a22ba9bab27fa14f6af84d9ad259ab3515548081c8fe1
MD5 8b37fd0b195e14554d1c770cc3c65048
BLAKE2b-256 13e12b9fc5cae9501e8ea349322c70eb4efd4ce6dbb3aa91c5d666f8f7e63da6

See more details on using hashes here.

Provenance

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