Quickstart
This guide gets you from zero to a working VibeOS setup. Install, choose a provider, verify a working chat, and know what to do when something breaks.
Prefer to watch?
Upstream VibeOS walkthroughs still help for the shared agent core. For VibeOS-specific install and packaging, prefer the repo README and vibeos.com.ru/download.
Who this is for
- Brand new and want the shortest path to a working setup
- Switching providers and don't want to lose time to config mistakes
- Setting up VibeOS for a team, bot, or always-on workflow
- Tired of "it installed, but it still does nothing"
The fastest path
Pick the row that matches your goal:
| Goal | Do this first | Then do this |
|---|---|---|
| I just want VibeOS working on my machine | vibeos setup (or vibeos setup) | Run a real chat and verify it responds |
| I already know my provider | vibeos model | Save the config, then start chatting |
| I want a bot or always-on setup | vibeos gateway setup after CLI works | Connect Telegram, Discord, Slack, or another platform |
| I want a local or self-hosted model | vibeos model → custom endpoint | Verify the endpoint, model name, and context length |
| I want multi-provider fallback | vibeos model first | Add routing and fallback only after the base chat works |
Rule of thumb: if VibeOS cannot complete a normal chat, do not add more features yet. Get one clean conversation working first, then layer on gateway, cron, skills, voice, or routing.
1. Install VibeOS
With the VibeOS Desktop installer on macOS (recommended)
Download the latest DMG / VibeOS.app from vibeos.com.ru/download and run it. Data lives in ~/.vibeos.
From source (CLI + optional desktop)
git clone https://github.com/Linx72/VibeOS.git
cd vibeos
./scripts/bootstrap-vibeos.sh
vibeos doctor # or: vibeos doctor
Without desktop (curl installer)
Prefer bootstrap above on a checkout. Some guides still show:
curl -fsSL https://vibeos.com.ru/downloads/install.sh | bash
See the full Installation Guide for platform notes.
If you're installing on a phone, see the dedicated Termux guide for the tested manual path, supported extras, and current Android-specific limitations.
After a shell install finishes, reload your shell:
source ~/.bashrc # or source ~/.zshrc
For detailed installation options, prerequisites, and troubleshooting, see the Installation guide.
2. Choose a Provider
The single most important setup step. Use vibeos model (or vibeos model) to walk through the choice interactively:
vibeos model
One subscription covers 300+ models plus the Tool Gateway (web search, image generation, TTS, cloud browser). On a fresh install:
vibeos setup --portal
That logs you in, sets Nous as your provider, and turns on the Tool Gateway in one command.
On a fresh install, vibeos setup offers three modes:
- Quick Setup (Nous Portal) — free OAuth login, no API keys; sets up a model plus the Tool Gateway tools. The recommended fast path.
- Full Setup — walk through every provider, tool, and option yourself (bring your own keys).
- Blank Slate — everything starts off except the bare minimum needed to run an agent: provider & model, the File Operations toolset, and the Terminal toolset. No web, browser, code execution, vision, memory, delegation, cron, skills, plugins, or MCP servers — and compression, checkpoints, smart routing, and memory capture are all disabled. After the minimal baseline is applied, you choose one of two paths: start with everything disabled (finish now with the minimal agent), or walk through all configurations (opt in to tools, skills, plugins, MCP, and messaging). Pick this when you want a minimal, fully-controlled agent and intend to enable only exactly what you need.
Blank Slate writes an explicit platform_toolsets.cli list plus agent.disabled_toolsets, so nothing you didn't choose ever loads — not even after vibeos update. Re-enable anything later with vibeos tools, seed skills with vibeos skills opt-in --sync, or tune settings with vibeos setup agent.
Good defaults:
| Provider | What it is | How to set up |
|---|---|---|
| Nous Portal | Subscription-based, zero-config | OAuth login via vibeos model |
| OpenAI ChatGPT | ChatGPT account route | Device code auth via vibeos model or vibeos auth add chatgpt-oauth |
| Anthropic | Claude models directly — Max plan + extra usage credits (OAuth), or API key for pay-per-token | vibeos model → OAuth login (requires Max + extra credits), or an Anthropic API key |
| OpenRouter | Multi-provider routing across many models | Enter your API key |
| Z.AI | GLM / Zhipu-hosted models | Set GLM_API_KEY / ZAI_API_KEY (also accepts Z_AI_API_KEY) |
| Kimi / Moonshot | Moonshot-hosted coding and chat models | Set KIMI_API_KEY (or the Kimi-Coding-specific KIMI_CODING_API_KEY) |
| Kimi / Moonshot China | China-region Moonshot endpoint | Set KIMI_CN_API_KEY |
| Arcee AI | Trinity models | Set ARCEEAI_API_KEY |
| GMI Cloud | Multi-model direct API | Set GMI_API_KEY |
| MiniMax (OAuth) | MiniMax frontier model via browser OAuth — no API key needed (model name in vibeos_cli/models.py may change between releases) | vibeos model → MiniMax (OAuth) |
| MiniMax | International MiniMax endpoint | Set MINIMAX_API_KEY |
| MiniMax China | China-region MiniMax endpoint | Set MINIMAX_CN_API_KEY |
| Alibaba Cloud | Qwen models via DashScope | Set DASHSCOPE_API_KEY (Qwen Coding Plan also accepts ALIBABA_CODING_PLAN_API_KEY) |
| Hugging Face | 20+ open models via unified router (Qwen, DeepSeek, Kimi, etc.) | Set HF_TOKEN |
| AWS Bedrock | Claude, Nova, Llama, DeepSeek via native Converse API | IAM role or aws configure (guide) |
| Azure Foundry | Azure AI Foundry-hosted models | Set AZURE_FOUNDRY_API_KEY + AZURE_FOUNDRY_BASE_URL |
| Google AI Studio | Gemini models via direct API | Set GOOGLE_API_KEY / GEMINI_API_KEY |
| xAI | Grok models via direct API | Set XAI_API_KEY |
| xAI Grok OAuth | SuperGrok / Premium+ subscription, no API key needed | vibeos model → xAI Grok OAuth |
| NovitaAI | Multi-model API gateway | Set NOVITA_API_KEY |
| StepFun | Step Plan models | Set STEPFUN_API_KEY |
| Xiaomi MiMo | Xiaomi-hosted models | Set XIAOMI_API_KEY |
| Tencent TokenHub | Tencent-hosted models | Set TOKENHUB_API_KEY |
| Ollama Cloud | Managed Ollama-hosted models | Set OLLAMA_API_KEY |
| LM Studio | Local desktop app exposing an OpenAI-compatible API | Set LM_API_KEY (and LM_BASE_URL if non-default) |
| Qwen OAuth | Qwen Portal browser OAuth — no API key needed | vibeos model → Qwen OAuth |
| Kilo Code | KiloCode-hosted models | Set KILOCODE_API_KEY |
| OpenCode Zen | Pay-as-you-go access to curated models | Set OPENCODE_ZEN_API_KEY |
| OpenCode Go | $10/month subscription for open models | Set OPENCODE_GO_API_KEY |
| DeepSeek | Direct DeepSeek API access | Set DEEPSEEK_API_KEY |
| NVIDIA NIM | Nemotron models via build.nvidia.com or local NIM | Set NVIDIA_API_KEY (optional: NVIDIA_BASE_URL) |
| GitHub Copilot | GitHub Copilot subscription (GPT-5.x, Claude, Gemini, etc.) | OAuth via vibeos model, or COPILOT_GITHUB_TOKEN / GH_TOKEN |
| GitHub Copilot ACP | Copilot ACP agent backend (spawns local copilot CLI) | vibeos model (requires copilot CLI + copilot login) |
| Custom Endpoint | VLLM, SGLang, Ollama, or any OpenAI-compatible API | Set base URL + API key |
For most first-time users: choose a provider, accept the defaults unless you know why you're changing them. The full provider catalog with env vars and setup steps lives on the Providers page.
VibeOS requires a model with at least 64,000 tokens of context. Models with smaller windows cannot maintain enough working memory for multi-step tool-calling workflows and will be rejected at startup. Most hosted models (Claude, GPT, Gemini, Qwen, DeepSeek) meet this easily. If you're running a local model, set its context size to at least 64K (e.g. --ctx-size 65536 for llama.cpp or -c 65536 for Ollama).
You can switch providers at any time with vibeos model — no lock-in. For a full list of all supported providers and setup details, see AI Providers.
How settings are stored
VibeOS separates secrets from normal config:
- Secrets and tokens →
~/.vibeos/.env - Non-secret settings →
~/.vibeos/config.yaml
The easiest way to set values correctly is through the CLI:
vibeos config set model anthropic/claude-opus-4.6
vibeos config set terminal.backend docker
vibeos config set OPENROUTER_API_KEY sk-or-...
The right value goes to the right file automatically.
3. Run Your First Chat
vibeos # classic CLI
vibeos --tui # modern TUI (recommended)
You'll see a welcome banner with your model, available tools, and skills. Use a prompt that's specific and easy to verify:
VibeOS ships with two terminal interfaces: the classic prompt_toolkit CLI and a newer TUI with modal overlays, mouse selection, and non-blocking input. Both share the same sessions, slash commands, and config — try each with vibeos vs vibeos --tui.
Summarize this repo in 5 bullets and tell me what the main entrypoint is.
Check my current directory and tell me what looks like the main project file.
Help me set up a clean GitHub PR workflow for this codebase.
What success looks like:
- The banner shows your chosen model/provider
- VibeOS replies without error
- It can use a tool if needed (terminal, file read, web search)
- The conversation continues normally for more than one turn
If that works, you're past the hardest part.
4. Verify Sessions Work
Before moving on, make sure resume works:
vibeos --continue # Resume the most recent session
vibeos -c # Short form
That should bring you back to the session you just had. If it doesn't, check whether you're in the same profile and whether the session actually saved. This matters later when you're juggling multiple setups or machines.
5. Try Key Features
Use the terminal
❯ What's my disk usage? Show the top 5 largest directories.
The agent runs terminal commands on your behalf and shows results.
Slash commands
Type / to see an autocomplete dropdown of all commands:
| Command | What it does |
|---|---|
/help | Show all available commands |
/tools | List available tools |
/model | Switch models interactively |
/personality pirate | Try a fun personality |
/save | Save the conversation |
Multi-line input
Press Alt+Enter, Ctrl+J, or Shift+Enter to add a new line. Shift+Enter requires a terminal that sends it as a distinct sequence (Kitty / foot / WezTerm / Ghostty by default; iTerm2 / Alacritty / VS Code terminal once the Kitty keyboard protocol is enabled). Alt+Enter and Ctrl+J work in every terminal.
Interrupt the agent
If the agent is taking too long, type a new message and press Enter — it interrupts the current task and switches to your new instructions. Ctrl+C also works.
6. Add the Next Layer
Only after the base chat works. Pick what you need:
Bot or shared assistant
vibeos gateway setup # Interactive platform configuration
Connect Telegram, Discord, Slack, WhatsApp, Signal, Email, or Home Assistant, or Microsoft Teams.
Automation and tools
vibeos tools— tune tool access per platformvibeos skills— browse and install reusable workflows- Cron — only after your bot or CLI setup is stable
Sandboxed terminal
For safety, run the agent in a Docker container or on a remote server:
vibeos config set terminal.backend docker # Docker isolation
vibeos config set terminal.backend ssh # Remote server
Voice mode
# From the VibeOS install directory (the curl installer placed it at
# ~/.vibeos/vibeos-agent on Linux/macOS or %LOCALAPPDATA%\vibeos\vibeos-agent on Windows):
cd ~/.vibeos/vibeos-agent
uv pip install -e ".[voice]"
# Includes faster-whisper for free local speech-to-text
Then in the CLI: /voice on. Press Ctrl+B to record. See Voice Mode.
Skills
Skills are on-demand instruction documents that teach VibeOS how to do a specific task — deploy to Kubernetes, open a GitHub PR, fine-tune a model, search for GIFs. Each is a SKILL.md file with a name, a description, and a step-by-step procedure. The agent reads the short descriptions for free and only loads a skill's full content when a task actually calls for it, so adding skills doesn't bloat every request.
VibeOS ships with a catalog of bundled skills already installed in ~/.vibeos/skills/. You can add more from the Skills Hub, or write your own.
Browse and install from the hub:
vibeos skills browse # list everything available
vibeos skills search kubernetes # find skills by keyword
vibeos skills install openai/skills/k8s # install one (runs a security scan first)
The install argument is a source/path slug from the hub — openai/skills/k8s means the k8s skill from OpenAI's catalog. vibeos skills browse shows the exact slugs to use.
Use a skill — every installed skill becomes a slash command automatically:
/k8s deploy the staging manifest # run the skill with a request
/k8s # load it and let VibeOS ask what you need
This works in the CLI and in any connected messaging platform. You don't have to install everything up front — the agent picks the right bundled skill on its own during normal conversation when a task matches one.
See Skills System for writing your own, external skill directories, and the full hub source list.
MCP servers
# Add to ~/.vibeos/config.yaml
mcp_servers:
github:
command: npx
args: ["-y", "@modelcontextprotocol/server-github"]
env:
GITHUB_PERSONAL_ACCESS_TOKEN: "ghp_xxx"
Editor integration (ACP)
ACP support ships with the standard [all] extras, so the curl installer already includes it. Just run:
vibeos acp
(If you installed without [all], run cd ~/.vibeos/vibeos-agent && uv pip install -e ".[acp]" first.)
Common Failure Modes
These are the problems that waste the most time:
| Symptom | Likely cause | Fix |
|---|---|---|
| VibeOS opens but gives empty or broken replies | Provider auth or model selection is wrong | Run vibeos model again and confirm provider, model, and auth |
| Custom endpoint "works" but returns garbage | Wrong base URL, model name, or not actually OpenAI-compatible | Verify the endpoint in a separate client first |
| Gateway starts but nobody can message it | Bot token, allowlist, or platform setup is incomplete | Re-run vibeos gateway setup and check vibeos gateway status |
vibeos --continue can't find old session | Switched profiles or session never saved | Check vibeos sessions list and confirm you're in the right profile |
| Model unavailable or odd fallback behavior | Provider routing or fallback settings are too aggressive | Keep routing off until the base provider is stable |
vibeos doctor flags config problems | Config values are missing or stale | Fix the config, retest a plain chat before adding features |
Recovery Toolkit
When something feels off, use this order:
vibeos doctorvibeos modelvibeos setupvibeos sessions listvibeos --continuevibeos gateway status
That sequence gets you from "broken vibes" back to a known state fast.
Quick Reference
| Command | Description |
|---|---|
vibeos | Start chatting |
vibeos model | Choose your LLM provider and model |
vibeos tools | Configure which tools are enabled per platform |
vibeos setup | Full setup wizard (configures everything at once) |
vibeos doctor | Diagnose issues |
vibeos update | Update to latest version |
vibeos gateway | Start the messaging gateway |
vibeos --continue | Resume last session |
Next Steps
- CLI Guide — Master the terminal interface
- Configuration — Customize your setup
- Messaging Gateway — Connect Telegram, Discord, Slack, WhatsApp, Signal, Email, Home Assistant, Teams, and more
- Tools & Toolsets — Explore available capabilities
- AI Providers — Full provider list and setup details
- Skills System — Reusable workflows and knowledge
- Tips & Best Practices — Power user tips