📄 reference/cli-commands.md

sidebar_position: 1 title: "CLI Commands Reference" description: "Authoritative reference for Hermes terminal commands and command families"

CLI Commands Reference

หน้านี้ครอบคลุม คำสั่งเทอร์มินัล ที่คุณรันจากเชลล์ของคุณ

สำหรับคำสั่งสแลช (slash commands) ในแชท ให้ดูที่ Slash Commands Reference

Global entrypoint

hermes [global-options] <command> [subcommand/options]

Global options

Top-level commands

hermes chat

hermes chat [options]

Common options:

Examples:

hermes
hermes chat -q "Summarize the latest PRs"
hermes chat --provider openrouter --model anthropic/claude-sonnet-4.6
hermes chat --toolsets web,terminal,skills
hermes chat --quiet -q "Return only JSON"
hermes chat --worktree -q "Review this repo and open a PR"
hermes chat --ignore-user-config --ignore-rules -q "Repro without my personal setup"

hermes model

ตัวเลือก provider + model แบบโต้ตอบ นี่คือคำสั่งสำหรับเพิ่ม provider ใหม่, การตั้งค่า API keys, และการรัน flow ของ OAuth ให้รันจากเทอร์มินัลของคุณ - ไม่ใช่จากภายในเซสชัน chat ของ Hermes ที่กำลังทำงานอยู่

hermes model

ใช้คำสั่งนี้เมื่อคุณต้องการ:

• เพิ่ม provider ใหม่ (OpenRouter, Anthropic, Copilot, DeepSeek, custom, ฯลฯ)
• เข้าสู่ระบบ provider ที่รองรับ OAuth (Anthropic, Copilot, Codex, Nous Portal)
• ป้อนหรืออัปเดต API keys
• เลือกจากรายการ model เฉพาะ provider
• กำหนดค่า endpoint แบบ custom/self-hosted
• บันทึกค่า default ใหม่ลงใน config

:::warning hermes model vs /model - รู้ความแตกต่าง hermes model (รันจากเทอร์มินัลของคุณ, นอกเหนือจากเซสชัน Hermes ใดๆ) คือ ตัวช่วยตั้งค่า provider แบบเต็มรูปแบบ มันสามารถเพิ่ม provider ใหม่, รัน flow ของ OAuth, แจ้งขอ API keys, และกำหนดค่า endpoints

/model (พิมพ์ภายในเซสชัน chat ของ Hermes ที่กำลังทำงานอยู่) สามารถ สลับระหว่าง provider และ model ที่คุณตั้งค่าไว้แล้วเท่านั้น มันไม่สามารถเพิ่ม provider ใหม่, รัน OAuth, หรือแจ้งขอ API keys ได้

หากคุณต้องการเพิ่ม provider ใหม่: ให้ออกจากเซสชัน Hermes ก่อน (Ctrl+C หรือ /quit) จากนั้นรัน hermes model จาก prompt ของเทอร์มินัลของคุณ :::

/model slash command (mid-session)

สลับระหว่าง model ที่ตั้งค่าไว้แล้วโดยไม่ต้องออกจากเซสชัน:

/model                              # แสดง model ปัจจุบันและตัวเลือกที่พร้อมใช้งาน
/model claude-sonnet-4              # สลับ model (auto-detects provider)
/model zai:glm-5                    # สลับ provider และ model
/model custom:qwen-2.5              # ใช้ model บน custom endpoint ของคุณ
/model custom                       # auto-detect model จาก custom endpoint
/model custom:local:qwen-2.5        # ใช้ custom provider ที่มีชื่อ
/model openrouter:anthropic/claude-sonnet-4  # สลับกลับไปใช้ cloud

โดยค่า default การเปลี่ยนแปลงด้วย /model จะมีผล เฉพาะเซสชันปัจจุบันเท่านั้น เพิ่ม --global เพื่อบันทึกการเปลี่ยนแปลงให้เป็นค่า default ใน config.yaml:

/model claude-sonnet-4 --global     # สลับและบันทึกเป็นค่า default ใหม่

:::info What if I only see OpenRouter models? หากคุณตั้งค่าเฉพาะ OpenRouter, /model จะแสดงเฉพาะ model ของ OpenRouter เท่านั้น หากต้องการเพิ่ม provider อื่น (Anthropic, DeepSeek, Copilot, ฯลฯ), ให้ออกจากเซสชันของคุณและรัน hermes model จากเทอร์มินัล :::

