Getting Started

Learn how to install the VoltX CLI globally and perform the initial configuration to start using AI features.

Installation

Install Voltx globally using your preferred package manager

npm i -g voltx

voltx -v

After installation, you'll need to initialize VoltX with your preferred configuration:

voltx init

API Key Required

You must configure at least one AI provider with a valid API key during the init process to use VoltX's core features like chat and agent mode.

This command will guide you through the setup process:

Create a User Alias

Enter a unique username for your VoltX profile.

Select AI Provider

Choose the first AI service you want to connect with.

Enter API Key

Paste the API key for the selected provider.

Select Default Model

Pick the default AI model you want to use with this provider.

Configure More Providers (Optional)

Choose whether to add another AI provider now or finish setup.

VoltX creates a configuration directory structure in your home directory:

config.toml

To see available commands directly from your terminal, you can use the help command:

voltx help

Now that you have VoltX installed and configured, you can: