mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-01 01:51:44 +00:00
docs: clarify quick commands config shape
This commit is contained in:
parent
a1921c43cc
commit
a3c27b5cd1
3 changed files with 25 additions and 9 deletions
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -141,9 +141,12 @@ quick_commands:
|
|||
gpu:
|
||||
type: exec
|
||||
command: nvidia-smi --query-gpu=utilization.gpu,memory.used --format=csv,noheader
|
||||
restart:
|
||||
type: alias
|
||||
target: /gateway restart
|
||||
```
|
||||
|
||||
Then type `/status` or `/gpu` in any chat. See the [Configuration guide](/docs/user-guide/configuration#quick-commands) for more examples.
|
||||
Then type `/status`, `/gpu`, or `/restart` in any chat. See the [Configuration guide](/docs/user-guide/configuration#quick-commands) for more examples.
|
||||
|
||||
## Preloading Skills at Launch
|
||||
|
||||
|
|
|
|||
|
|
@ -1192,7 +1192,7 @@ whatsapp:
|
|||
|
||||
## Quick Commands
|
||||
|
||||
Define custom commands that run shell commands without invoking the LLM — zero token usage, instant execution. Especially useful from messaging platforms (Telegram, Discord, etc.) for quick server checks or utility scripts.
|
||||
Define custom commands that either run shell commands without invoking the LLM, or alias one slash command to another. Exec quick commands are zero-token and useful from messaging platforms (Telegram, Discord, etc.) for quick server checks or utility scripts.
|
||||
|
||||
```yaml
|
||||
quick_commands:
|
||||
|
|
@ -1208,16 +1208,21 @@ quick_commands:
|
|||
gpu:
|
||||
type: exec
|
||||
command: nvidia-smi --query-gpu=name,utilization.gpu,memory.used,memory.total --format=csv,noheader
|
||||
restart:
|
||||
type: alias
|
||||
target: /gateway restart
|
||||
```
|
||||
|
||||
Usage: type `/status`, `/disk`, `/update`, or `/gpu` in the CLI or any messaging platform. The command runs locally on the host and returns the output directly — no LLM call, no tokens consumed.
|
||||
Usage: type `/status`, `/disk`, `/update`, `/gpu`, or `/restart` in the CLI or any messaging platform. `exec` commands run locally on the host and return the output directly — no LLM call, no tokens consumed. `alias` commands rewrite to the configured slash command target.
|
||||
|
||||
- **30-second timeout** — long-running commands are killed with an error message
|
||||
- **Priority** — quick commands are checked before skill commands, so you can override skill names
|
||||
- **Autocomplete** — quick commands are resolved at dispatch time and are not shown in the built-in slash-command autocomplete tables
|
||||
- **Type** — only `exec` is supported (runs a shell command); other types show an error
|
||||
- **Type** — supported types are `exec` and `alias`; other types show an error
|
||||
- **Works everywhere** — CLI, Telegram, Discord, Slack, WhatsApp, Signal, Email, Home Assistant
|
||||
|
||||
String-only prompt shortcuts are not valid quick commands. For reusable prompt workflows, create a skill or alias to an existing slash command.
|
||||
|
||||
## Human Delay
|
||||
|
||||
Simulate human-like response pacing in messaging platforms:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue