# README.md Template

```markdown
<div align="center">

# 🎵 VibePod

**One CLI for all AI coding agents**

[Installation](#installation) •
[Quick Start](#quick-start) •
[Documentation](https://vibepod.dev/docs) •
[Discord](https://discord.gg/XXXXX)

[![PyPI version](https://img.shields.io/pypi/v/vibepod.svg)](https://pypi.org/project/vibepod/)
[![License](https://img.shields.io/github/license/VibePod/vibepod)](LICENSE)
[![Tests](https://github.com/VibePod/vibepod/actions/workflows/test.yml/badge.svg)](https://github.com/VibePod/vibepod/actions/workflows/test.yml)

</div>

---

VibePod provides a unified CLI to run AI coding agents (Claude, Gemini, OpenCode, Devstral, Auggie) in isolated Docker containers with shared skills and API logging.

```bash
vp run claude        # Start Claude Code
vp run gemini        # Start Gemini CLI
vp logs ui           # View API usage in Datasette
```

## Features

- 🐳 **Containerized** - Each agent runs in isolated Docker containers
- 🔧 **Unified CLI** - One tool to manage all agents
- 📊 **API Logging** - Track requests, tokens, and costs via Datasette
- 🎯 **Skills Sync** - Share skills across agents via [AGENTS.lock](https://github.com/luml-ai/AGENTS.lock)
- 🔐 **Persistent Auth** - Credentials stored securely across sessions
- 🖥️ **Cross-Platform** - Works on macOS, Linux, and Windows

## Installation

### Quick Install

```bash
curl -fsSL https://vibepod.dev/install.sh | bash
```

### Via pipx (Recommended)

```bash
pipx install vibepod
```

### Via pip

```bash
pip install vibepod
```

### Via Homebrew (macOS)

```bash
brew install vibepod/tap/vp
```

### Requirements

- Docker (Docker Desktop or Docker Engine)
- Python 3.10+ (for pip/pipx install)

## Quick Start

```bash
# Start Claude in current directory
vp run claude

# Or use the shorthand
vp c

# Start Gemini with a different workspace
vp run gemini -w ~/projects/myapp

# Start with API logging enabled
vp run claude --proxy

# View logs in browser
vp logs ui
```

## Supported Agents

| Agent | Provider | Command |
|-------|----------|---------|
| Claude Code | Anthropic | `vp run claude` or `vp c` |
| Gemini CLI | Google | `vp run gemini` or `vp g` |
| OpenCode | OpenAI | `vp run opencode` or `vp o` |
| Devstral | Mistral | `vp run devstral` or `vp d` |
| Auggie | Augment | `vp run auggie` or `vp a` |

## Commands

```
vp run <agent>        Start an agent container
vp stop <agent>       Stop agent container
vp stop --all         Stop all containers
vp list               List available agents
vp logs ui            Open Datasette dashboard
vp logs stats         Show usage statistics
vp skills add <url>   Add a skill (via AGENTS.lock)
vp skills sync        Sync skills to agents
vp config show        Show configuration
vp auth login <agent> Authenticate an agent
vp update             Update CLI and images
```

## Configuration

Global config: `~/.config/vibepod/config.yaml`

```yaml
default_agent: claude
auto_pull: false

agents:
  claude:
    image: vibepod/claude:latest
    
logging:
  enabled: true
  ui_port: 8001

aliases:
  c: run claude
  g: run gemini
```

Project config: `.vibepod/config.yaml`

```yaml
default_agent: claude

agents:
  claude:
    env:
      PROJECT_NAME: myapp
```

## Skills Management

VibePod integrates with [AGENTS.lock](https://github.com/luml-ai/AGENTS.lock) for skills management:

```bash
# Initialize AGENTS.lock
vp skills init

# Add skills
vp skills add vibepod/python-best-practices
vp skills add https://github.com/anthropics/skills/tree/main/skills/frontend-design

# Sync to all agents
vp skills sync
```

## API Logging

Enable API logging to track requests, tokens, and costs:

```bash
# Run with logging
vp run claude --proxy

# View in browser
vp logs ui

# Show statistics
vp logs stats

# Query logs directly
vp logs query "SELECT agent, SUM(cost_usd) FROM requests GROUP BY agent"
```

## Docker Images

| Image | Description |
|-------|-------------|
| `vibepod/claude` | Claude Code |
| `vibepod/gemini` | Gemini CLI |
| `vibepod/opencode` | OpenCode |
| `vibepod/devstral` | Devstral |
| `vibepod/auggie` | Auggie |
| `vibepod/datasette` | Logging UI |

## Development

```bash
# Clone
git clone https://github.com/VibePod/vibepod
cd vibepod

# Install for development
pip install -e ".[dev]"

# Run tests
pytest

# Lint
ruff check src tests
```

## Contributing

Contributions welcome! Please read our [Contributing Guide](CONTRIBUTING.md).

## License

MIT License - see [LICENSE](LICENSE)

## Links

- 🌐 Website: [vibepod.dev](https://vibepod.dev)
- 📖 Documentation: [vibepod.dev/docs](https://vibepod.dev/docs)
- 🐦 Twitter: [@vibepod_dev](https://x.com/vibepod_dev)
- 💬 Discord: [Join](https://discord.gg/XXXXX)

---

<div align="center">
Made with ❤️ by <a href="https://github.com/nezhar">nezhar</a>
</div>
```
