Skip to content

alrcatraz/hermes-agent-tutorial

Repository files navigation

version 2.0.0

Hermes Agent Complete Tutorial

License GitHub stars GitHub last commit Sponsor

Like this tutorial? Sponsor me on GitHub — every bit supports more open-source documentation and tools. ❤️

From scratch installation · Quick start · Advanced configuration
CC BY-SA 4.0 (text) · MIT (code examples) © 2026 alrcatraz


Hermes Agent is an open-source AI agent framework developed by Nous Research.

This tutorial takes you from zero to production. Available as both a web site and a PDF:

  • Volume I — Basics (Chapters 1–6) — Installation, initial configuration, Gateway setup, work principles
  • Volume II — Intermediate (Chapters 7–12) — Multi-model collaboration, external memory, SearXNG, MarkItDown, Agent customisation
  • Volume III — Advanced (Chapters 13–20) — Knowledge base, Skills, credential management, SRE, browser automation, Office tools
  • Appendix — Concepts reference, toolchain comparison, full config example, FAQ

It is the companion tutorial of the Astra ecosystem.

Project Structure

hermes-agent-tutorial/
├── src/                           ← Markdown source files
│   ├── index.md                   ← Site home page
│   ├── introduction.md            ← Standalone introduction
│   ├── volume-1/                  ← 6 chapters
│   ├── volume-2/                  ← 6 chapters
│   ├── volume-3/                  ← 8 chapters
│   ├── appendix/                  ← 4 appendix sections
│   └── diagrams/                  ← Pre-rendered SVG diagrams
├── styles/
│   └── astra-doc-style.sty        ← LaTeX styles (PDF)
├── filters/
│   ├── admonitions.lua            ← Admonition blocks
│   ├── inline-code-bg.lua         ← Inline code grey background
│   └── diagram-path.lua           ← SVG path resolution
├── .github/
│   ├── FUNDING.yml                ← GitHub Sponsors
│   └── workflows/
│       └── deploy.yml             ← Auto-deploy to GitHub Pages
├── mkdocs.yml                     ← MkDocs configuration
├── Makefile                       ← Build both web & PDF
├── LICENSE                        ← Dual license
└── README.md

Building

Web site

# Serve locally (http://127.0.0.1:8000)
uvx --with mkdocs-material mkdocs serve

# Build to site/ directory
uvx --with mkdocs-material mkdocs build

The GitHub Actions workflow in .github/workflows/deploy.yml automatically builds and deploys to GitHub Pages on every push to main.

PDF

make pdf
# or manually:
pandoc \
  src/introduction.md \
  src/volume-1/*.md \
  src/volume-2/*.md \
  src/volume-3/*.md \
  src/appendix/*.md \
  --pdf-engine=lualatex \
  --listings \
  --lua-filter=filters/admonitions.lua \
  --lua-filter=filters/inline-code-bg.lua \
  --lua-filter=filters/diagram-path.lua \
  --highlight-style=tango \
  -V colorlinks=true \
  -V geometry:margin=1in \
  -H styles/astra-doc-style.sty \
  -o build/hermes-agent-tutorial.pdf

Related

License

Text content: CC BY-SA 4.0 — share and adapt with attribution and share-alike.
Code examples: MIT — free to use in any project, no strings attached.

Star History Chart

CC BY-SA 4.0 (text) · MIT (code examples) © 2026 alcatraz

About

My tutorial on deploying, configuring and using Hermes Agent

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors