RafaelRuiz
/
assistance-engine
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
assistance-engine/docs/developer.avapframework.com/TERMINAL_Shell_Integration.md

16 KiB
Raw Blame History

AVAP TM Dev Studio has the ability to integrate with common shells, allowing the terminal to understand more about what's actually happening inside the shell. This additional information enables some useful features such as{' '}

    working directory detection
   {' '}
  and command detection,{' '}
   decorations ,
  and  navigation .

Supported shells:

  • Linux/macOS: bash, fish, pwsh, zsh
  • Windows: pwsh

Installation

Automatic script injection

By default, the shell integration script should automatically activate on supported shells launched from AVAP TM Dev Studio. This is done by injecting arguments and/or environment variables when the shell session launches. This automatic injection can be disabled by setting{' '} terminal.integrated.shellIntegration.enabled to{' '} false .

This standard, easy way will not work for some advanced use cases like in sub-shells, through a regular ssh session (when not using the{' '} Remote - SSH extension ) or for some complex shell setups. The recommended way to enable shell integration for those is manual installation .

Manual installation

To manually install shell integration, the AVAP TM Dev Studio shell integration script needs to run during your shell's initialization. Where and how to do this depends on the shell and OS you're using. When using manual install it's recommended to set{' '} terminal.integrated.shellIntegration.enabled to false, though not mandatory.

bash

Add the following to your ~/.bashrc file. Run{' '} code ~/.bashrc in bash to open the file in AVAP TM {' '} Dev Studio.

[[ "$TERM\_PROGRAM" == "vscode" ]] && . "$(code
        --locate-shell-integration-path bash)"

fish

Add the following to your config.fish . Run{' '} code $\_\_fish\_config\_dir/config.fish in fish to open the file in AVAP TM Dev Studio.

string match -q "$TERM\_PROGRAM" "vscode"
        
        and . (code --locate-shell-integration-path fish)

pwsh

Add the following to your [PowerShell profile]. Run{' '} code $Profile in pwsh to open the file in AVAP TM {' '} Dev Studio.

if ($env:TERM\_PROGRAM -eq "vscode") { . "$(code
        --locate-shell-integration-path pwsh)" }

zsh

Add the following to your ~/.zshrc file. Run{' '} code ~/.zshrc in bash to open the file in AVAP TM {' '} Dev Studio.

[[ "$TERM\_PROGRAM" == "vscode" ]] && . "$(code
        --locate-shell-integration-path zsh)"

Git Bash

⚠️ This is currently experimental and automatic injection is not supported

Add the following to your ~/.bashrc file. Run code{' '} ~/.bashrc in Git Bash to open the file in AVAP TM {' '} Dev Studio.

[[ "$TERM\_PROGRAM" == "vscode" ]] && . "$(code
        --locate-shell-integration-path bash)"

The above shell integration installation is cross-platform and compatible with any installation type if code is in the $PATH . However, this recommended approach starts Node.js to fetch the script path, leading to a slight delay in shell startup. To mitigate this delay, inline the script above by resolving the path ahead of time and adding it directly into your init script.

\# Output the executable's path first:
        
        code --locate-shell-integration-path bash
        
        
        \# Add the result of the above to the source statement:
        
        [[ "$TERM\_PROGRAM" == "vscode" ]] && .
        "/path/to/shell/integration/script.sh"

Command decorations and the overview ruler

One of the things that shell integration enables is the ability to get the exit codes of the commands run within the terminal. Using this information, decorations are added to the left of the line to indicate whether the command succeeded or failed. These decorations also show up in the relatively new overview ruler in the scroll bar, just like in the editor.

The decorations can be interacted with to give some contextual actions like re-running the command:

The command and overview ruler decorations can be configured with the{' '} terminal.integrated.shellIntegration.decorationsEnabled {' '} setting.

Command navigation

The commands detected by shell integration feed into the command navigation feature ( Ctrl/Cmd+Up, Ctrl/Cmd+Down ) to give it more reliable command positions. This feature allows for quick navigation between commands and selection of their output. To select from the current position to the command, you can also hold down{' '} Shift , pressing Shift+Ctrl/Cmd+Up and{' '} Shift+Ctrl/Cmd+Down .

Sticky scroll

The sticky scroll feature will "stick" the command that is partially showing at the top of the terminal, making it much easier to see what command that output belongs to. Clicking on the sticky scroll component will scroll to the command's location in the terminal buffer.

This can be enabled with the{' '} terminal.integrated.stickyScroll.enabled setting.

Quick fixes

