---
verifiedAt: '2026-08-22'
---

# Hermes Guide

`Hermes` is an AI Agent tool that supports connecting to `Flux` through a custom OpenAI-compatible interface.

## Installation

Use the official installation script:

```bash
curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash
```

After installation, the default config directory is usually `~/.hermes`.

## Connect to Flux

1. Follow [Create API Key](https://docs.tryflux.net/en/docs/flux/create-apikey.md) to generate an API key.
2. Edit `~/.hermes/config.yaml` and add or confirm the following configuration:

   ```yaml
   model:
     default: 'gpt-5.6-sol'
     provider: 'custom'
     base_url: 'https://api.tryflux.net/v1'
   ```

3. Edit `~/.hermes/.env` and write:

   ```env
   OPENAI_API_KEY=YOUR_FLUX_API_KEY
   OPENAI_BASE_URL=https://api.tryflux.net/v1
   ```

   Replace `YOUR_FLUX_API_KEY` with your actual API key.

## Verify Configuration

After saving the configuration, run:

```bash
hermes config check
hermes chat -Q -q 'Only reply OK' --max-turns 3
```

If the command returns normally, `Hermes` has successfully called a model through `Flux`.

## More Related Content

- [Create API Key](https://docs.tryflux.net/en/docs/flux/create-apikey.md)
- [Billing](https://docs.tryflux.net/en/docs/flux/billing.md)