Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/iam4x/zsh-iterm-touchbar

Display feedback of terminal in the 🍏 Touchbar
https://github.com/iam4x/zsh-iterm-touchbar

git iterm2 productivity touchbar zsh

Last synced: about 2 months ago
JSON representation

Display feedback of terminal in the 🍏 Touchbar

Host: GitHub
URL: https://github.com/iam4x/zsh-iterm-touchbar
Owner: iam4x
License: mit
Created: 2017-04-18T23:45:10.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2022-06-28T21:58:58.000Z (almost 2 years ago)
Last Synced: 2024-04-14T05:17:07.127Z (about 2 months ago)
Topics: git, iterm2, productivity, touchbar, zsh
Language: Shell
Homepage:
Size: 5.22 MB
Stars: 687
Watchers: 13
Forks: 75
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-zsh-plugins - iterm-touchbar - Display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status). (Plugins / ZSH on Windows)
awesome-stars - iam4x/zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell)
awesome-stars - iam4x/zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell)
fucking-awesome-zsh-plugins - iterm-touchbar - Display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status). (Plugins / ZSH on Windows)
fucking-awesome-zsh-plugins - iterm-touchbar - Display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status). (Plugins / ZSH on Windows)
awesome-touchbar - zsh-iterm-touchbar - ZSH plugin to display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status)! (Table of Contents: / Utility:)
awesome-zsh-plugins - iterm-touchbar - Display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status). (Plugins / ZSH on Windows)
awesome-hacking-lists - iam4x/zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell)
awesome-stars - iam4x/zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell)
awesome-hacking-lists - zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell)
awesome-hacking-lists - zsh-iterm-touchbar - Display feedback of terminal in the 🍏 Touchbar (Shell (473))
awesome-zsh-plugins - iterm-touchbar - Display iTerm2 feedback in the MacbookPro TouchBar (Current directory, git branch & status). (Plugins / Zinit (née zplugin))

README

        # zsh iTerm Touchbar

> Display feedback of terminal in the 🍏 Touchbar

![preview1](./preview1.jpg)

![preview2](./preview2.gif)

Currently it shows:

  * F1 - Current directory 👉

  * F2 - Current git branch, press to display all branches and switch between them 🎋

  * F3 - Current git repo status 🔥 / 🙌

    * `+` — uncommitted changes in the index;

    * `!` — unstaged changes;

    * `?` — untracked changes;

    * `$` — stashed changes;

    * `⇣` — unpulled commits;

    * `⇡` — unpushed commits.

  * F4 - Push to origin branch (git push origin [branch]) ✉️

  * F5 - Display `npm-run` or `yarn-run` scripts from `package.json` ⚡️ /🐱

### Requirements

* iTerm2 3.1.beta.3 (OS 10.10+) - [Download](https://www.iterm2.com/downloads.html)

* [zsh](http://www.zsh.org/) shell

* a zsh-framework like [antigen](http://antigen.sharats.me/) or [zgen](https://github.com/tarjoilija/zgen)

* node (`brew install node`)

**Into iterm2:** Go into `View -> Customize Tool Bar...` and drag & drop the `Fn` module

### Installing plugin

#### For oh-my-zsh users

Clone the repo in your plugins directory:

* `$ cd ${ZSH_CUSTOM1:-$ZSH/custom}/plugins`

* `$ git clone https://github.com/iam4x/zsh-iterm-touchbar.git`

Then add the plugin into your `~/.zshrc`:

```

plugins=(... zsh-iterm-touchbar)

```

#### For antigen users

Add the following snippet `~/.zshrc` after the line antigen use oh-my-zsh:

```

antigen theme https://github.com/iam4x/zsh-iterm-touchbar

```

#### For Zgen users

Add the following line to your `~/.zshrc` where you're adding your other zsh plugins:

```

zgen load iam4x/zsh-iterm-touchbar

```

### Customize

ENV variables to enable or disable git:

```shell

TOUCHBAR_GIT_ENABLED=true

```

ENV variables for git icons:

```shell

GIT_UNCOMMITTED="+"

GIT_UNSTAGED="!"

GIT_UNTRACKED="?"

GIT_STASHED="$"

GIT_UNPULLED="⇣"

GIT_UNPUSHED="⇡"

```

ENV variables to enable or disable yarn:

```shell

YARN_ENABLED=true

```

### Read more / Credits

* [Original iTerm2 issue for TouchBar support](https://gitlab.com/gnachman/iterm2/issues/5281)

* [Thank's to spaceship-zsh-theme for git functions](https://github.com/denysdovhan/spaceship-zsh-theme/blob/9dbaee2cc6cfe0ac407cf901ebb97894ed279660/spaceship.zsh#L143-L173)