AVAP TM Dev Studio scans the output of a command and presents a Quick Fix with actions that have a high likelihood of being what the user will want to do next.

Here are some of the built-in Quick Fixes:

  • When it's detected that a port is already being listened to, suggest to kill the process and re-run the previous command.
  • When git push fails due to an upstream not being set, suggest to push with the upstream set.
  • When a git subcommand fails with a similar command error, suggest to use the similar command(s).
  • When git push results in a suggestion to create a GitHub PR, suggest to open the link.
  • When a General or cmd-not-found PowerShell feedback provider triggers, suggest each suggestion.

The Quick Fix feature also supports{' '} audio cues for additional feedback when a Quick Fix is available.

Run recent command

The Terminal: Run Recent Command command surfaces history from various sources in a Quick Pick, providing similar functionality to a shell's reverse search ( Ctrl+R ). The sources are the current session's history, previous session history for this shell type and the common shell history file.

Some other functionality of the command:

  • By default the search mode is "contiguous search", meaning the search term must exactly match. The button on the right of the search input allows switching to fuzzy search.
  • In the current session section, there is a clipboard icon in the right of the Quick Pick that will open the command output in an editor.
  • The pin action in the right of the Quick Pick can pin the command to the top of the list.
  • Alt can be held to write the text to the terminal without running it.
  • The amount of history stored in the previous session section is determined by the terminal.integrated.shellIntegration.history setting.

The default keybinding for this command is Ctrl+Alt+R . However, when accessibility mode is on these are reversed;{' '} Ctrl+R runs a recent command and Ctrl+Alt+R {' '} sends Ctrl+R to the shell.

The keybindings can be flipped when accessibility mode is off with the following keybindings:

{
        ` `"key": "ctrl+r",
        ` `"command": "workbench.action.terminal.runRecentCommand",
        ` `"when": "terminalFocus"
        
        },
        
        {
        ` `"key": "ctrl+alt+r",
        ` `"command": "workbench.action.terminal.sendSequence",
        ` `"args": { "text": "\u0012"/\*^R\*/ },
        ` `"when": "terminalFocus"
        
        }

Go to recent directory

Similar to the run recent command feature, the{' '} Terminal: Go to Recent Directory command keeps track of directories that have been visited and allows quick filtering and navigating ( cd ) to them. Alt can be held to write the text to the terminal without running it.

The default keybinding for this command is Ctrl+G as it behaves similar to the Go to Line/Column command in the editor. Ctrl+G can be send to the shell with Ctrl+Alt+G .

Current working directory detection

Shell integration tells AVAP TM Dev Studio what the current working directory of the shell is. This information is not possible to get on Windows without trying to detect the prompt through regex and requires polling on macOS and Linux, which isn't good for performance.

One of the biggest features this enables is enhanced resolving of links in the terminal. Take a link package.json for example, when the link is activated while shell integration is disabled this will open a search quick pick with package.json as the filter if there are multiple package.json files in the workspace. When shell integration is enabled however, it will open the package.json {' '} file in the current folder directly because the current location is known. This allows the output of ls for example to reliably open the correct file.

The current working directory is also used to show the directory in the terminal tab, in the run recent command quick pick and for the{' '} "terminal.integrated.splitCwd" :{' '} "inherited" feature.

Extended PowerShell keybindings

Windows' console API allows for more keybindings than Linux/macOS terminals, since AVAP TM Dev Studio's terminal emulates the latter even on Windows there are some PowerShell keybindings that aren't possible using the standard means due to lack of VT encoding such as Ctrl+Space . Shell integration allows AVAP TM Dev Studio to attach a custom keybindings to send a special sequence to PowerShell that then gets handled in the shell integration script and forwarded to the proper key handler.

The following keybindings should work in PowerShell when shell integration is enabled:

  • Ctrl+Space: Defaults to MenuComplete on Windows only
  • Alt+Space: Defaults to SetMark on all platforms
  • Shift+Enter: Defaults to AddLine on all platforms
  • Shift+End: Defaults to SelectLine on all platforms
  • Shift+Home: Defaults to SelectBackwardsLine on all platforms

Enhanced accessibility

The information that shell integration provides to AVAP TM Dev Studio is used to improve{' '}

    accessibility in the terminal
   
  . Some examples of enhancements are:
  • Navigation through detected commands in the accessible buffer (Alt+F2)
  • An audio cue plays when a command fails.
  • Underlying text box synchronizing such that using the arrow and backspace keys behave more correctly.

Supported escape sequences

AVAP TM Dev Studio supports several custom escape sequences:

AVAPTM Dev Studio custom sequences 'OSC 633 ; ... ST'

