Getting Started - Vellum Docs

Installation

There are two ways to install the Vellum Assistant: using the desktop app (recommended) or installing it manually via the command line.

The easiest way to get started is by downloading the Vellum Assistant desktop application. It handles all configuration and setup automatically.

Visit the downloads page and download the installer for your operating system.
Run the installer and follow the on-screen prompts.
Once installed, open the Vellum Assistant app and sign in with your Vellum account.
The app will automatically configure your environment and connect to the Vellum platform.

If you prefer to install the assistant manually, you can use the install script:

curl -fsSL https://vellum.ai/install.sh | bash

After running the install script, verify the installation:

vel --version

Then authenticate with your Vellum account:

vel auth login

Key terms and concepts used throughout the Vellum Assistant ecosystem.

Assistant: An AI-powered agent configured to perform tasks on your behalf. Each assistant is backed by a large language model and can be customized with specific instructions, tools, and knowledge bases.
Environment: An isolated runtime context in which an assistant operates. Environments allow you to separate development, staging, and production configurations.
Interface: The surface through which users interact with the assistant. Interfaces include the desktop app, command-line tool, and API endpoints.
Knowledge Base: A collection of documents and data that the assistant can reference when responding to queries. Knowledge bases provide domain-specific context for more accurate responses.
Tool: An action or capability that the assistant can invoke during a conversation. Tools allow the assistant to interact with external systems, run code, search the web, and more.
Workflow: A structured sequence of steps that an assistant follows to complete a complex task. Workflows can include conditional logic, loops, and integrations with external services.