docs: add HEARTBEAT.md integration section to README
Explains how AI agents should add Argus to their heartbeat for periodic community awareness checks.
This commit is contained in:
parent
7bb19ef3fb
commit
8391300811
1 changed files with 23 additions and 3 deletions
26
README.md
26
README.md
|
|
@ -21,8 +21,9 @@ Named after **Argus Panoptes**, the all-seeing giant of Greek mythology.
|
||||||
# Initialize database
|
# Initialize database
|
||||||
argus init
|
argus init
|
||||||
|
|
||||||
# Set up GitHub token
|
# Set up authentication (choose one)
|
||||||
export GH_TOKEN=your_github_token
|
gh auth login # GitHub
|
||||||
|
export ARGUS_BACKEND=tea # Forgejo (needs tea token with read:notification)
|
||||||
|
|
||||||
# Pull notifications
|
# Pull notifications
|
||||||
argus notif pull
|
argus notif pull
|
||||||
|
|
@ -31,9 +32,28 @@ argus notif pull
|
||||||
argus status
|
argus status
|
||||||
|
|
||||||
# Start dashboard
|
# Start dashboard
|
||||||
systemctl start argus
|
systemctl enable --now argus
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Agent Integration
|
||||||
|
|
||||||
|
For AI agents using OpenClaw, add this to your `HEARTBEAT.md` for periodic community awareness:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
### Argus Community Awareness (Daily)
|
||||||
|
1. **Check status**: `argus status`
|
||||||
|
2. **Pull notifications**: `argus notif pull`
|
||||||
|
3. **Review pending**: `argus notif list --pending --limit 5`
|
||||||
|
4. **Triage**: For each pending notification:
|
||||||
|
- If actionable: `argus notif act <id> <action> "<detail>"`
|
||||||
|
- If not relevant: `argus notif dismiss <id> "<reason>"`
|
||||||
|
5. **Audit stale**: `argus notif audit --stale-hours 48`
|
||||||
|
6. **Log activity**: Record significant actions with `argus activity log`
|
||||||
|
7. **Check escalations**: `argus escalate list --status open`
|
||||||
|
```
|
||||||
|
|
||||||
|
The install script outputs this block — just copy it to your HEARTBEAT.md.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### Core
|
### Core
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue