diff --git a/README.md b/README.md index e5564f9..98784ef 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,22 @@ [![PyPI](https://img.shields.io/pypi/v/vibepod)](https://pypi.org/project/vibepod/) [![CI](https://github.com/VibePod/vibepod-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/VibePod/vibepod-cli/actions/workflows/ci.yml) [![Docs Build](https://github.com/VibePod/vibepod-cli/actions/workflows/docs.yml/badge.svg)](https://github.com/VibePod/vibepod-cli/actions/workflows/docs.yml) +![License](https://img.shields.io/github/license/VibePod/vibepod-cli) -VibePod is a unified CLI (`vp`) for running AI coding agents in Docker containers. +VibePod is a unified CLI (`vp`) for running AI coding agents in isolated +Docker containers — no required configuration, no setup. Just +`vp run `. Includes built-in local metrics collection, HTTP traffic +tracking, and an analytics dashboard to monitor and compare agents side-by-side. -![VibePod CLI preview](docs/assets/preview.png) +## Features + +- ⚡ **Zero config** — no setup required; `vp run ` just works. Optional YAML for custom configuration +- 🐳 **Isolated agents** — each agent runs in its own Docker container +- 🔀 **Unified interface** — one CLI for Claude, Gemini, Codex, Devstral, Copilot, Auggie & more +- 📊 **Local analytics dashboard** — track usage and HTTP traffic per agent, plus token metrics +- ⚖️ **Agent comparison** — benchmark multiple agents against each other in the dashboard +- 🔒 **Privacy-first** — all metrics collected and stored locally, never sent to the cloud +- 📦 **Simple install** — `pip install vibepod` ## Installation @@ -17,6 +29,17 @@ VibePod is available on [PyPI](https://pypi.org/project/vibepod/): pip install vibepod ``` +## Quick Start + +```bash +vp run +# examples: +vp run claude +vp run codex +``` + +![VibePod CLI preview](docs/assets/preview.png) + ## Current Status This repository contains an initial v1 implementation with: @@ -24,17 +47,32 @@ This repository contains an initial v1 implementation with: - `vp run ` - `vp stop ` - `vp list` -- `vp logs start|stop|status` - `vp config init` - `vp config show` - `vp config path` - `vp version` +## Analytics & Dashboard + +VibePod collects metrics locally while your agents run and serves them through +a built-in dashboard. + +![VibePod Analytics Dashboard](docs/assets/dashboard.png) + +| Command | Description | +|------------------|----------------------------------------------------| +| `vp logs start` | Start or resume dashboard for collected metrics | +| `vp logs stop` | Stop the dashboard container | +| `vp logs status` | Show dashboard container status | + +The dashboard shows per-agent HTTP traffic, usage over time, and Claude token +metrics. It also lets you compare agents side-by-side. All data stays on your +machine. + ## Image Namespace By default, agent images use the `vibepod` namespace for Claude, Codex, and platform services, and `nezhar` for Gemini/OpenCode/Devstral/Auggie/Copilot. - Current defaults are aligned to existing container repos: - `claude` -> `vibepod/claude:latest` diff --git a/docs/assets/dashboard.png b/docs/assets/dashboard.png new file mode 100644 index 0000000..d58599a Binary files /dev/null and b/docs/assets/dashboard.png differ diff --git a/pyproject.toml b/pyproject.toml index bb9c78a..6ddc500 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,14 @@ readme = "README.md" requires-python = ">=3.10" license = { text = "MIT" } authors = [{ name = "VibePod" }] +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", +] dependencies = [ "typer>=0.12.0", "rich>=13.0.0",