AVAP TM Dev Studio has a set of custom escape sequences designed to enable the shell integration feature when run in AVAP TM Dev Studio's terminal. These are used by the built-in scripts but can also be used by any application capable of sending sequences to the terminal, for example the{' '}

    Julia extension
   {' '}
  uses these to support shell integration in the Julia REPL.

These sequences should be ignored by other terminals, but unless other terminals end up adopting the sequences more widely, it's recommended to check that $TERM\_PROGRAM is vscode before writing them.

  • OSC 633 ; A ST - Mark prompt start.
  • OSC 633 ; B ST - Mark prompt end.
  • OSC 633 ; C ST - Mark pre-execution.
  • OSC 633 ; D [; <exitcode>] ST - Mark execution finished with an optional exit code.
  • OSC 633 ; E ; <commandline> ST - Explicitly set the command line. The E sequence allows the terminal to reliably get the exact command line interpreted by the shell. When this is not specified, the terminal may fallback to using the A, B and C sequences to get the command, or disable the detection all together if it's unreliable. The optional nonce can be used to verify the sequence came from the shell integration script to prevent command spoofing. When the nonce is verified successfully, some protections before using the commands will be removed for an improved user experience. The command line can escape ASCII characters using the{' '} \xAB format, where AB are the hexadecimal representation of the character code (case insensitive), and escape the \ character using . It's required to escape semi-colon ( 0x3b ) and characters 0x20 and below and this is particularly important for new line and semi-colon. Some examples: "" -> "" "\n" -> "\x0a" ";" -> "\x3b"
  • OSC 633 ; P ; <Property>=<Value> ST - Set a property on the terminal, only known properties will be handled. Known properties: Cwd - Reports the current working directory to the terminal. IsWindows - Indicates whether the terminal is using a Windows backend like winpty or conpty. This may be used to enable additional heuristics as the positioning of the shell integration sequences are not guaranteed to be correct. Valid values are True and False.
  • Cwd - Reports the current working directory to the terminal.
  • IsWindows - Indicates whether the terminal is using a Windows backend like winpty or conpty. This may be used to enable additional heuristics as the positioning of the shell integration sequences are not guaranteed to be correct. Valid values are True and False.

Final Term shell integration

AVAP TM Dev Studio supports Final Term's shell integration sequences, which allow non-AVAP TM Dev Studio shell integration scripts to work in AVAP TM Dev Studio. This results in a somewhat degraded experience as it doesn't support as many features as{' '} OSC 633 . Here are the specific sequences that are supported:

  • OSC 133 ; A ST - Mark prompt start.
  • OSC 133 ; B ST - Mark prompt end.
  • OSC 133 ; C ST - Mark pre-execution.
  • OSC 133 ; D [; <exitcode>] ST - Mark execution finished with an optional exit code.

SetMark 'OSC 1337 ; SetMark ST'

This sequence adds a mark to the left of the line it was triggered on and also adds an annotation to the scroll bar:

These marks integrate with command navigation to make them easy to navigate to via ctrl/cmd+up and ctrl/cmd+down by default.

Common questions

When does automatic injection not work?

There are several cases where automatic injection doesn't work, here are some common cases:

  • $PROMPT\_COMMAND is in an unsupported format, changing it to point to a single function is an easy way to work around this. For example: prompt() { printf "\033]0;%s@%s:%s\007" "${USER}" "${HOSTNAME%%.\*}" "${PWD/#$HOME/\~}" } PROMPT\_COMMAND=prompt
  • Some shell plugins may disable AVAP TM Dev Studio's shell integration explicitly by unsetting{' '} $VSCODE\_SHELL\_INTEGRATION when they initialize.

Why are command decorations showing when the feature is disabled?

The likely cause of this is that your system has shell integration for another terminal installed that{' '}

    AVAP TM  Dev Studio understands
   
  . If you don't want any decorations, you can hide them with the
  following setting:

"terminal.integrated.shellIntegration.decorationsEnabled": never

Alternatively, you could remove the shell integration script from your shell rc/startup script but you will lose access to command-aware features like command navigation .

Why does the command decoration jump around on Windows?

Windows uses an emulated pseudoterminal (pty) backend called ConPTY. It works a little differently to a regular pty because it needs to maintain compatibility with the Windows Console API. One of the impacts of this is the pty handles rendering specially in such a way that the shell integration sequences that identify the commands in the terminal buffer may be misplaced. When the command jumps around it's typically after a command has run, and AVAP TM Dev Studio's heuristics have kicked in to improve the position of the command decorations.