TerminalCommandSucceeded

Plays a signal - sound (audio cue) and/or announcement (alert) - when a terminal command succeeds (zero exit code) or when a command with such an exit code is navigated to in the accessible view.

{
  "accessibility.signals.terminalCommandSucceeded": {
    "sound": "auto",
    "announcement": "auto"
  } // default
}

Type

object

Default

{
  "sound": "auto",
  "announcement": "auto"
}

Object Properties

KeyTypeDefaultRangeDescription
"sound"string"auto""auto", "off", "on"Plays a sound when a terminal command succeeds (zero exit code) or when a command with such an exit code is navigated to in the accessible view.
"announcement"string"auto""auto", "off"Announces when a terminal command succeeds (zero exit code) or when a command with such an exit code is navigated to in the accessible view.

Description

Controls if sound and announcement signals are played when a command issued in the integrated terminal succeeds.

When "sound" is set to "auto", the sound signal will play when a command issued in the integrated terminal succeeds and a screen reader is detected or "editor.accessibilitySettings": "on". When set to "off", the sound signal will never play even when a screen reader is detected or "editor.accessibiltySupport": "on". When set to "on", the sound signal will always play even when a screen reader is not detected or "editor.accessibilitySupport": "off".

When "announcement" is set to "auto", the screen reader will make the announcement when a command issued in the integrated terminal succeeds and a screen reader is detected. When set to "off", the screen reader will never make the announcement even when a screen reader is detected.

BUGS

  1. Also plays signals when running a Task, overlapping with accessibility.signals.taskCompleted/Failed.
  2. Running commands in the integrated terminal will not play signals if using zsh, does work with bash. FIX put
if [[ "$TERM_PROGRAM" == "vscode" ]]; then
  . "$(code --locate-shell-integration-path zsh)"
fi

in your zshrc to get “shell integrations” (find link)

  1. I cannot get the signals to play while in Accessibility View.

GitHub Issue