Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

TUI attention docs are missing details & are wrong placed

Open Beginner friendly
#50,902 1 comment 0 reactions 0 assignees View on GitHub

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.json exists or at least no attention object in the JSON file.

Procedure:

  1. Create ~/.config/opencode/cli.json file
  2. 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"
        }
      }
    }
    
  3. Restart openclaude via shell opencode
  4. Send any prompt
  5. 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from anomalyco/opencode

All issues in anomalyco/opencode

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.