Metadata-Version: 2.4
Name: getworktree
Version: 0.1.1.dev55
Summary: Isolated git worktree developer loops and AI agent workspaces.
Home-page: https://github.com
Author: Worktree Team
Author-email: hello@getworktree.io
Project-URL: Homepage, https://getworktree.io
Project-URL: Bug Tracker, https://github.com/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer[all]>=0.9.0
Requires-Dist: jsonschema>=4.0.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: pydantic>=2.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Requires-Dist: ruff>=0.6.0; extra == "dev"
Requires-Dist: invoke>=2.0.0; extra == "dev"
Provides-Extra: cursor
Requires-Dist: cursor-sdk<2,>=1.0.26; extra == "cursor"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Worktree (`wt`)

[![CI](https://github.com/getworktree/getworktree/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/getworktree/getworktree/actions/workflows/ci.yml)
[![License](https://img.shields.io/github/license/getworktree/getworktree.svg)](https://github.com/getworktree/getworktree/blob/main/LICENSE)
[![Issues](https://img.shields.io/github/issues/getworktree/getworktree.svg)](https://github.com/getworktree/getworktree/issues)
[![Last commit](https://img.shields.io/github/last-commit/getworktree/getworktree.svg)](https://github.com/getworktree/getworktree/commits/main)
[![PyPI version](https://img.shields.io/pypi/v/getworktree.svg)](https://pypi.org/project/getworktree/)
[![Python versions](https://img.shields.io/pypi/pyversions/getworktree.svg)](https://pypi.org/project/getworktree/)
[![Stars](https://img.shields.io/github/stars/getworktree/getworktree.svg?style=social)](https://github.com/getworktree/getworktree/stargazers)

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

```bash
pip install getworktree
```

Optional provider extras:

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

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

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

## Documentation

- CLI plan: [docs/cli-plan.md](docs/cli-plan.md)
- Schemas and config: [docs/agents/schemas-and-config.md](docs/agents/schemas-and-config.md)
- Architecture: [docs/agents/architecture.md](docs/agents/architecture.md)

## 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`](LICENSE) for details.

## Links

- Website: [getworktree.io](https://getworktree.io)
- GitHub Organization: [github.com/getworktree](https://github.com/getworktree)
