Docs/Getting Started

Getting Started

Follow these steps to install Hybrix, run the onboarding wizard, and have your first AI agent up and running. It should take about 5 minutes.

What you need

  • Node.js 20 or later (22 LTS recommended)
  • An API key from at least one LLM provider (OpenAI, Anthropic, Google, Mistral, etc.)
  • macOS, Linux, or Windows with WSL
Don't have Node.js? Install it from nodejs.org or use nvm install 22 for version management.

Quick setup

1

Install Hybrix globally

bash
npm install -g hybrix-lab

This installs the hybrix CLI globally. You can also use npx hybrix-lab to run without installing.

2

Run the onboarding wizard

bash
hybrix init --wizard

The wizard guides you through:

  • Choosing your LLM provider(s)
  • Setting your API key(s)
  • Creating your first agent with a name and role
  • Generating a hybrid mascot for your agent
3

Verify the gateway is running

bash
hybrix status

You should see the gateway status and your configured agents.

4

Open the dashboard

bash
hybrix start
# Dashboard: http://localhost:3000
By default, the dashboard is only accessible locally. See Gateway Configuration for remote access options.
5

Send your first message

Open the web chat at http://localhost:3000/chat and send a message to your agent. You can also connect a channel like Discord or Slack to start chatting from there.

bash
# Or via CLI:
hybrix chat "Hello, what can you do?"

What to do next

Connect a Channel

Link Discord, Slack, Telegram, or other platforms to your gateway.

Configure the Gateway

Customize routing, environment variables, and multi-agent setups.

Assign Skills

Give your agents abilities like shell execution, web browsing, and more.

Security & Auth

Set up OAuth, SSO, and access controls for your workspace.

← Docs HomeInstallation →