Metadata-Version: 2.4
Name: codex-autorunner
Version: 1.9.10
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: pydantic>=2.0
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: pytest-xdist>=3.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: voice-local
Requires-Dist: faster-whisper>=1.1.0; extra == "voice-local"
Provides-Extra: voice-mlx
Requires-Dist: mlx-whisper>=0.4.2; (platform_system == "Darwin" and platform_machine == "arm64") and extra == "voice-mlx"
Provides-Extra: github
Provides-Extra: discord
Requires-Dist: websockets>=12; extra == "discord"
Provides-Extra: browser
Requires-Dist: playwright>=1.40; extra == "browser"
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. CAR is not a coding agent, it's a meta-harness for coding agents.

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). Use the [CAR Ticket Skill](docs/car-ticket-skill.md) with ChatGPT, Claude, Codex, or your preferred assistant.
- Go off and do something else, no need to babysit the agents, they will notify you if they need your input on one of the supported chat platforms (Telegram, Discord, etc...)

![CAR Hub Multiple Projects Screenshot](docs/screenshots/ticket-3-column.png)

## How it works
CAR is very simple. At its 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 (internally referred to as `contextspace`), 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.

## Tickets as code
Since tickets are the control plane, you should write and treat tickets as a new "software layer" that operates within CAR. For example you can write at ticket which scopes a feature and generates other tickets, a ticket which spawns subagents (if the agent supports them) to do a code review, a ticket which repays tech debt, etc... The tickets can be repo-agnostic or specific to your own repository. I maintain a ["blessed" set of ticket templates that can be accessed from any CAR deployment on github](https://github.com/Git-on-my-level/car-ticket-templates) but you can write and configure your own for your own workflows and projects. If you have a ticket that's well generalized and works well across agents and models feel free to contribute it to the blessed template set.

## Interaction patterns
CAR's core is a set of python functions surfaced as a CLI, operating on a file system and sqlite database. There are currently 3 ways to interact with 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. See the [web UI security posture](docs/web/security.md) for guidance on safe exposure.

### CLI
The CLI is the most agent-friendly way to interact with CAR. You can build your own UI on top of the CLI and web server, or you can delegate your agent to use the CLI directly (this is what CAR does in all it's UIs). 

### Chat Apps (Telegram & Discord)
If you want a persistent chat experience on multiple devices without a shared network or needing to make your CAR service exposed on the public internet, chat apps are a great UX.

You can interact with your configured agents just like you would in the TUI, or you can manage a project management agent (PMA) to use the CAR CLI on your behalf to set up and run tickets.

Today we support Telegram and Discord as first-class platforms, if you want to add another platform please open an issue or pull request to discuss.

### Project Manager Agent
The project manager agent (PMA) can be invoked in both the web UI and chat apps. It allows you to use CAR using a conversational interface instead of using the CLI yourself. The PMA is just an agent with access to special context about how to manage CAR, best practices for using the CAR CLI, and a set of helpers for things like file management, agent notification management, and more. The PMA has a basic memory system to learn from how you like to work and persist best practices and learnings over time.

**Hermes makes an excellent PMA** because it maintains global memory across sessions via its shared `HERMES_HOME`, extending beyond CAR's basic context layer. This means Hermes can remember patterns, preferences, and learnings across all your CAR projects. See [the Hermes ACP runbook](docs/ops/hermes-acp.md) for setup and operational caveats.

Example use-cases:
- Create/edit CAR tickets
- Set up new repos and manage worktrees
- Manage a ticket flow
- Respond to dispatches from ticket flow agents
- Go from 0 to 1 on a new project and iterate on it with large feature builds

You can also use the PMA to manage your CAR service, or to help you set up and run tickets.

## 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.

Want to set up chat apps? Read or ask your agent to read:
- [Telegram setup guide](docs/AGENT_SETUP_TELEGRAM_GUIDE.md)
- [Discord setup guide](docs/AGENT_SETUP_DISCORD_GUIDE.md)

Need docker runtime execution (including custom images per repo/worktree)?
- [Destination runtime guide](docs/configuration/destinations.md)

### 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.

## Architecture docs
- [Interactively explore the architecture on Principal Forks](https://app.principal-ade.com/Principal-Forks/codex-autorunner)
- [Codebase constitution](docs/car_constitution/10_CODEBASE_CONSTITUTION.md)
- [Architecture map](docs/car_constitution/20_ARCHITECTURE_MAP.md)
- [Engineering standards](docs/car_constitution/30_ENGINEERING_STANDARDS.md)
- [Run history contract](docs/RUN_HISTORY.md)
- [State roots contract](docs/STATE_ROOTS.md)

## Supported agents
CAR currently supports:
- Codex
- Opencode
- Hermes (ACP-backed runtime with durable threads)

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.
If you want to use Hermes, start with the [Hermes ACP runbook](docs/ops/hermes-acp.md).

## 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 or want to use your favorite chat apps? CAR supports Telegram and Discord.
![CAR Discord Media Image Screenshot](docs/screenshots/discord-media-image.png)
![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)
