Get Started

Choose Your Path

View as Markdown

Use this page to select the documentation path that matches your goal. Each path assumes a source checkout of the repository. The installation script creates the project virtual environment.

Before you begin, review Prerequisites for the system, software, and audio requirements.

Choose by Goal

Match your goal to its starting page, then follow the related guide for the next part of the workflow:

GoalStart HereContinue With
Talk to the default agentPrerequisitesInstallation, then Quickstart
Understand the pipeline firstOverviewArchitecture
Change models or behaviorConfigureServing with vLLM or Tool Calling
Add pipeline codeExtendBuilder API or RTVI Control Plane
Measure an agentEvaluation overviewEvaluation Quickstart

First-Run Sequence

For the shortest path to a working browser session:

  1. Verify the prerequisites.
  2. Install the Python environment and browser dependencies.
  3. Complete the quickstart to launch vLLM, the agent server, and the client.

If a step fails, use Troubleshooting.