Metadata-Version: 2.4
Name: codex-autorunner
Version: 1.3.2
Summary: Codex autorunner CLI per DESIGN-V1
Author: Codex
License: MIT License
        
        Copyright (c) 2025 David Zhang
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Git-on-my-level/codex-autorunner
Project-URL: Repository, https://github.com/Git-on-my-level/codex-autorunner
Project-URL: Issues, https://github.com/Git-on-my-level/codex-autorunner/issues
Keywords: codex,automation,agent,cli,fastapi
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.9
Requires-Dist: click<8.2
Requires-Dist: pyyaml>=6.0
Requires-Dist: fastapi>=0.111
Requires-Dist: uvicorn[standard]>=0.30
Requires-Dist: ptyprocess>=0.7
Requires-Dist: python-multipart>=0.0.9
Requires-Dist: python-dotenv>=1.0
Requires-Dist: httpx>=0.27
Requires-Dist: tenacity>=8.0
Provides-Extra: dev
Requires-Dist: black==25.11.0; extra == "dev"
Requires-Dist: mypy>=1.10; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Requires-Dist: pytest-timeout>=2.0; extra == "dev"
Requires-Dist: ruff>=0.5.0; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Provides-Extra: telegram
Requires-Dist: httpx>=0.27; extra == "telegram"
Provides-Extra: voice
Requires-Dist: httpx>=0.27; extra == "voice"
Requires-Dist: python-multipart>=0.0.9; extra == "voice"
Provides-Extra: github
Dynamic: license-file

# CAR (codex-autorunner)
[![PyPI](https://img.shields.io/pypi/v/codex-autorunner.svg)](https://pypi.org/project/codex-autorunner/)

CAR provides a set of low-opinion agent coordination tools for you to run long complex implementations using the agents you already love.

What this looks like in practice:
- You write a plan, or generate a plan by chatting with your favorite AI
- You convert the plan (or ask an AI to convert it for you) into CAR compatible tickets (markdown with some frontmatter)
- Go off and do something else, no need to babysit the agents, they will notify you if they need your input

![CAR Web Hub Screenshot](docs/screenshots/hub.png)

## How it works
CAR is very simple. At it's core, CAR is a state machine which checks to see if there are any incomplete tickets. If yes, pick the next one and run it against an agent. Tickets can be pre-populated by the user, but agents can also write tickets. _Tickets are the control plane for CAR_.

When each agent wakes up, it gets knowledge about CAR and how to operate within CAR, a pre-defined set of context (workspace files), the current ticket, and optionally the final output of the previous agent. This simple loop ensures that agents know enough to use CAR while also focusing them on the task at hand.

## Philosophy
The philosophy behind CAR is to let the agents do what they do best, and get out of their way. CAR is _very bitter-lesson-pilled_. As models and agents get more powerful, CAR should serve as a form of leverage, and avoid constraining models and their harnesses. This is why we treat the filesystem as the first class data plane and utilize tools and languages the models are already very familiar with (git, python).

CAR treats tickets as the control plane and models as the execution layer. This means that we rely on agents to follow the instructions written in the tickets. If you use a sufficiently weak model, CAR may not work well for you. CAR is an amplifier for agent capabilities. Agents who like to scope creep (create too many new tickets) or reward hack (mark a ticket as done despite it being incomplete) are not a good fit for CAR.

## Interaction patterns
CAR's core is a set of python functions surfaced as a CLI, operating on a file system. There are current 3 UIs built on top of this core.

### Web UI
The web UI is the main control plane for CAR. From here you can set up new repositories or clone existing ones, chat with agents using their TUI, and run the ticket autorunner. There are many quality-of-life features like Whisper integration, editing documents by chatting with AI (useful for mobile), viewing usage analytics, and much more. The Web UI is the most full featured user-facing interface and a good starting point for trying out CAR.

I recommend serving the web UI over Tailscale. There is an auth token option but the system is not very battle tested.

### Telegram
Telegram is the "on-the-go" and notification hub for CAR. From here you can kick off and monitor existing tickets, set up new tickets, and chat with agents. Your primary UX here is asking the agent to do things for you rather than you doing it yourself like you would on the web UI. This is great for on-the-go work, but it doesn't have full feature parity with the web UI.

### Project Manager Agent
The project manager agent (PMA) is a way to use an AI agent to run CAR. For example instead of making/editing tickets in the UI, you can ask the PMA to do it for you. Instead of starting a ticket flow, the PMA can babysit it for you. The PMA can be accessed in the web and in Telegram, and also uses the CAR CLI directly.

## Quickstart

The fastest way to get started is to pass [this setup guide](docs/AGENT_SETUP_GUIDE.md) to your favorite AI agent. The agent will walk you through installation and configuration interactively based on your environment.

### From source (repo checkout)

If you're working from a fresh clone of this repo, you can run the repo-local CLI shim:

```bash
./car --help
```

The shim will try `PYTHONPATH=src` first and, if dependencies are missing, will bootstrap a local `.venv` and install CAR.

## Supported models
CAR currently supports:
- Codex
- Opencode

CAR is built to easily integrate any reasonable agent built for Agent Client Protocol (ACP). If you would like to see your agent supported, please reach out or open a PR.

## Examples
Build out complex features and products by providing a series of tickets assigned to various agents.
![CAR Tickets in Progress Screenshot](docs/screenshots/tickets-in-progress.png)

Tickets are just markdown files that both you and the agent can edit.
![CAR Ticket Markdown Screenshot](docs/screenshots/ticket-markdown.png)

You don't have to babysit the agents, they inbox you or ping you on Telegram.
![CAR Inbox Screenshot](docs/screenshots/inbox.png)

You can collaborate with the agents in a shared workspace, independent of the codebase. Drop context there, extract artifacts, it's like a shared scratchpad.
![CAR Workspace Screenshot](docs/screenshots/workspace.png)

All core workspace documents are also just markdown files, so you and the agent can easily edit them.
![CAR Workspace New MD Screenshot](docs/screenshots/workspace-new-md.png)

If you need to do something more custom or granular, you can use your favorite agent TUIs in the built-in terminal.
![CAR Terminal Codex Screenshot](docs/screenshots/terminal-codex.png)
![CAR Terminal Opencode Screenshot](docs/screenshots/terminal-opencode.png)

On the go? The web UI is mobile responsive, or if you prefer you can type or voice chat with your agents on Telegram.
![CAR Telegram Media Voice Screenshot](docs/screenshots/telegram-media-voice.PNG)
![CAR Telegram Media Image Screenshot](docs/screenshots/telegram-media-image.PNG)

Don't want to use the product directly? Delegate work to the PMA.
![CAR Telegram PMA Screenshot](docs/screenshots/telegram-pma.png)

## Star history
[![Star History Chart](https://api.star-history.com/svg?repos=Git-on-my-level/codex-autorunner&type=Date)](https://star-history.com/#Git-on-my-level/codex-autorunner&Date)
