docs: clarify quick commands config shape

This commit is contained in:
helix4u 2026-04-28 11:59:01 -06:00 committed by kshitij
parent a1921c43cc
commit a3c27b5cd1
3 changed files with 25 additions and 9 deletions

View file

@ -98,16 +98,24 @@ Type `/` in the CLI to open the autocomplete menu. Built-in commands are case-in
### Quick Commands
User-defined quick commands map a short alias to a longer prompt. Configure them in `~/.hermes/config.yaml`:
User-defined quick commands map a short slash command to either a shell command or another slash command. Configure them in `~/.hermes/config.yaml`:
```yaml
quick_commands:
review: "Review my latest git diff and suggest improvements"
deploy: "Run the deployment script at scripts/deploy.sh and verify the output"
morning: "Check my calendar, unread emails, and summarize today's priorities"
status:
type: exec
command: systemctl status hermes-agent
deploy:
type: exec
command: scripts/deploy.sh
inbox:
type: alias
target: /gmail unread
```
Then type `/review`, `/deploy`, or `/morning` in the CLI. Quick commands are resolved at dispatch time and are not shown in the built-in autocomplete/help tables.
Then type `/status`, `/deploy`, or `/inbox` in the CLI or a messaging platform. Quick commands are resolved at dispatch time and may not appear in every built-in autocomplete/help table.
String-only prompt shortcuts are not supported as quick commands. Put longer reusable prompts in a skill, or use `type: alias` to point at an existing slash command.
### Alias Resolution