Skip to main content

A CLI tool to run Claude on git worktrees with automated commits

Project description

Papagai Logo

papagai

papagai is a commandline utility to have Claude go off and do something in a git repository. Any changes made by claude are done in a worktree, allowing multiple tasks to work simultaneously.

For more documentation, see papagai on ReadTheDocs.

Installation

$ pip install papagai

If running from the git repository, use uv:

$ uv run papagai

Shell Completion

papagai supports shell completion for bash and zsh. Completion files are available in the completion/ directory.

Bash:

$ cp completion/bash/papagai ~/.local/share/bash-completion/completions/papagai

Then restart your shell or run:

$ source ~/.local/share/bash-completion/completions/papagai

Zsh:

$ cp completion/zsh/_papagai ~/.local/share/zsh/site-functions/_papagai

Then restart your shell or run:

$ autoload -Uz compinit && compinit

Completion will provide suggestions for commands, options, and file paths.

Usage

Code Review

The review command is a convenience shortcut for running a code review:

$ papagai review
Working in papagai/review/main-2025-11-12-7be3946e (based off main)
[...]
My work here is done. Check out branch papagai/review/main-2025-11-12-7be3946e or papagai/latest

This command will review all commits on the current branch, providing inline feedback and creating fixup commits for any issues found.

If git has been set up to fetch merge requests from GitHub/GitLab, then you can easily review a merge request too:

$ git config --add remote.origin.fetch "+refs/merge-requests/*/head:refs/remotes/origin/mr/*"
$ git fetch --quiet origin
$ papagai review --mr 1234
[...]
My work here is done. Check out branch papagai/review/mr1234/v1 or papagai/latest

This review happens all locally and is not dependent on GitHub/GitLab - the git config merely fetches merge requests into the local git tree so git can find them locally.

Writing Code

The primary subcommands are code and do to get Claude to do something. They are identical but the code command primes Claude to be a half-decent programmer so you can focus on merely the task instructions.

$ papagai code
Please tell me what you want me to do (Ctrl+D to complete)
Update all .format() strings with f-strings
Working in papagai/main-2025-11-12-7be3946e (based off main)
[...]
My work here is done. Check out branch papagai/main-2025-11-12-7be3946e or papagai/latest

# The same by passing instructions via a file
$ echo "Update all .format() strings with f-strings" > instructions.md
$ papagai code instructions.md
[...]
My work here is done. Check out branch papagai/main-2025-11-12-abc134fe or papagai/latest

The papagai/latest branch is always updated to point to the most recent papagai branch.

The do command works exactly the same way but it does not prime Claude so you will have to add this to the task (if need be).

# Instructions via a file
$ echo "You are a native spanish speaker. Translate all strings to Spanish" > instructions.md
$ papagai do instructions.md

The instructions should be in Markdown. If there is a frontmatter key "tools" it is extracted and passed to Claude as the set of allowed tools. For example:

---
tools: Bash(uv :*)
---
Update all .format() strings with f-strings

If you really trust Claude, you can tell it to create a new proper branch directly or merge the results into the current branch:

$ papagai code --branch new-features instructions.md
$ papagai code --branch . instructions.md

This will still create the papagai branches but also merge them back into the given branch (where . stands for "current branch").

Pre-written tasks

The papagai task command runs pre-written tasks. These are read from $XDG_CONFIG_HOME/papagai/tasks/**/*.md and must look like this:

---
description: some description
---
You are a very smart LLM. Blah blah.

Additionally papagai ships with built-in tasks. These are tasks that were (somewhat) successfully used elsewhere and might be useful for other repos.

$ papagai task --list
[...]
python/update-to-3.9                ... update a Python code base to Python 3.9+
$ papagai task python/update-to-3.9

The --list command will also list any tasks in XDG_CONFIG_HOME.

Variable substitution in task files

  • {BRANCH} is replaced with the original branch
  • {WORKTREE_BRANCH} is replaced with the current working branch

Cleanup

papagai works on branches (and in workdirs), if you want to get rid yourself of any leftover branches use:

$ papagai purge

Acknowledgements

papagai is motivated by and based on claude-review-agent.

Most of papagai (especially the tests!) was written using Claude.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

papagai-0.6.0.tar.gz (599.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

papagai-0.6.0-py3-none-any.whl (38.4 kB view details)

Uploaded Python 3

File details

Details for the file papagai-0.6.0.tar.gz.

File metadata

  • Download URL: papagai-0.6.0.tar.gz
  • Upload date:
  • Size: 599.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for papagai-0.6.0.tar.gz
Algorithm Hash digest
SHA256 4619ef1e573603d42c154a18a3be3c49b8290e9000d97a2a940d5e83ad1fecf1
MD5 e0b5ed4bdee07499eddbf76e76d538a1
BLAKE2b-256 0e4ab770c94d0a59eea4f9d63d21709d86af4e577b04b65c04f884ae47e19993

See more details on using hashes here.

File details

Details for the file papagai-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: papagai-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 38.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for papagai-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0fa6cfe47694d10982540fd18b174641a3255b5fd078049f61de031b7bb3be6d
MD5 f3489d3c9f5397c2323472f66f98ed68
BLAKE2b-256 c2e1a8601ffb739dad520e322cf2792d2abfc9a6995db504728d15491a89863b

See more details on using hashes here.

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