TUI attention docs are missing details & are wrong placed
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 75/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- json, typescript
- Domain
- cli, documentation
Research direction
The issue points to the documentation page at https://opencode.ai/v2/docs/cli/config#alerts and the schema links. Examine the repository's documentation source, likely in a docs/ directory, to find the incorrect config file reference. Also check the TUI config schema at https://opencode.ai/tui.json and the code in packages/tui/src/attention.ts to understand the allowed sound file types. The fix involves updating the documentation to reference tui.json instead of cli.json and adding details about supported audio formats.
Written by the indexing model from the issue text.
Description
Description
So the current docs (https://opencode.ai/v2/docs/cli/config#alerts) for alerts are showing wrong information because those never worked for me in a ~/.config/opencode/cli.json file (schema link).
It took me a few hours and help from frontier AI models to find out that there exists another config tui.json. I couldn't find any docs online about it except the schema link and this little section here without much further explanation there.
Proposed change
I would at least change the code snippets header label from cli.json to tui.json or create a whole subpage for TUI and move this there. There is also no information about the allowed file types (e.g. mp3, wav, etc.). I had to reverse engineer the code to find out that the default files are also mp3, see imports https://github.com/anomalyco/opencode/blob/dev/packages/tui/src/attention.ts#L17
Plugins
0
OpenCode version
1.18.32
Steps to reproduce
Prerequisite is that no
~/.config/opencode/tui.jsonexists or at least noattentionobject in the JSON file.
Procedure:
- Create
~/.config/opencode/cli.jsonfile - Paste the following from https://opencode.ai/v2/docs/cli/config#alerts:
{ "$schema": "https://opencode.ai/v2/cli.json", "attention": { "notifications": true, "sound": true, "volume": 0.4, "sound_pack": "opencode.default", "sounds": { "permission": "/home/me/sounds/permission.wav" } } } - Restart openclaude via shell
opencode - Send any prompt
- No sound is played at all
Screenshot and/or share link
No response
Operating System
Linux RHEL 10.2
Terminal
Intellij Terminal & RHEL default terminal named "Konsole"
- Dominant language
- TypeScript
- Stars
- 209k
- Forks
- 27.5k
- Avg merge
- 9h 42m
- Merged PRs (30d)
- 389
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from anomalyco/opencode
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
All issues in anomalyco/opencode
Similar issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Crush Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Open
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ElementsProject/cln-application#167 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Quantco/pnpm-licenses#17 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100