Flux-CLI
Quick Start

Quick Start

This guide will get you up and running with Flux-CLI in under 5 minutes.

Step 1: Set Up Your API Key

Create a .env file in your workspace:

.env

These environment variables are loaded automatically by Flux-CLI.

API_KEY=your_api_key_here
BASE_URL=https://openrouter.ai/api/v1

You can get a free API key from OpenRouter. No credit card required for most models.

Step 2: Launch Flux-CLI

Navigate to your project directory and run:

Launch interactive mode

Starts the interactive REPL with the gradient ASCII banner.

cd your-project
python main.py

You should see the Flux-CLI banner:

██╗    ███████╗██╗     ██╗   ██╗██╗  ██╗
╚██╗   ██╔════╝██║     ██║   ██║╚██╗██╔╝
 ╚██╗  █████╗  ██║     ██║   ██║ ╚███╔╝
 ██╔╝  ██╔══╝  ██║     ██║   ██║ ██╔██╗
██╔╝   ██║     ███████╗╚██████╔╝██╔╝ ██╗
╚═╝    ╚═╝     ╚══════╝ ╚═════╝ ╚═╝  ╚═╝

Step 3: Try Your First Command

Once in the REPL, type a prompt:

Example interaction

Flux-CLI will process your request and use the list_dir tool to show files.

❯ What files are in the current directory?

You'll see Flux-CLI:

  1. Stream a response explaining what it's doing
  2. Call the list_dir tool to explore the directory
  3. Display results in a formatted panel

Step 4: Try Slash Commands

Flux-CLI supports interactive slash commands:

Slash commands

Slash commands provide quick access to configuration and status information.

❯ /help    # Show help dashboard
❯ /config  # Show current configuration
❯ /stats   # Show session statistics
❯ /tools   # List all available tools

Step 5: Single-Command Mode

You can also run Flux-CLI with a single prompt:

Single command mode

Runs a single prompt and exits. Useful for automation and scripting.

python main.py "List all Python files in the project"

What's Next?

Now that you have Flux-CLI running:

Provider System

How Flux-CLI supports multiple LLM providers.

Requirements

System requirements for running Flux-CLI.

On this page

Quick StartStep 1: Set Up Your API KeyStep 2: Launch Flux-CLIStep 3: Try Your First CommandStep 4: Try Slash CommandsStep 5: Single-Command ModeWhat's Next?