การเปลี่ยนแปลง Provider และ base URL จะถูกบันทึกไปยัง config.yaml โดยอัตโนมัติ เมื่อสลับออกจาก custom endpoint, base URL เก่าจะถูกล้างเพื่อป้องกันการรั่วไหลไปยัง provider อื่น

hermes gateway

hermes gateway <subcommand>

Subcommands:

:::tip WSL users ให้ใช้ hermes gateway run แทน hermes gateway start - การรองรับ systemd ของ WSL ไม่น่าเชื่อถือ ห่อด้วย tmux เพื่อความคงอยู่: tmux new -s hermes 'hermes gateway run' ดู WSL FAQ สำหรับรายละเอียด :::

hermes setup

hermes setup [model|tts|terminal|gateway|tools|agent] [--non-interactive] [--reset]

ใช้ตัวช่วยตั้งค่าแบบเต็มรูปแบบ หรือกระโดดไปยังส่วนใดส่วนหนึ่ง:

Options:

hermes whatsapp

hermes whatsapp

รัน flow การจับคู่/ตั้งค่า WhatsApp รวมถึงการเลือกโหมดและการจับคู่ด้วย QR-code

hermes login / hermes logout (Deprecated)

:::caution hermes login ถูกลบออกแล้ว ให้ใช้ hermes auth เพื่อจัดการ credentials ของ OAuth, hermes model เพื่อเลือก provider, หรือ hermes setup สำหรับการตั้งค่าแบบโต้ตอบทั้งหมด :::

hermes auth

จัดการ pool ของ credentials สำหรับการหมุนเวียน key ของ provider เดียวกัน ดู Credential Pools สำหรับเอกสารฉบับเต็ม

hermes auth                                              # ตัวช่วยตั้งค่าแบบโต้ตอบ
hermes auth list                                         # แสดง pool ทั้งหมด
hermes auth list openrouter                              # แสดง provider เฉพาะ
hermes auth add openrouter --api-key sk-or-v1-xxx        # เพิ่ม API key
hermes auth add anthropic --type oauth                   # เพิ่ม credential แบบ OAuth
hermes auth remove openrouter 2                          # ลบตาม index
hermes auth reset openrouter                             # ล้าง cooldowns

Subcommands: add, list, remove, reset เมื่อเรียกโดยไม่มี subcommand จะเปิดตัวตัวช่วยตั้งค่าการจัดการแบบโต้ตอบ

hermes status

hermes status [--all] [--deep]

hermes cron

hermes cron <list|create|edit|pause|resume|run|remove|status|tick>

hermes webhook

hermes webhook <subscribe|list|remove|test>

จัดการการสมัครรับ webhook แบบไดนามิกสำหรับการเปิดใช้งาน agent ที่ขับเคลื่อนด้วยเหตุการณ์ ต้องเปิดใช้งาน webhook platform ใน config - หากไม่ได้ตั้งค่า จะแสดงคำแนะนำการตั้งค่า

hermes webhook subscribe

hermes webhook subscribe <name> [options]

Subscriptions จะคงอยู่บน ~/.hermes/webhook_subscriptions.json และถูกโหลดใหม่ (hot-reloaded) โดย webhook adapter โดยไม่ต้องรีสตาร์ท gateway

hermes doctor

hermes doctor [--fix]

hermes dump

hermes dump [--show-keys]

แสดงสรุปแบบ plain-text ที่กระชับของการตั้งค่า Hermes ทั้งหมดของคุณ ออกแบบมาเพื่อคัดลอก-วางลงใน Discord, GitHub issues, หรือ Telegram เมื่อขอความช่วยเหลือ - ไม่มีสี ANSI, ไม่มีรูปแบบพิเศษ มีเพียงข้อมูลเท่านั้น

What it includes

Example output

--- hermes dump ---
version:          0.8.0 (2026.4.8) [af4abd2f]
os:               Linux 6.14.0-37-generic x86_64
python:           3.11.14
openai_sdk:       2.24.0
profile:          default
hermes_home:      ~/.hermes
model:            anthropic/claude-opus-4.6
provider:         openrouter
terminal:         local

api_keys:
  openrouter           set
  openai               not set
  anthropic            set
  nous                 not set
  firecrawl            set
  ...

features:
  toolsets:           all
  mcp_servers:        0
  memory_provider:    built-in
  gateway:            running (systemd)
  platforms:          telegram, discord
  cron_jobs:          3 active / 5 total
  skills:             42

