Skip to content

Commit 41b674b

Browse files
committed
Restructure and extend the README
1 parent b5c0af6 commit 41b674b

2 files changed

Lines changed: 43 additions & 4 deletions

File tree

README.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,23 @@
44
[![PyPI](https://img.shields.io/pypi/v/vibepod)](https://pypi.org/project/vibepod/)
55
[![CI](https://github.com/VibePod/vibepod-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/VibePod/vibepod-cli/actions/workflows/ci.yml)
66
[![Docs Build](https://github.com/VibePod/vibepod-cli/actions/workflows/docs.yml/badge.svg)](https://github.com/VibePod/vibepod-cli/actions/workflows/docs.yml)
7+
![License](https://img.shields.io/github/license/VibePod/vibepod-cli)
8+
![Python](https://img.shields.io/pypi/pyversions/vibepod)
79

8-
VibePod is a unified CLI (`vp`) for running AI coding agents in Docker containers.
10+
VibePod is a unified CLI (`vp`) for running AI coding agents in isolated
11+
Docker containers — no required configuration, no setup. Just
12+
`vp run <agent>`. Includes built-in local metrics collection, HTTP traffic
13+
tracking, and an analytics dashboard to monitor and compare agents side-by-side.
914

10-
![VibePod CLI preview](docs/assets/preview.png)
15+
## Features
16+
17+
-**Zero config** — no setup required; `vp run <agent>` just works. Optional YAML for custom configuration
18+
- 🐳 **Isolated agents** — each agent runs in its own Docker container
19+
- 🔀 **Unified interface** — one CLI for Claude, Gemini, Codex, Devstral, Copilot, Auggie & more
20+
- 📊 **Local analytics dashboard** — track usage and HTTP traffic per agent, plus token metrics
21+
- ⚖️ **Agent comparison** — benchmark multiple agents against each other in the dashboard
22+
- 🔒 **Privacy-first** — all metrics collected and stored locally, never sent to the cloud
23+
- 📦 **Simple install**`pip install vibepod`
1124

1225
## Installation
1326

@@ -17,24 +30,50 @@ VibePod is available on [PyPI](https://pypi.org/project/vibepod/):
1730
pip install vibepod
1831
```
1932

33+
## Quick Start
34+
35+
```bash
36+
vp run <agent>
37+
# examples:
38+
vp run claude
39+
vp run codex
40+
```
41+
42+
![VibePod CLI preview](docs/assets/preview.png)
43+
2044
## Current Status
2145

2246
This repository contains an initial v1 implementation with:
2347

2448
- `vp run <agent>`
2549
- `vp stop <agent|--all>`
2650
- `vp list`
27-
- `vp logs start|stop|status`
2851
- `vp config init`
2952
- `vp config show`
3053
- `vp config path`
3154
- `vp version`
3255

56+
## Analytics & Dashboard
57+
58+
VibePod collects metrics locally while your agents run and serves them through
59+
a built-in dashboard.
60+
61+
![VibePod Analytics Dashboard](docs/assets/dashboard.png)
62+
63+
| Command | Description |
64+
|------------------|----------------------------------------------------|
65+
| `vp logs start` | Start/reuse dashboard for collected metrics |
66+
| `vp logs stop` | Stop the dashboard container |
67+
| `vp logs status` | Show dashboard container status |
68+
69+
The dashboard shows per-agent HTTP traffic, usage over time, and Claude token
70+
metrics. It also lets you compare agents side-by-side. All data stays on your
71+
machine.
72+
3373
## Image Namespace
3474

3575
By default, agent images use the `vibepod` namespace for Claude, Codex, and platform services, and `nezhar` for Gemini/OpenCode/Devstral/Auggie/Copilot.
3676

37-
3877
Current defaults are aligned to existing container repos:
3978

4079
- `claude` -> `vibepod/claude:latest`

docs/assets/dashboard.png

128 KB
Loading

0 commit comments

Comments
 (0)