https://github.com/rodrigobdz/fish-apple-touchbar

⚡️ Supercharge your touchbar with fish 🐠
https://github.com/rodrigobdz/fish-apple-touchbar

awesome-fish-shell awesome-plugin fish-shell fisher iterm2 macbook-pro touchbar touchbar-support zsh-apple-touchbar

Last synced: 18 days ago
JSON representation

⚡️ Supercharge your touchbar with fish 🐠

• Host: GitHub
• URL: https://github.com/rodrigobdz/fish-apple-touchbar
• Owner: rodrigobdz
• License: mit
• Created: 2018-11-27T12:13:56.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2022-04-29T15:56:25.000Z (over 2 years ago)
• Last Synced: 2024-11-02T15:36:26.617Z (about 2 months ago)
• Topics: awesome-fish-shell, awesome-plugin, fish-shell, fisher, iterm2, macbook-pro, touchbar, touchbar-support, zsh-apple-touchbar
• Language: Shell
• Homepage:
• Size: 9.4 MB
• Stars: 91
• Watchers: 4
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awsm.fish - Apple Touchbar - Customize your [Touch Bar](https://developer.apple.com/design/human-interface-guidelines/macos/touch-bar/touch-bar-overview) in iTerm2 (Plugins)

README

        
# fish-apple-touchbar [![Mentioned in Awesome fish-shell](https://awesome.re/mentioned-badge.svg)](https://github.com/jorgebucaran/awesome-fish#utilities)

> Supercharge your touchbar with fish

## Requirements

- [fish](https://github.com/fish-shell/fish-shell)

- [iTerm2](https://iterm2.com)

- MacBook Pro with [Touch Bar](https://developer.apple.com/macos/touch-bar)

## Installation

1. Set up iTerm2

   Go to **View > Customize Touch Bar** and drag the **Function Keys** (F1) item to your touchbar.

   Your touch bar should now look like this:

   ![function keys touchbar](./assets/iterm2-touchbar-function-module.png)

1. Install with [Fisher](https://github.com/jorgebucaran/fisher)

   ```console

   fisher install rodrigobdz/fish-apple-touchbar

   ```

1. Open a new terminal session to activate the package

## Usage

It currently shows three default views from [zsh-apple-touchbar](https://github.com/zsh-users/zsh-apple-touchbar) which are configurable in `fish-apple-touchbar.fish`.

![fish-apple-touchbar preview](./assets/preview.gif)

Preview made with [Touch Bar Simulator](https://github.com/sindresorhus/touch-bar-simulator) and [Gifski](https://github.com/sindresorhus/gifski-app).

## Related

### Projects

- [zsh-users/zsh-apple-touchbar](https://github.com/zsh-users/zsh-apple-touchbar): **fish-apple-touchbar** is based on zsh-apple-touchbar and was ported to work with fish. For more information, please read [zsh-apple-touchbar/issues/2](https://github.com/zsh-users/zsh-apple-touchbar/issues/2).

- [derekstavis/touchrunner](https://github.com/derekstavis/touchrunner): Offers some extended functionality. Keybinding commands to configure the Touchbar were useful for the creation of **fish-apple-touchbar**.

### Dev Documentation

- [Proprietary Escape Codes - iterm2](https://iterm2.com/documentation-escape-codes.html)

- [Touch Bar - iterm2](https://iterm2.com/documentation-touch-bar.html)

- [Control Characters and Escape Sequences - Terminal Guide](https://terminalguide.namepad.de/seq/osc-1337-setkeylabel/)

- [`commandline` - fish](https://fishshell.com/docs/current/cmds/commandline.html)

- [`bind` - fish](https://fishshell.com/docs/current/cmds/bind.html)

## License

[MIT](LICENSE) © [rodrigobdz](https://rodrigobdz.github.io/).