config_overrides:
  agent.max_turns: 250
  compression.threshold: 0.85
  display.streaming: True
--- end dump ---

When to use

• การรายงาน bug บน GitHub - วาง dump ลงใน issue ของคุณ
• การขอความช่วยเหลือใน Discord - แชร์ใน code block
• การเปรียบเทียบการตั้งค่าของคุณกับคนอื่น
• การตรวจสอบเบื้องต้นอย่างรวดเร็วเมื่อมีบางอย่างไม่ทำงาน

:::tip hermes dump ออกแบบมาโดยเฉพาะสำหรับการแชร์ สำหรับการวินิจฉัยแบบโต้ตอบ ให้ใช้ hermes doctor สำหรับภาพรวมด้วยสายตา ให้ใช้ hermes status :::

hermes debug

hermes debug share [options]

อัปโหลดรายงาน debug (ข้อมูลระบบ + log ล่าสุด) ไปยังบริการ paste และรับ URL ที่สามารถแชร์ได้ มีประโยชน์สำหรับการร้องขอการสนับสนุนอย่างรวดเร็ว - รวมถึงทุกสิ่งที่ผู้ช่วยเหลือต้องการเพื่อวินิจฉัยปัญหาของคุณ

รายงานนี้รวมข้อมูลระบบ (OS, Python version, Hermes version), log ของ agent และ gateway ล่าสุด (จำกัด 512 KB ต่อไฟล์), และสถานะ API key ที่ถูก redact แล้ว Keys จะถูก redact เสมอ - จะไม่มีการอัปโหลด secret ใดๆ

บริการ paste ที่ลองตามลำดับ: paste.rs, dpaste.com.

Examples

hermes debug share              # อัปโหลดรายงาน debug, พิมพ์ URL
hermes debug share --lines 500  # รวม log lines เพิ่มขึ้น
hermes debug share --expire 30  # เก็บ paste ไว้ 30 วัน
hermes debug share --local      # พิมพ์รายงานไปยัง terminal (ไม่ทำการอัปโหลด)

hermes backup

hermes backup [options]

สร้าง zip archive ของการตั้งค่า (configuration), skills, sessions, และข้อมูลของ Hermes การสำรองข้อมูลนี้ไม่รวม codebase ของ hermes-agent เอง

การสำรองข้อมูลใช้ API backup() ของ SQLite เพื่อการคัดลอกที่ปลอดภัย ดังนั้นจึงทำงานได้อย่างถูกต้องแม้ว่า Hermes จะกำลังทำงานอยู่ (WAL-mode safe).

Examples

hermes backup                           # Full backup ไปที่ ~/hermes-backup-*.zip
hermes backup -o /tmp/hermes.zip        # Full backup ไปที่พาธที่ระบุ
hermes backup --quick                   # Quick state-only snapshot
hermes backup --quick --label "pre-upgrade"  # Quick snapshot พร้อม label

hermes import

hermes import <zipfile> [options]

กู้คืน Hermes backup ที่สร้างไว้ก่อนหน้านี้ไปยัง home directory ของ Hermes.

hermes logs

hermes logs [log_name] [options]

ดู, tail, และกรองไฟล์ log ของ Hermes. log ทั้งหมดถูกจัดเก็บไว้ใน ~/.hermes/logs/ (หรือ <profile>/logs/ สำหรับ profile ที่ไม่ใช่ค่าเริ่มต้น).

Log files

Options

Examples

# ดู 50 บรรทัดสุดท้ายของ agent.log (default)
hermes logs

# ติดตาม agent.log แบบ real time
hermes logs -f

# ดู 100 บรรทัดสุดท้ายของ gateway.log
hermes logs gateway -n 100

# แสดงเฉพาะ warnings และ errors จากชั่วโมงที่ผ่านมา
hermes logs --level WARNING --since 1h

# กรองตาม session เฉพาะ
hermes logs --session abc123

# ติดตาม errors.log โดยเริ่มจาก 30 นาทีที่แล้ว
hermes logs errors --since 30m -f

# แสดงไฟล์ log ทั้งหมดพร้อมขนาด
hermes logs list

Filtering

สามารถรวม filters ได้ เมื่อมี filters หลายตัวทำงานอยู่ บรรทัด log จะต้องผ่าน ทั้งหมด จึงจะแสดง:

# บรรทัด WARNING+ จาก 2 ชั่วโมงที่แล้ว ที่มี session "tg-12345"
hermes logs --level WARNING --since 2h --session tg-12345

