Skip to main content

Install for AI agents

This page is written for an AI coding agent helping a human install Avibe.

Rules

  • Ask before choosing a chat platform, agent backend, workspace, or credential value.
  • Do not guess secrets, bot tokens, app tokens, API keys, workspace IDs, or chat IDs.
  • Prefer the browser setup wizard launched by vibe over hand-editing config files.
  • Do not restart an already-running local vibe service unless the user confirms it is safe.
  • Keep setup local-first. Do not expose public webhooks unless the selected platform requires it.

1. Check the machine

On Windows, prefer WSL unless the user explicitly wants native PowerShell.

2. Install Avibe

macOS / Linux:
Open source — view the script on GitHub. The short URL is a 307 redirect to that file. Windows PowerShell:
Verify:

3. Optional: install a coding CLI

On a new install with Model Hub on (the default), new chats start with Vibey, Avibe’s built-in agent. Vibey needs no install: it runs once Model Hub has a model source and Vibey has a model. Skip this step if the user wants to start with Vibey alone; Claude Code, Codex, or OpenCode run alongside Vibey, and the user can make one the default later in Agents. Otherwise, ask the user which CLI agent they want first. Recommended default:
  • OpenCode for low-friction setup.
  • Claude Code for deeper codebase work.
  • Codex for OpenAI workflows.
OpenCode:
Claude Code:
Codex:
Verify:

4. Start the setup wizard

Walk the user through the wizard:
  1. Add model providers: the user signs in with a subscription or enters an API key themselves.
  2. Choose your AI assistants: give Vibey a model, or enable an installed CLI agent.
  3. Enter workspace.
  4. Ask the user which project to work in. In the Workbench, open it with Open project and start a session there.
Chat platforms and the channel or chat scopes that should be enabled are configured afterwards in Settings > Messaging Platforms. If the smoke test will run in a chat channel, enable that channel under Groups and set its Working Directory to the user’s project.

5. Optional remote Web UI

If the user wants to open the local Web UI from another device:
Use this for Web UI access, not for exposing the agent runtime directly.

6. Smoke test

Ask the user to send:
Then verify:
If messages do not arrive: