alan/attention-required
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move configuration reference out of AGENTS.md

Browse Source
This commit is contained in:
Alan
2026-09-08 19:09:16 +01:00
parent 26f8c8cb9f
commit 9482fdac10
3 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -5
View File
@@ -98,13 +98,11 @@ The sliders go far: a nudge can be a tremor or an earthquake, a banner can
stay for five minutes. `attention-required effects` prints every option and stay for five minutes. `attention-required effects` prints every option and
range as JSON. range as JSON.
## For agents and scripts ## Reference
[AGENTS.md](AGENTS.md) is the complete, exact reference: the file schema, every [REFERENCE.md](REFERENCE.md) is the complete reference: the file schema, every
effect option with its range, the CLI, how to verify, and worked scenarios. effect option with its range, the CLI, how to verify, and worked scenarios.
Point your coding agent at it (`attention-required docs` prints it) and ask `attention-required docs` prints it.
for "a red flash and a chime when the build fails" or "meeting mode: only my
boss on Slack gets through".
## Command line ## Command line
AGENTS.md → REFERENCE.md
+1 -1
View File
@@ -1,4 +1,4 @@
# Attention Required: guide for agents # Attention Required: configuration reference
This file is for an AI agent (or a script) asked to change how this machine This file is for an AI agent (or a script) asked to change how this machine
reacts to notifications, for example "shake the screen and play a sound when reacts to notifications, for example "shake the screen and play a sound when
bin/attention-required
+2 -2
View File
@@ -13,7 +13,7 @@
# attention-required remove NAME # attention-required remove NAME
# attention-required enable NAME | disable NAME # attention-required enable NAME | disable NAME
# attention-required effects the effect catalog with every option and range, as JSON # attention-required effects the effect catalog with every option and range, as JSON
# attention-required docs print the guide for scripts and agents (AGENTS.md) # attention-required docs print the configuration reference
# attention-required test EFFECT run one effect now, e.g. `test nudge` # attention-required test EFFECT run one effect now, e.g. `test nudge`
# or `test '{"type":"flash","color":"urgent"}'` # or `test '{"type":"flash","color":"urgent"}'`
# attention-required simulate APP SUMMARY [BODY] run a made-up notification past the rules # attention-required simulate APP SUMMARY [BODY] run a made-up notification past the rules
@@ -149,7 +149,7 @@ case ${1:-help} in
patch) shift; cmd_patch "$@" ;; patch) shift; cmd_patch "$@" ;;
remove|rm) shift; cmd_remove "$@" ;; remove|rm) shift; cmd_remove "$@" ;;
effects) ipc effects | jq . ;; effects) ipc effects | jq . ;;
docs) cat "$here/AGENTS.md" ;; docs) cat "$here/REFERENCE.md" ;;
enable) shift; cmd_toggle true "$@" ;; enable) shift; cmd_toggle true "$@" ;;
disable) shift; cmd_toggle false "$@" ;; disable) shift; cmd_toggle false "$@" ;;
test) [[ -n ${2:-} ]] || die "usage: test EFFECT"; ipc test "$2" ;; test) [[ -n ${2:-} ]] || die "usage: test EFFECT"; ipc test "$2" ;;