Skip to main content

​
Quickstart

This guide gets Avibe running on macOS or Linux and has you chatting with Vibey, Avibe’s built-in AI partner. All you need is one model source for the gateway: an API key, or a subscription signed in as a gateway source. A subscription your Claude Code or Codex CLI uses natively does not supply Vibey.

​
1. Install Avibe

Open source — view the script on GitHub. The short URL is a 307 redirect to that file. Prefer an app? On macOS or Windows, install the desktop app instead. It opens the setup wizard itself, so continue with step 2. Start it:
The browser setup wizard opens automatically. If it does not, use the local URL printed in the terminal.

​
2. Add a model source

The wizard opens on an introduction. Select Get started. On Add model providers, select Add subscription or API Key, then paste an API key, or sign in with a subscription and choose Sign in as a gateway source, so that Vibey can use it. Avibe installs and starts Model Hub, its local model gateway, if it is not running yet. If Avibe detects API keys you already have configured, it offers to migrate them instead of making you retype them. When a source is added, select Continue to assistants.

​
3. Chat with Vibey

On Choose your AI assistants, Vibey’s card comes first, marked Built-in · always on. If it says No model yet. Pick one to start., pick one of the models it offers, or open All models…. Then select Enter workspace. In the Workbench, send Vibey a first message:
Then check local status:

​
4. Also bring your own agents

Avibe runs the official Claude Code, Codex, and OpenCode unchanged, alongside Vibey. Install any of them: OpenCode:
Claude Code:
Codex:
Verify:
The Choose your AI assistants screen detects installed CLIs, offers a one-click install for missing ones, and lets you enable each one. If you install one after setup, enable it in Settings > Backends. Your Model Hub sources can supply these agents too.

​
5. Connect a chat app (optional)

The Workbench is always on, so a chat app is optional. To reach Avibe from Slack, Discord, Telegram, WeChat, or Lark / Feishu, connect it in Settings > Messaging Platforms — see Slack, Discord, Telegram, or WeChat and Lark — then send the same smoke-test message in an enabled chat.

​
6. Take it with you (avibe.bot Cloud)

Your Avibe shouldn’t be stuck on your desk. From a phone, tablet, or borrowed laptop:
One command pairs you with a personal you-app.avibe.bot URL through a secure avibe.bot tunnel. Your codebase and Agent runtime stay on your machine; the tunnel carries Web UI traffic back to it. See avibe.bot Cloud for the full remote-access setup and the Local-first boundary inventory for every other network path.