Docs / Getting Started
Edit on GitHub

Onboarding

Set up OpenViber on your machine with automated configuration.

Prerequisites

  • Node.js 18 or later
  • pnpm (recommended) or npm

Quick Setup

Run the onboard command to create your config:

npx openviber onboard

This creates:

  • ~/.openviber/agents/default.yaml — Default agent configuration
  • ~/.openviber/jobs/ — Directory for scheduled tasks
  • ~/.openviber/space/ — Space files

Set Your API Key

OpenViber uses OpenRouter by default for access to multiple models:

export OPENROUTER_API_KEY="sk-or-v1-..."

Get a key at openrouter.ai/keys

Start Your Viber

openviber start

Open http://localhost:6006 to access the Viber Board.

Alternative: Global Install

Install the CLI globally for easier access:

pnpm add -g openviber

Verify

Check your setup:

openviber status

Next Steps