Back to Commands
Configurationhermes migrate

hermes migrate Command — Complete Reference & Examples

Complete reference for hermes migrate: diagnose and rewrite config.yaml to replace retired models or deprecated settings, keeping your configuration current.

July 27, 2026

Overview

hermes migrate scans your ~/.hermes/config.yaml for retired models, deprecated settings, and outdated configuration patterns. It reports what needs changing and can automatically rewrite your config to use current equivalents.

hermes migrate [provider]

Subcommands

Without arguments — Full scan

hermes migrate
# Scans entire config and reports all migration items

With provider — Targeted scan

hermes migrate openai
hermes migrate xai
# Only checks models and settings for the specified provider

What It Detects

Issue Action
Retired model Suggests the closest replacement
Deprecated setting Points to the new config key
Old auth format Offers to migrate to new credential format
Removed flags Flags that no longer exist in current version

Common Scenarios

Post-Upgrade Migration

hermes update
hermes migrate
# Check if the new version requires config changes
# Follow prompts to apply fixes automatically

Provider-Specific Cleanup

hermes migrate openai
# A provider deprecated models — check and fix just that provider

Preview-Only Mode

hermes migrate
# Review the report, decide which changes to apply
# You can reject individual suggestions

Migrating Between Major Versions

hermes update --backup    # Backup first
hermes migrate            # Check for breaking changes
hermes doctor             # Verify everything is healthy

Tips

  • Always run hermes migrate after a major version upgrade
  • The tool never modifies your config without confirmation
  • You can target a single provider if you know which one changed
  • Back up your config before migrating: hermes backup
  • Migration suggestions include links to changelog entries for context

Explore All Commands

Browse the full command reference with search and category filters.

Back to Commands