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

Uploaded Python 3

File details

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

File metadata

  • Download URL: getworktree-0.1.1.dev63.tar.gz
  • Upload date:
  • Size: 13.8 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.dev63.tar.gz
Algorithm Hash digest
SHA256 d6b0ec084056e155f9ad298d68992d36259784a087778606402dadd290990615
MD5 00df180907d837a5ceacf830d26d89f2
BLAKE2b-256 071e984381876957ade30961c2c201053e538c2a052960773e10aa57a4d54964

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for getworktree-0.1.1.dev63-py3-none-any.whl
Algorithm Hash digest
SHA256 a8aeca455f1b483e8594942bbb9930a50d7cff4f403b52d267c24b993e662a71
MD5 386eef0589a6214f49826b4c76d2e29a
BLAKE2b-256 21f6ea622ff5fcea148ee87952b2a3c43426ba0ed6b12f5f01c0a7d205746ec4

See more details on using hashes here.

Provenance

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