Quickstart

First 10 minutes after installation: verify setup, run key commands, and choose your usage path.

Quickstart begins right after installation. It helps you run the first commands, decide between CLI and gateway, and move to the right next guide.

Time to complete

~10 minutes

Commands

hermes

Start Hermes and confirm your local runtime path is working.

hermes setup

Complete setup prompts required for regular usage.

hermes doctor

Diagnose setup and environment issues before moving deeper.

Success checkpoint

You should see `hermes` run normally and `hermes doctor` report no blocking issues.

If this works, you are ready to continue to CLI or gateway.

Troubleshooting hint

If commands fail, re-run `hermes doctor`, verify shell environment and setup prompts, then compare with official docs.

Steps

  1. 1. Run `hermes` to verify your first successful startup.

  2. 2. Run `hermes setup` if you have not completed initialization prompts.

  3. 3. Run `hermes doctor` to confirm your environment is healthy.

  4. 4. Choose CLI for direct local usage, or gateway for messaging-platform usage.

  5. 5. Continue to Skills, Memory, or MCP after your primary usage path is stable.

Prerequisites

  • Installation is complete using the official install path.
  • `hermes setup` has been executed successfully.
  • `hermes doctor` reports no blocking issues.

Notes

  • Choose CLI when your primary usage is local and terminal-first.
  • Choose gateway when your primary usage is messaging-platform-driven.
  • Keep this stage focused on stability, then expand to Skills, Memory, and MCP.

Next step

Related Guides

Skills

Extend Hermes behavior through reusable skills.

Open Skills

Memory

Add persistent context for longer workflows.

Open Memory

MCP

Connect external tools and integrations safely.

Open MCP