mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-04-30 01:41:43 +00:00
docs(soul): add comprehensive SOUL.md guide
Document the new global-only SOUL behavior, add a dedicated use guide, update personality/context/config docs, and fix docs language that still described cwd-local SOUL loading.
This commit is contained in:
parent
8d5563b3f6
commit
f8b30d1035
8 changed files with 493 additions and 177 deletions
|
|
@ -279,7 +279,9 @@ Users can also change this per-session with the `/verbose` command in chat.
|
|||
|
||||
### Set Up a Personality with SOUL.md
|
||||
|
||||
Customize how the bot communicates by creating `~/.hermes/SOUL.md`:
|
||||
Customize how the bot communicates by editing `~/.hermes/SOUL.md`:
|
||||
|
||||
For a full guide, see [Use SOUL.md with Hermes](/docs/guides/use-soul-with-hermes).
|
||||
|
||||
```markdown
|
||||
# Soul
|
||||
|
|
|
|||
|
|
@ -78,7 +78,9 @@ Create an `AGENTS.md` in your project root with architecture decisions, coding c
|
|||
|
||||
### SOUL.md: Customize Personality
|
||||
|
||||
Want the agent to be more concise? More technical? Place a `SOUL.md` in your project root or `~/.hermes/SOUL.md` for global personality customization. This shapes the agent's tone and communication style.
|
||||
Want Hermes to have a stable default voice? Edit `~/.hermes/SOUL.md` (or `$HERMES_HOME/SOUL.md` if you use a custom Hermes home). Hermes now seeds a starter SOUL automatically and uses that global file as the instance-wide personality source.
|
||||
|
||||
For a full walkthrough, see [Use SOUL.md with Hermes](/docs/guides/use-soul-with-hermes).
|
||||
|
||||
```markdown
|
||||
# Soul
|
||||
|
|
@ -87,6 +89,8 @@ Skip explanations unless asked. Prefer one-liners over verbose solutions.
|
|||
Always consider error handling and edge cases.
|
||||
```
|
||||
|
||||
Use `SOUL.md` for durable personality. Use `AGENTS.md` for project-specific instructions.
|
||||
|
||||
### .cursorrules Compatibility
|
||||
|
||||
Already have a `.cursorrules` or `.cursor/rules/*.mdc` file? Hermes reads those too. No need to duplicate your coding conventions — they're loaded automatically from the working directory.
|
||||
|
|
|
|||
264
website/docs/guides/use-soul-with-hermes.md
Normal file
264
website/docs/guides/use-soul-with-hermes.md
Normal file
|
|
@ -0,0 +1,264 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
title: "Use SOUL.md with Hermes"
|
||||
description: "How to use SOUL.md to shape Hermes Agent's default voice, what belongs there, and how it differs from AGENTS.md and /personality"
|
||||
---
|
||||
|
||||
# Use SOUL.md with Hermes
|
||||
|
||||
`SOUL.md` is the easiest way to give Hermes a stable, default voice.
|
||||
|
||||
If you want Hermes to feel like the same assistant every time you talk to it — without repeating instructions in every session — this is the file to use.
|
||||
|
||||
## What SOUL.md is for
|
||||
|
||||
Use `SOUL.md` for:
|
||||
- tone
|
||||
- personality
|
||||
- communication style
|
||||
- how direct or warm Hermes should be
|
||||
- what Hermes should avoid stylistically
|
||||
- how Hermes should relate to uncertainty, disagreement, and ambiguity
|
||||
|
||||
In short:
|
||||
- `SOUL.md` is about who Hermes is and how Hermes speaks
|
||||
|
||||
## What SOUL.md is not for
|
||||
|
||||
Do not use it for:
|
||||
- repo-specific coding conventions
|
||||
- file paths
|
||||
- commands
|
||||
- service ports
|
||||
- architecture notes
|
||||
- project workflow instructions
|
||||
|
||||
Those belong in `AGENTS.md`.
|
||||
|
||||
A good rule:
|
||||
- if it should apply everywhere, put it in `SOUL.md`
|
||||
- if it only belongs to one project, put it in `AGENTS.md`
|
||||
|
||||
## Where it lives
|
||||
|
||||
Hermes now uses only the global SOUL file for the current instance:
|
||||
|
||||
```text
|
||||
~/.hermes/SOUL.md
|
||||
```
|
||||
|
||||
If you run Hermes with a custom home directory, it becomes:
|
||||
|
||||
```text
|
||||
$HERMES_HOME/SOUL.md
|
||||
```
|
||||
|
||||
## First-run behavior
|
||||
|
||||
Hermes automatically seeds a starter `SOUL.md` for you if one does not already exist.
|
||||
|
||||
That means most users now begin with a real file they can read and edit immediately.
|
||||
|
||||
Important:
|
||||
- if you already have a `SOUL.md`, Hermes does not overwrite it
|
||||
- if the file exists but is empty, Hermes adds nothing from it to the prompt
|
||||
|
||||
## How Hermes uses it
|
||||
|
||||
When Hermes starts a session, it reads `SOUL.md` from `HERMES_HOME`, scans it for prompt-injection patterns, truncates it if needed, and injects the content directly into the prompt.
|
||||
|
||||
No wrapper language is added around the file.
|
||||
|
||||
So the content itself matters. Write the way you want Hermes to think and speak.
|
||||
|
||||
## A good first edit
|
||||
|
||||
If you do nothing else, open the file and change just a few lines so it feels like you.
|
||||
|
||||
For example:
|
||||
|
||||
```markdown
|
||||
You are direct, calm, and technically precise.
|
||||
Prefer substance over politeness theater.
|
||||
Push back clearly when an idea is weak.
|
||||
Keep answers compact unless deeper detail is useful.
|
||||
```
|
||||
|
||||
That alone can noticeably change how Hermes feels.
|
||||
|
||||
## Example styles
|
||||
|
||||
### 1. Pragmatic engineer
|
||||
|
||||
```markdown
|
||||
You are a pragmatic senior engineer.
|
||||
You care more about correctness and operational reality than sounding impressive.
|
||||
|
||||
## Style
|
||||
- Be direct
|
||||
- Be concise unless complexity requires depth
|
||||
- Say when something is a bad idea
|
||||
- Prefer practical tradeoffs over idealized abstractions
|
||||
|
||||
## Avoid
|
||||
- Sycophancy
|
||||
- Hype language
|
||||
- Overexplaining obvious things
|
||||
```
|
||||
|
||||
### 2. Research partner
|
||||
|
||||
```markdown
|
||||
You are a thoughtful research collaborator.
|
||||
You are curious, honest about uncertainty, and excited by unusual ideas.
|
||||
|
||||
## Style
|
||||
- Explore possibilities without pretending certainty
|
||||
- Distinguish speculation from evidence
|
||||
- Ask clarifying questions when the idea space is underspecified
|
||||
- Prefer conceptual depth over shallow completeness
|
||||
```
|
||||
|
||||
### 3. Teacher / explainer
|
||||
|
||||
```markdown
|
||||
You are a patient technical teacher.
|
||||
You care about understanding, not performance.
|
||||
|
||||
## Style
|
||||
- Explain clearly
|
||||
- Use examples when they help
|
||||
- Do not assume prior knowledge unless the user signals it
|
||||
- Build from intuition to details
|
||||
```
|
||||
|
||||
### 4. Tough reviewer
|
||||
|
||||
```markdown
|
||||
You are a rigorous reviewer.
|
||||
You are fair, but you do not soften important criticism.
|
||||
|
||||
## Style
|
||||
- Point out weak assumptions directly
|
||||
- Prioritize correctness over harmony
|
||||
- Be explicit about risks and tradeoffs
|
||||
- Prefer blunt clarity to vague diplomacy
|
||||
```
|
||||
|
||||
## What makes a strong SOUL.md?
|
||||
|
||||
A strong `SOUL.md` is:
|
||||
- stable
|
||||
- broadly applicable
|
||||
- specific in voice
|
||||
- not overloaded with temporary instructions
|
||||
|
||||
A weak `SOUL.md` is:
|
||||
- full of project details
|
||||
- contradictory
|
||||
- trying to micro-manage every response shape
|
||||
- mostly generic filler like "be helpful" and "be clear"
|
||||
|
||||
Hermes already tries to be helpful and clear. `SOUL.md` should add real personality and style, not restate obvious defaults.
|
||||
|
||||
## Suggested structure
|
||||
|
||||
You do not need headings, but they help.
|
||||
|
||||
A simple structure that works well:
|
||||
|
||||
```markdown
|
||||
# Identity
|
||||
Who Hermes is.
|
||||
|
||||
# Style
|
||||
How Hermes should sound.
|
||||
|
||||
# Avoid
|
||||
What Hermes should not do.
|
||||
|
||||
# Defaults
|
||||
How Hermes should behave when ambiguity appears.
|
||||
```
|
||||
|
||||
## SOUL.md vs /personality
|
||||
|
||||
These are complementary.
|
||||
|
||||
Use `SOUL.md` for your durable baseline.
|
||||
Use `/personality` for temporary mode switches.
|
||||
|
||||
Examples:
|
||||
- your default SOUL is pragmatic and direct
|
||||
- then for one session you use `/personality teacher`
|
||||
- later you switch back without changing your base voice file
|
||||
|
||||
## SOUL.md vs AGENTS.md
|
||||
|
||||
This is the most common mistake.
|
||||
|
||||
### Put this in SOUL.md
|
||||
- “Be direct.”
|
||||
- “Avoid hype language.”
|
||||
- “Prefer short answers unless depth helps.”
|
||||
- “Push back when the user is wrong.”
|
||||
|
||||
### Put this in AGENTS.md
|
||||
- “Use pytest, not unittest.”
|
||||
- “Frontend lives in `frontend/`.”
|
||||
- “Never edit migrations directly.”
|
||||
- “The API runs on port 8000.”
|
||||
|
||||
## How to edit it
|
||||
|
||||
```bash
|
||||
nano ~/.hermes/SOUL.md
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
vim ~/.hermes/SOUL.md
|
||||
```
|
||||
|
||||
Then restart Hermes or start a new session.
|
||||
|
||||
## A practical workflow
|
||||
|
||||
1. Start with the seeded default file
|
||||
2. Trim anything that does not feel like the voice you want
|
||||
3. Add 4–8 lines that clearly define tone and defaults
|
||||
4. Talk to Hermes for a while
|
||||
5. Adjust based on what still feels off
|
||||
|
||||
That iterative approach works better than trying to design the perfect personality in one shot.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### I edited SOUL.md but Hermes still sounds the same
|
||||
|
||||
Check:
|
||||
- you edited `~/.hermes/SOUL.md` or `$HERMES_HOME/SOUL.md`
|
||||
- not some repo-local `SOUL.md`
|
||||
- the file is not empty
|
||||
- your session was restarted after the edit
|
||||
- a `/personality` overlay is not dominating the result
|
||||
|
||||
### Hermes is ignoring parts of my SOUL.md
|
||||
|
||||
Possible causes:
|
||||
- higher-priority instructions are overriding it
|
||||
- the file includes conflicting guidance
|
||||
- the file is too long and got truncated
|
||||
- some of the text resembles prompt-injection content and may be blocked or altered by the scanner
|
||||
|
||||
### My SOUL.md became too project-specific
|
||||
|
||||
Move project instructions into `AGENTS.md` and keep `SOUL.md` focused on identity and style.
|
||||
|
||||
## Related docs
|
||||
|
||||
- [Personality & SOUL.md](/docs/user-guide/features/personality)
|
||||
- [Context Files](/docs/user-guide/features/context-files)
|
||||
- [Configuration](/docs/user-guide/configuration)
|
||||
- [Tips & Best Practices](/docs/guides/tips)
|
||||
Loading…
Add table
Add a link
Reference in a new issue