บรรทัดที่ไม่มี timestamp ที่ parse ได้จะถูกรวมเมื่อ --since ทำงานอยู่ (อาจเป็นบรรทัดต่อเนื่องจากรายการ log หลายบรรทัด). บรรทัดที่ไม่มี level ที่ตรวจจับได้จะถูกรวมเมื่อ --level ทำงานอยู่.

Log rotation

Hermes ใช้ RotatingFileHandler ของ Python log เก่าจะถูกหมุนเวียนโดยอัตโนมัติ - ให้มองหา agent.log.1, agent.log.2, เป็นต้น คำสั่งย่อย hermes logs list จะแสดงไฟล์ log ทั้งหมดรวมถึงไฟล์ที่ถูกหมุนเวียนแล้ว.

hermes config

hermes config <subcommand>

Subcommands:

hermes pairing

hermes pairing <list|approve|revoke|clear-pending>

hermes skills

hermes skills <subcommand>

Subcommands:

Common examples:

hermes skills browse
hermes skills browse --source official
hermes skills search react --source skills-sh
hermes skills search https://mintlify.com/docs --source well-known
hermes skills inspect official/security/1password
hermes skills inspect skills-sh/vercel-labs/json-render/json-render-react
hermes skills install official/migration/openclaw-migration
hermes skills install skills-sh/anthropics/skills/pdf --force
hermes skills check
hermes skills update
hermes skills config

Notes:

• --force สามารถเขียนทับ policy blocks ที่ไม่เป็นอันตรายสำหรับ third-party/community skills.
• --force ไม่ได้เขียนทับผลการตรวจสอบ dangerous scan.
• --source skills-sh ค้นหา directory skills.sh สาธารณะ.
• --source well-known อนุญาตให้คุณชี้ Hermes ไปยังเว็บไซต์ที่เปิดเผย /.well-known/skills/index.json.

hermes honcho

hermes honcho [--target-profile NAME] <subcommand>

จัดการการรวม memory ข้าม session ของ Honcho คำสั่งนี้จัดทำโดย Honcho memory provider plugin และใช้งานได้เมื่อ memory.provider ถูกตั้งค่าเป็น honcho ใน config ของคุณเท่านั้น.

flag --target-profile ช่วยให้คุณจัดการ Honcho config ของ profile อื่นได้โดยไม่ต้องสลับไปที่ profile นั้น.

Subcommands:

hermes memory

hermes memory <subcommand>

ตั้งค่าและจัดการ plugins ของ external memory provider ที่พร้อมใช้งาน: honcho, openviking, mem0, hindsight, holographic, retaindb, byterover, supermemory. สามารถมี external provider ที่ใช้งานได้เพียงตัวเดียวในเวลาใดเวลาหนึ่ง. Built-in memory (MEMORY.md/USER.md) จะทำงานอยู่เสมอ.

Subcommands:

hermes acp

hermes acp

เริ่ม Hermes เป็น stdio server ของ ACP (Agent Client Protocol) สำหรับการรวมเข้ากับ editor.

Related entrypoints:

hermes-acp
python -m acp_adapter

ติดตั้ง support ก่อน:

pip install -e '.[acp]'

ดู ACP Editor Integration และ ACP Internals.

hermes mcp

hermes mcp <subcommand>

จัดการการตั้งค่า server ของ MCP (Model Context Protocol) และรัน Hermes เป็น MCP server.

ดู MCP Config Reference, Use MCP with Hermes, และ MCP Server Mode.

hermes plugins

hermes plugins [subcommand]

การจัดการ plugin แบบรวมศูนย์ - general plugins, memory providers, และ context engines ในที่เดียว การรัน hermes plugins โดยไม่มี subcommand จะเปิดหน้าจอ interactive แบบ composite ที่มีสองส่วน:

• General Plugins - checkboxes แบบ multi-select เพื่อเปิด/ปิด plugins ที่ติดตั้ง
• Provider Plugins - การตั้งค่าแบบ single-select สำหรับ Memory Provider และ Context Engine. กด ENTER บน category เพื่อเปิด radio picker.

Provider plugin selections ถูกบันทึกใน config.yaml:

• memory.provider - memory provider ที่ใช้งานอยู่ (ว่างเปล่า = built-in only)
• context.engine - context engine ที่ใช้งานอยู่ ("compressor" = built-in default)

General plugin disabled list ถูกเก็บไว้ใน config.yaml ภายใต้ plugins.disabled.

ดู Plugins และ Build a Hermes Plugin.

hermes tools

