bot/docs/concepts/models.md

summary, read_when, title

summary	read_when	title
Models CLI: list, set, aliases, fallbacks, scan, status	Adding or modifying models CLI (models list/set/scan/aliases/fallbacks) Changing model fallback behavior or selection UX Updating model scan probes (tools/images)	Models CLI

Models CLI

See /concepts/model-failover for auth profile rotation, cooldowns, and how that interacts with fallbacks. Quick provider overview + examples: /concepts/model-providers.

How model selection works

HanzoBot selects models in this order:

1. Primary model (agents.defaults.model.primary or agents.defaults.model).
2. Fallbacks in agents.defaults.model.fallbacks (in order).
3. Provider auth failover happens inside a provider before moving to the next model.

Related:

• agents.defaults.models is the allowlist/catalog of models HanzoBot can use (plus aliases).
• agents.defaults.imageModel is used only when the primary model can’t accept images.
• Per-agent defaults can override agents.defaults.model via agents.list[].model plus bindings (see /concepts/multi-agent).

Quick model policy

• Set your primary to the strongest latest-generation model available to you.
• Use fallbacks for cost/latency-sensitive tasks and lower-stakes chat.
• For tool-enabled agents or untrusted inputs, avoid older/weaker model tiers.

Setup wizard (recommended)

If you don’t want to hand-edit config, run the onboarding wizard:

hanzo-bot onboard

It can set up model + auth for common providers, including OpenAI Code (Codex) subscription (OAuth) and Anthropic (API key or claude setup-token).

Config keys (overview)

• agents.defaults.model.primary and agents.defaults.model.fallbacks
• agents.defaults.imageModel.primary and agents.defaults.imageModel.fallbacks
• agents.defaults.models (allowlist + aliases + provider params)
• models.providers (custom providers written into models.json)

Model refs are normalized to lowercase. Provider aliases like z.ai/* normalize to zai/*.

Provider configuration examples (including OpenCode Zen) live in /gateway/configuration.

“Model is not allowed” (and why replies stop)

If agents.defaults.models is set, it becomes the allowlist for /model and for session overrides. When a user selects a model that isn’t in that allowlist, HanzoBot returns:

Model "provider/model" is not allowed. Use /model to list available models.

This happens before a normal reply is generated, so the message can feel like it “didn’t respond.” The fix is to either:

• Add the model to agents.defaults.models, or
• Clear the allowlist (remove agents.defaults.models), or
• Pick a model from /model list.

Example allowlist config:

{
  agent: {
    model: { primary: "anthropic/claude-sonnet-4-5" },
    models: {
      "anthropic/claude-sonnet-4-5": { alias: "Sonnet" },
      "anthropic/claude-opus-4-6": { alias: "Opus" },
    },
  },
}

Switching models in chat (/model)

You can switch models for the current session without restarting:

/model
/model list
/model 3
/model openai/gpt-5.2
/model status

Notes:

• /model (and /model list) is a compact, numbered picker (model family + available providers).
• On Discord, /model and /models open an interactive picker with provider and model dropdowns plus a Submit step.
• /model <#> selects from that picker.
• /model status is the detailed view (auth candidates and, when configured, provider endpoint baseUrl + api mode).
• Model refs are parsed by splitting on the first /. Use provider/model when typing /model <ref>.
• If the model ID itself contains / (OpenRouter-style), you must include the provider prefix (example: /model openrouter/moonshotai/kimi-k2).
• If you omit the provider, HanzoBot treats the input as an alias or a model for the default provider (only works when there is no / in the model ID).

Full command behavior/config: Slash commands.

CLI commands

hanzo-bot models list
hanzo-bot models status
hanzo-bot models set <provider/model>
hanzo-bot models set-image <provider/model>

hanzo-bot models aliases list
hanzo-bot models aliases add <alias> <provider/model>
hanzo-bot models aliases remove <alias>

hanzo-bot models fallbacks list
hanzo-bot models fallbacks add <provider/model>
hanzo-bot models fallbacks remove <provider/model>
hanzo-bot models fallbacks clear

hanzo-bot models image-fallbacks list
hanzo-bot models image-fallbacks add <provider/model>
hanzo-bot models image-fallbacks remove <provider/model>
hanzo-bot models image-fallbacks clear

hanzo-bot models (no subcommand) is a shortcut for models status.

models list

Shows configured models by default. Useful flags:

• --all: full catalog
• --local: local providers only
• --provider <name>: filter by provider
• --plain: one model per line
• --json: machine‑readable output

models status

Shows the resolved primary model, fallbacks, image model, and an auth overview of configured providers. It also surfaces OAuth expiry status for profiles found in the auth store (warns within 24h by default). --plain prints only the resolved primary model. OAuth status is always shown (and included in --json output). If a configured provider has no credentials, models status prints a Missing auth section. JSON includes auth.oauth (warn window + profiles) and auth.providers (effective auth per provider). Use --check for automation (exit 1 when missing/expired, 2 when expiring).

Auth choice is provider/account dependent. For always-on gateway hosts, API keys are usually the most predictable; subscription token flows are also supported.

Example (Anthropic setup-token):

claude setup-token
hanzo-bot models status

Scanning (OpenRouter free models)

hanzo-bot models scan inspects OpenRouter’s free model catalog and can optionally probe models for tool and image support.

Key flags:

• --no-probe: skip live probes (metadata only)
• --min-params <b>: minimum parameter size (billions)
• --max-age-days <days>: skip older models
• --provider <name>: provider prefix filter
• --max-candidates <n>: fallback list size
• --set-default: set agents.defaults.model.primary to the first selection
• --set-image: set agents.defaults.imageModel.primary to the first image selection

Probing requires an OpenRouter API key (from auth profiles or OPENROUTER_API_KEY). Without a key, use --no-probe to list candidates only.

Scan results are ranked by:

1. Image support
2. Tool latency
3. Context size
4. Parameter count

Input

• OpenRouter /models list (filter :free)
• Requires OpenRouter API key from auth profiles or OPENROUTER_API_KEY (see /environment)
• Optional filters: --max-age-days, --min-params, --provider, --max-candidates
• Probe controls: --timeout, --concurrency

When run in a TTY, you can select fallbacks interactively. In non‑interactive mode, pass --yes to accept defaults.

Models registry (models.json)

Custom providers in models.providers are written into models.json under the agent directory (default ~/.bot/agents/<agentId>/models.json). This file is merged by default unless models.mode is set to replace.

Merge mode precedence for matching provider IDs:

• Non-empty apiKey/baseUrl already present in the agent models.json win.
• Empty or missing agent apiKey/baseUrl fall back to config models.providers.
• Other provider fields are refreshed from config and normalized catalog data.