# VibeOS

> Personal agent OS — an independent fork of VibeOS with its own branding and data home (~/.vibeos). Terminal-native autonomous coding and task agent with persistent memory, agent-created skills, and a messaging gateway across many platforms. Runs on local, Docker, SSH, Daytona, Modal, or Singularity backends. Works with Nous Portal, OpenRouter, OpenAI, Anthropic, Google, or any OpenAI-compatible endpoint.

Install: see https://vibeos.com.ru/download or `./scripts/bootstrap-vibeos.sh` from a clone.

Site: https://vibeos.com.ru

## Getting Started

- [Installation](https://vibeos.com.ru/handbook/getting-started/installation): Install VibeOS on macOS, Windows, Linux, WSL2, or Android via Termux
- [Quickstart](https://vibeos.com.ru/handbook/getting-started/quickstart): Your first conversation with VibeOS — from install to chatting in under 5 minutes
- [Learning Path](https://vibeos.com.ru/handbook/getting-started/learning-path): Choose your learning path through the VibeOS documentation based on your experience level and goals.
- [Updating](https://vibeos.com.ru/handbook/getting-started/updating): How to update VibeOS to the latest version or uninstall it
- [Termux (Android)](https://vibeos.com.ru/handbook/getting-started/termux): Run VibeOS directly on an Android phone with Termux
- [Nix Setup](https://vibeos.com.ru/handbook/getting-started/nix-setup): Install and deploy VibeOS with Nix — from quick `nix run` to fully declarative NixOS module with container mode

## Using VibeOS

- [CLI](https://vibeos.com.ru/handbook/user-guide/cli): Master the VibeOS terminal interface — commands, keybindings, personalities, and more
- [TUI (Ink terminal UI)](https://vibeos.com.ru/handbook/user-guide/tui): Launch the modern terminal UI for VibeOS — mouse-friendly, rich overlays, and non-blocking input.
- [Configuration](https://vibeos.com.ru/handbook/user-guide/configuration): Configure VibeOS — config.yaml, providers, models, API keys, and more
- [Configuring Models](https://vibeos.com.ru/handbook/user-guide/configuring-models)
- [Sessions](https://vibeos.com.ru/handbook/user-guide/sessions): Session persistence, resume, search, management, and per-platform session tracking
- [Profiles](https://vibeos.com.ru/handbook/user-guide/profiles)
- [Git Worktrees](https://vibeos.com.ru/handbook/user-guide/git-worktrees): Run multiple VibeOS agents safely on the same repository using git worktrees and isolated checkouts
- [Docker Backend](https://vibeos.com.ru/handbook/user-guide/docker): Running VibeOS in Docker and using Docker as a terminal backend
- [Security](https://vibeos.com.ru/handbook/user-guide/security): Security model, dangerous command approval, user authorization, container isolation, and production deployment best practices
- [Checkpoints & Rollback](https://vibeos.com.ru/handbook/user-guide/checkpoints-and-rollback): Filesystem safety nets for destructive operations using shadow git repos and automatic snapshots

## Core Features

- [Features Overview](https://vibeos.com.ru/handbook/user-guide/features/overview)
- [Tools](https://vibeos.com.ru/handbook/user-guide/features/tools): Overview of VibeOS's tools — what's available, how toolsets work, and terminal backends
- [Skills System](https://vibeos.com.ru/handbook/user-guide/features/skills): On-demand knowledge documents — progressive disclosure, agent-managed skills, and the Skills Hub
- [Curator](https://vibeos.com.ru/handbook/user-guide/features/curator): Background maintenance for agent-created skills — usage tracking, staleness, archival, and LLM-driven review
- [Memory](https://vibeos.com.ru/handbook/user-guide/features/memory): How VibeOS remembers across sessions — MEMORY.md, USER.md, and session search
- [Memory Providers](https://vibeos.com.ru/handbook/user-guide/features/memory-providers): External memory provider plugins — Honcho, OpenViking, Mem0, Hindsight, Holographic, RetainDB, ByteRover, Supermemory
- [Context Files](https://vibeos.com.ru/handbook/user-guide/features/context-files): Project context files — .vibeos.md, AGENTS.md, CLAUDE.md, global SOUL.md, and .cursorrules — automatically injected into every conversation
- [Context References](https://vibeos.com.ru/handbook/user-guide/features/context-references): Inline @-syntax for attaching files, folders, git diffs, and URLs directly into your messages
- [Personality & SOUL.md](https://vibeos.com.ru/handbook/user-guide/features/personality): Customize VibeOS's personality with a global SOUL.md, built-in personalities, and custom persona definitions
- [Plugins](https://vibeos.com.ru/handbook/user-guide/features/plugins): Extend VibeOS with custom tools, hooks, and integrations via the plugin system
- [Built-in Plugins](https://vibeos.com.ru/handbook/user-guide/features/built-in-plugins): Plugins shipped with VibeOS that run automatically via lifecycle hooks — disk-cleanup and friends

## Automation

- [Cron Jobs](https://vibeos.com.ru/handbook/user-guide/features/cron): Schedule automated tasks with natural language, manage them with one cron tool, and attach one or more skills
- [Delegation](https://vibeos.com.ru/handbook/user-guide/features/delegation): Spawn isolated child agents for parallel workstreams with delegate_task
- [Kanban Multi-Agent](https://vibeos.com.ru/handbook/user-guide/features/kanban): Durable SQLite-backed task board for coordinating multiple VibeOS profiles
- [Kanban Tutorial](https://vibeos.com.ru/handbook/user-guide/features/kanban-tutorial)
- [Persistent Goals](https://vibeos.com.ru/handbook/user-guide/features/goals): Set a standing goal and let VibeOS keep working across turns until it's done. Our take on the Ralph loop.
- [Code Execution](https://vibeos.com.ru/handbook/user-guide/features/code-execution): Programmatic Python execution with RPC tool access — collapse multi-step workflows into a single turn
- [Hooks](https://vibeos.com.ru/handbook/user-guide/features/hooks): Run custom code at key lifecycle points — log activity, send alerts, post to webhooks
- [Batch Processing](https://vibeos.com.ru/handbook/user-guide/features/batch-processing): Generate agent trajectories at scale — parallel processing, checkpointing, and toolset distributions

## Media & Web

- [Voice Mode](https://vibeos.com.ru/handbook/user-guide/features/voice-mode): Real-time voice conversations with VibeOS — CLI, Telegram, Discord (DMs, text channels, and voice channels)
- [Browser](https://vibeos.com.ru/handbook/user-guide/features/browser)
- [Vision](https://vibeos.com.ru/handbook/user-guide/features/vision)
- [Image Generation](https://vibeos.com.ru/handbook/user-guide/features/image-generation)
- [Text-to-Speech](https://vibeos.com.ru/handbook/user-guide/features/tts): Text-to-speech and voice message transcription across all platforms

## Messaging Platforms

- [Overview](https://vibeos.com.ru/handbook/user-guide/messaging/index): Chat with VibeOS from Telegram, Discord, Slack, WhatsApp, Signal, SMS, Email, Home Assistant, Mattermost, Matrix, DingTalk, Yuanbao, Microsoft Teams, LINE, Raft, Webhooks, or any OpenAI-compatible frontend via the API server — architecture and setup overview
- [Telegram](https://vibeos.com.ru/handbook/user-guide/messaging/telegram): Set up VibeOS as a Telegram bot
- [Discord](https://vibeos.com.ru/handbook/user-guide/messaging/discord): Set up VibeOS as a Discord bot
- [Slack](https://vibeos.com.ru/handbook/user-guide/messaging/slack): Set up VibeOS as a Slack bot using Socket Mode
- [WhatsApp](https://vibeos.com.ru/handbook/user-guide/messaging/whatsapp): Set up VibeOS as a WhatsApp bot via the built-in Baileys bridge
- [Signal](https://vibeos.com.ru/handbook/user-guide/messaging/signal): Set up VibeOS as a Signal messenger bot via signal-cli daemon
- [Email](https://vibeos.com.ru/handbook/user-guide/messaging/email): Set up VibeOS as an email assistant via IMAP/SMTP
- [SMS](https://vibeos.com.ru/handbook/user-guide/messaging/sms): Set up VibeOS as an SMS chatbot via Twilio
- [Matrix](https://vibeos.com.ru/handbook/user-guide/messaging/matrix): Set up VibeOS as a Matrix bot
- [Mattermost](https://vibeos.com.ru/handbook/user-guide/messaging/mattermost): Set up VibeOS as a Mattermost bot
- [Home Assistant](https://vibeos.com.ru/handbook/user-guide/messaging/homeassistant)
- [Webhooks](https://vibeos.com.ru/handbook/user-guide/messaging/webhooks): Receive events from GitHub, GitLab, and other services to trigger VibeOS agent runs

## Integrations

- [Integrations Overview](https://vibeos.com.ru/handbook/integrations/index)
- [Providers](https://vibeos.com.ru/handbook/integrations/providers)
- [MCP (Model Context Protocol)](https://vibeos.com.ru/handbook/user-guide/features/mcp): Connect VibeOS to external tool servers via MCP — and control exactly which MCP tools VibeOS loads
- [ACP (Agent Context Protocol)](https://vibeos.com.ru/handbook/user-guide/features/acp): Use VibeOS inside ACP-compatible editors such as VS Code, Zed, and JetBrains
- [API Server](https://vibeos.com.ru/handbook/user-guide/features/api-server): Expose vibeos-agent as an OpenAI-compatible API for any frontend
- [Honcho Memory](https://vibeos.com.ru/handbook/user-guide/features/honcho): AI-native persistent memory via Honcho — dialectic reasoning, multi-agent user modeling, and deep personalization
- [Provider Routing](https://vibeos.com.ru/handbook/user-guide/features/provider-routing)
- [Fallback Providers](https://vibeos.com.ru/handbook/user-guide/features/fallback-providers)
- [Credential Pools](https://vibeos.com.ru/handbook/user-guide/features/credential-pools)

## Guides & Tutorials

- [Tips & Best Practices](https://vibeos.com.ru/handbook/guides/tips): Practical advice to get the most out of VibeOS — prompt tips, CLI shortcuts, context files, memory, cost optimization, and security
- [Local LLMs on Mac](https://vibeos.com.ru/handbook/guides/local-llm-on-mac): Set up a local OpenAI-compatible LLM server on macOS with llama.cpp or MLX, including model selection, memory optimization, and real benchmarks on Apple Silicon
- [Daily Briefing Bot](https://vibeos.com.ru/handbook/guides/daily-briefing-bot): Build an automated daily briefing bot that researches topics, summarizes findings, and delivers them to Telegram or Discord every morning
- [Team Telegram Assistant](https://vibeos.com.ru/handbook/guides/team-telegram-assistant): Step-by-step guide to setting up a Telegram bot that your whole team can use for code help, research, system admin, and more
- [Use VibeOS as a Python Library](https://vibeos.com.ru/handbook/guides/python-library): Embed AIAgent in your own Python scripts, web apps, or automation pipelines — no CLI required
- [Use MCP with VibeOS](https://vibeos.com.ru/handbook/guides/use-mcp-with-vibeos): A practical guide to connecting MCP servers to VibeOS, filtering their tools, and using them safely in real workflows
- [Use Voice Mode with VibeOS](https://vibeos.com.ru/handbook/guides/use-voice-mode-with-vibeos): A practical guide to setting up and using VibeOS voice mode across CLI, Telegram, Discord, and Discord voice channels
- [Use SOUL.md with VibeOS](https://vibeos.com.ru/handbook/guides/use-soul-with-vibeos): How to use SOUL.md to shape VibeOS's default voice, what belongs there, and how it differs from AGENTS.md and /personality
- [Build a VibeOS Plugin](https://vibeos.com.ru/handbook/guides/build-a-vibeos-plugin): Step-by-step guide to building a complete VibeOS plugin with tools, hooks, data files, and skills
- [Automate with Cron](https://vibeos.com.ru/handbook/guides/automate-with-cron): Real-world automation patterns using VibeOS cron — monitoring, reports, pipelines, and multi-skill workflows
- [Work with Skills](https://vibeos.com.ru/handbook/guides/work-with-skills): Find, install, use, and create skills — on-demand knowledge that teaches VibeOS new workflows
- [Delegation Patterns](https://vibeos.com.ru/handbook/guides/delegation-patterns): When and how to use subagent delegation — patterns for parallel research, code review, and multi-file work
- [GitHub PR Review Agent](https://vibeos.com.ru/handbook/guides/github-pr-review-agent): Build an automated AI code reviewer that monitors your repos, reviews pull requests, and delivers feedback — hands-free

## Developer Guide

- [Contributing](https://vibeos.com.ru/handbook/developer-guide/contributing): How to contribute to VibeOS — dev setup, code style, PR process
- [Architecture](https://vibeos.com.ru/handbook/developer-guide/architecture): VibeOS internals — major subsystems, execution paths, data flow, and where to read next
- [Agent Loop](https://vibeos.com.ru/handbook/developer-guide/agent-loop): Detailed walkthrough of AIAgent execution, API modes, tools, callbacks, and fallback behavior
- [Prompt Assembly](https://vibeos.com.ru/handbook/developer-guide/prompt-assembly): How VibeOS builds the system prompt, preserves cache stability, and injects ephemeral layers
- [Context Compression & Caching](https://vibeos.com.ru/handbook/developer-guide/context-compression-and-caching)
- [Gateway Internals](https://vibeos.com.ru/handbook/developer-guide/gateway-internals): How the messaging gateway boots, authorizes users, routes sessions, and delivers messages
- [Session Storage](https://vibeos.com.ru/handbook/developer-guide/session-storage)
- [Provider Runtime](https://vibeos.com.ru/handbook/developer-guide/provider-runtime): How VibeOS resolves providers, credentials, API modes, and auxiliary models at runtime
- [Adding Tools](https://vibeos.com.ru/handbook/developer-guide/adding-tools): How to add a new tool to VibeOS — schemas, handlers, registration, and toolsets
- [Adding Providers](https://vibeos.com.ru/handbook/developer-guide/adding-providers): How to add a new inference provider to VibeOS — auth, runtime resolution, CLI flows, adapters, tests, and docs
- [Adding Platform Adapters](https://vibeos.com.ru/handbook/developer-guide/adding-platform-adapters)
- [Creating Skills](https://vibeos.com.ru/handbook/developer-guide/creating-skills): How to create skills for VibeOS — SKILL.md format, guidelines, and publishing
- [Extending the CLI](https://vibeos.com.ru/handbook/developer-guide/extending-the-cli): Build wrapper CLIs that extend the VibeOS TUI with custom widgets, keybindings, and layout changes

## Reference

- [CLI Commands](https://vibeos.com.ru/handbook/reference/cli-commands): Authoritative reference for VibeOS terminal commands and command families
- [Slash Commands](https://vibeos.com.ru/handbook/reference/slash-commands): Complete reference for interactive CLI and messaging slash commands
- [Profile Commands](https://vibeos.com.ru/handbook/reference/profile-commands)
- [Environment Variables](https://vibeos.com.ru/handbook/reference/environment-variables): Complete reference of all environment variables used by VibeOS
- [Tools Reference](https://vibeos.com.ru/handbook/reference/tools-reference): Authoritative reference for VibeOS built-in tools, grouped by toolset
- [Toolsets Reference](https://vibeos.com.ru/handbook/reference/toolsets-reference): Reference for VibeOS core, composite, platform, and dynamic toolsets
- [MCP Config Reference](https://vibeos.com.ru/handbook/reference/mcp-config-reference): Reference for VibeOS MCP configuration keys, filtering semantics, and utility-tool policy
- [Model Catalog](https://vibeos.com.ru/handbook/reference/model-catalog)
- [Bundled Skills Catalog](https://vibeos.com.ru/handbook/reference/skills-catalog): Table of all ~90 skills bundled with VibeOS
- [Optional Skills Catalog](https://vibeos.com.ru/handbook/reference/optional-skills-catalog): Table of ~60 additional installable skills
- [FAQ & Troubleshooting](https://vibeos.com.ru/handbook/reference/faq): Frequently asked questions and solutions to common issues with VibeOS