Metadata-Version: 2.4
Name: airut
Version: 0.8.3
Summary: Headless Claude Code interaction via email
Project-URL: Homepage, https://github.com/airutorg/airut
Project-URL: Repository, https://github.com/airutorg/airut
Project-URL: Documentation, https://github.com/airutorg/airut/tree/main/doc
License-Expression: MIT
License-File: LICENSE
Requires-Python: <3.14,>=3.13
Requires-Dist: aiosmtpd>=1.4.6
Requires-Dist: cryptography>=46.0.4
Requires-Dist: mdformat-frontmatter>=2
Requires-Dist: mdformat-gfm>=0.3
Requires-Dist: mdformat-ruff>=0.1
Requires-Dist: mdformat>=0.7
Requires-Dist: msal>=1.31
Requires-Dist: pip-licenses>=5.0
Requires-Dist: platformdirs>=4.0
Requires-Dist: pytest-cov>=4.1
Requires-Dist: pytest-socket>=0.7.0
Requires-Dist: pytest-xdist>=3.8.0
Requires-Dist: pytest>=8.0
Requires-Dist: python-dotenv>=1.0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: ruff>=0.14
Requires-Dist: ty>=0.0.8
Requires-Dist: uv-secure>=0.6
Requires-Dist: werkzeug>=3.1.5
Description-Content-Type: text/markdown

# Airut

Headless Claude Code interaction via email. Named "Airut" (Finnish:
herald/messenger).

Send an email with instructions, receive Claude Code's response. Airut runs
Claude Code in isolated containers, maintains conversation state, and handles
the full email-to-PR workflow.

```
You → Email → Airut → Claude Code (container) → PR → Email reply → You
```

## Key Features

- **Defense-in-depth sandboxing** — container isolation, surrogate credentials,
  and network allowlist limit blast radius in case of agent misbehavior
- **Email-native authentication** — DMARC verification with sender allowlist, no
  API keys to manage
- **Model selection via subaddressing** — choose the model per email (e.g.,
  `airut+haiku@example.com` for fast/cheap, `airut+opus@example.com` for complex
  tasks)
- **Conversation threading** — reply to continue conversations across sessions
- **File attachments** — send files to the agent, receive files back
- **Web dashboard** — monitor running tasks and view network activity logs

## Quick Start

### Prerequisites

- Linux VM (tested on Debian 13)
- Rootless Podman (for container execution)
- Python 3.13+ (via uv)
- Git and GitHub CLI (`gh`)
- Dedicated email account with IMAP/SMTP access

### Install

```bash
# Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install Airut from PyPI
uv tool install airut
```

Or install the latest development version from main:

```bash
uv tool install airut --from git+https://github.com/airutorg/airut.git
```

### Configure

```bash
# Generate initial config at ~/.config/airut/airut.yaml
airut init

# Validate config and system dependencies
airut check
```

### Deploy

```bash
# Install and start the systemd service
airut install-service

# Verify it's running
systemctl --user status airut
```

### Update

```bash
uv tool upgrade airut
systemctl --user restart airut
```

## How It Works

Each email conversation runs in an isolated container with its own git
workspace, Claude Code session, and sandboxed network. The recommended workflow
has agents push PRs for your review — you review, leave comments, and reply to
the email to iterate.

```
You: "Add user authentication"
    ↓
Agent: works → pushes PR → replies with PR link
    ↓
You: review PR, leave comments
    ↓
You: reply to email "Address the review comments"
    ↓
Agent: reads comments → fixes → updates PR → replies
    ↓
You: approve and merge
```

## Documentation

Full documentation is available on GitHub:

- [Deployment Guide](https://github.com/airutorg/airut/blob/main/doc/deployment.md)
  — installation, configuration, and service management
- [Architecture](https://github.com/airutorg/airut/blob/main/doc/architecture.md)
  — system architecture and data flow
- [Security Model](https://github.com/airutorg/airut/blob/main/doc/security.md)
  — email auth, container isolation, credential handling
- [Repo Onboarding](https://github.com/airutorg/airut/blob/main/doc/repo-onboarding.md)
  — how to onboard a new repository
- [Agentic Operation](https://github.com/airutorg/airut/blob/main/doc/agentic-operation.md)
  — email-to-PR workflow patterns

## Links

- [GitHub Repository](https://github.com/airutorg/airut)
- [Full README](https://github.com/airutorg/airut#readme)

## License

MIT License. See [LICENSE](https://github.com/airutorg/airut/blob/main/LICENSE)
for details.
