byobu-enable-shell-integration(1)

πŸ“¦ version 7.20, in ubuntu stonking

πŸ’– byobu-enable-shell-integration(1) πŸ’–

okay bestie, so this is the byobu manual page for byobu-enable-shell-integration β€” yes it's a mouthful, yes it's iconic, and yes it's about to make your shell 10x more clickable ✨


🌸 NAME 🌸

byobu-enable-shell-integration, byobu-disable-shell-integration β€” the twin utilities that add and remove OSC 133 semantic-prompt markers and OSC 8 hyperlink support in your shell configuration πŸŽ€


✨ SYNOPSIS ✨

byobu-enable-shell-integration

byobu-disable-shell-integration

like. that's it. two commands. no flags. no drama. we love a minimal serve πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the tea, bestie: Byobu can emit OSC 133 semantic-prompt markers β€” and these are escape sequences that legit mark:

  • where a prompt starts πŸ‘‘
  • where a prompt ends and command input begins
  • where a command's output starts
  • where a command finishes (with its exit code, periodt)

This is literally the same protocol that iTerm2, Kitty, Ghostty, VS Code, and Warp already use for jump-to-previous-prompt navigation and command-output selection. Any terminal or tool that understands OSC 133 can locate prompts and command boundaries precisely instead of guessing from rendered text. no more vibes-based guessing, we're doing facts-based guessing now πŸ™ˆ

This same toggle also aliases ls to pass --hyperlink=auto, so file names it prints become OSC 8 hyperlinks β€” which Trustmux's own PWA, and any other OSC-8-aware terminal, render as clickable. It's bundled into this one on/off switch for now rather than being a separate opt-in. iykyk.

🫢 small caveat tho: the alias is skipped if ls is already aliased (your own alias is left alone, we would never), or if the installed ls doesn't understand --hyperlink (that's GNU coreutils 9.4 or later; not BSD/macOS ls, and not older coreutils). πŸ’€

This is off by default. byobu-enable-shell-integration adds one line to ~/.bashrc (for bash) or ~/.zshrc (for zsh), sourcing the marker-emitting and hyperlink-alias logic. And the way it layers onto whatever prompt you already have β€” byobu's own colorized prompt from byobu-enable-prompt(1), a framework like oh-my-zsh or starship, or a plain unconfigured prompt β€” rather than replacing it? obsessed. main character energy but it shares the spotlight 🌟

You can safely remove the line from your shell configuration file yourself, bestie β€” it ends in #byobu-shell-integration#. that's your lil bookmark πŸŽ€

byobu-disable-shell-integration removes that line. bye bye πŸ‘‹

Only bash and zsh are supported. Running byobu-enable-shell-integration under any other shell prints an error and does nothing. she simply will not be participating 😭


πŸ‘‘ SEE ALSO πŸ‘‘

bash(1), zsh(1), byobu-enable-prompt(1)

https://byobu.org


πŸ’œ AUTHOR πŸ’œ

This manpage and the utility were written by Dustin Kirkland <kirkland@byobu.org> for Ubuntu systems (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation. slay, legally speaking βš–οΈβœ¨

The complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL on Debian/Ubuntu systems, or in /usr/share/doc/fedora-release-*/GPL on Fedora systems, or on the web at http://www.gnu.org/licenses/gpl.txt. πŸ“–


and that's the whole page, bestie!! this dropped as part of byobu on 15 August 202 β€” yes the date is a lil cursed, we're keeping it exactly as it is, no cap 🫢 go enable that shell integration and make your prompts make sense. mwah πŸ’‹

πŸ“¦ where this page comes from