hermes tools [--summary]

หากไม่ใช้ --summary จะเปิด UI สำหรับการตั้งค่า tool แบบ interactive ต่อ platform.

hermes sessions

hermes sessions <subcommand>

Subcommands:

hermes insights

hermes insights [--days N] [--source platform]

hermes claw

hermes claw migrate [options]

ย้าย OpenClaw setup ของคุณมายัง Hermes อ่านจาก ~/.openclaw (หรือพาธที่กำหนดเอง) และเขียนไปยัง ~/.hermes ตรวจจับชื่อ directory เก่า (legacy) (~/.clawdbot, ~/.moltbot) และชื่อไฟล์ config (clawdbot.json, moltbot.json) โดยอัตโนมัติ.

What gets migrated

การย้ายครอบคลุม 30+ categories ทั่ว persona, memory, skills, model providers, messaging platforms, agent behavior, session policies, MCP servers, TTS, และอื่นๆ รายการเหล่านี้จะถูก นำเข้าโดยตรง เป็นเทียบเท่าของ Hermes หรือ เก็บถาวร เพื่อการตรวจสอบด้วยตนเอง.

Directly imported: SOUL.md, MEMORY.md, USER.md, AGENTS.md, skills (4 source directories), default model, custom providers, MCP servers, messaging platform tokens and allowlists (Telegram, Discord, Slack, WhatsApp, Signal, Matrix, Mattermost), agent defaults (reasoning effort, compression, human delay, timezone, sandbox), session reset policies, approval rules, TTS config, browser settings, tool settings, exec timeout, command allowlist, gateway config, และ API keys จาก 3 sources.

Archived for manual review: Cron jobs, plugins, hooks/webhooks, memory backend (QMD), skills registry config, UI/identity, logging, multi-agent setup, channel bindings, IDENTITY.md, TOOLS.md, HEARTBEAT.md, BOOTSTRAP.md.

API key resolution ตรวจสอบ 3 sources ตามลำดับความสำคัญ: config values → ~/.openclaw/.env → auth-profiles.json. ทุก field ของ token จัดการกับ plain strings, env templates (${VAR}), และ SecretRef objects.

สำหรับแผนที่ config key ที่สมบูรณ์, รายละเอียดการจัดการ SecretRef, และ checklist หลังการย้าย, ดูที่ full migration guide.

Examples

# ดูตัวอย่างว่าจะมีการย้ายอะไร
hermes claw migrate --dry-run

# Full migration รวมถึง API keys
hermes claw migrate --preset full

# ย้ายเฉพาะ user data (ไม่มี secrets), overwrite conflicts
hermes claw migrate --preset user-data --overwrite

# ย้ายจาก OpenClaw path ที่กำหนดเอง
hermes claw migrate --source /home/user/old-openclaw

hermes dashboard

hermes dashboard [options]

การเปิดใช้งาน web dashboard - UI ที่ทำงานบนเบราว์เซอร์สำหรับจัดการ configuration, API keys, และ monitoring sessions จำเป็นต้องติดตั้ง pip install hermes-agent[web] (FastAPI + Uvicorn) ดูเอกสารฉบับเต็มได้ที่ Web Dashboard

# Default - เปิดเบราว์เซอร์ไปยัง http://127.0.0.1:9119
hermes dashboard

# กำหนด port เอง, ไม่เปิดเบราว์เซอร์
hermes dashboard --port 8080 --no-open

hermes profile

hermes profile <subcommand>

จัดการ profiles - คือ instance ของ Hermes ที่แยกออกจากกันหลายตัว โดยแต่ละตัวจะมี config, sessions, skills, และ home directory เป็นของตัวเอง

Examples:

hermes profile list
hermes profile create work --clone
hermes profile use work
hermes profile alias work --name h-work
hermes profile export work -o work-backup.tar.gz
hermes profile import work-backup.tar.gz --name restored
hermes -p work chat -q "Hello from work profile"

hermes completion

hermes completion [bash|zsh]

พิมพ์ shell completion script ไปยัง stdout จากนั้น Source output นั้นใน shell profile ของคุณเพื่อใช้ tab-completion สำหรับคำสั่ง Hermes, subcommands, และ profile names

Examples:

# Bash
hermes completion bash >> ~/.bashrc

# Zsh
hermes completion zsh >> ~/.zshrc

Maintenance commands

ดูเพิ่มเติม

• Slash Commands Reference
• CLI Interface
• Sessions
• Skills System
• Skins & Themes