{"id":13588233,"url":"https://github.com/iam4x/zsh-iterm-touchbar","last_synced_at":"2025-04-04T10:07:08.686Z","repository":{"id":59987142,"uuid":"88680348","full_name":"iam4x/zsh-iterm-touchbar","owner":"iam4x","description":"Display feedback of terminal in the 🍏 Touchbar","archived":false,"fork":false,"pushed_at":"2022-06-28T21:58:58.000Z","size":5474,"stargazers_count":688,"open_issues_count":11,"forks_count":75,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-28T09:06:25.101Z","etag":null,"topics":["git","iterm2","productivity","touchbar","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iam4x.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-18T23:45:10.000Z","updated_at":"2025-01-16T20:48:43.000Z","dependencies_parsed_at":"2022-09-23T16:01:32.786Z","dependency_job_id":null,"html_url":"https://github.com/iam4x/zsh-iterm-touchbar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iam4x%2Fzsh-iterm-touchbar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iam4x%2Fzsh-iterm-touchbar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iam4x%2Fzsh-iterm-touchbar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iam4x%2Fzsh-iterm-touchbar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iam4x","download_url":"https://codeload.github.com/iam4x/zsh-iterm-touchbar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157107,"owners_count":20893214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","iterm2","productivity","touchbar","zsh"],"created_at":"2024-08-01T15:06:35.157Z","updated_at":"2025-04-04T10:07:08.664Z","avatar_url":"https://github.com/iam4x.png","language":"Shell","funding_links":[],"categories":["Plugins","Shell","Table of Contents:","Shell (473)"],"sub_categories":["ZSH on Windows","Utility:","Zinit (née zplugin)"],"readme":"# zsh iTerm Touchbar\n\n\u003e Display feedback of terminal in the 🍏 Touchbar\n\n![preview1](./preview1.jpg)\n\n![preview2](./preview2.gif)\n\nCurrently it shows:\n\n  * F1 - Current directory 👉\n  * F2 - Current git branch, press to display all branches and switch between them 🎋\n  * F3 - Current git repo status 🔥 / 🙌\n    * `+` — uncommitted changes in the index;\n    * `!` — unstaged changes;\n    * `?` — untracked changes;\n    * `$` — stashed changes;\n    * `⇣` — unpulled commits;\n    * `⇡` — unpushed commits.\n  * F4 - Push to origin branch (git push origin [branch]) ✉️\n  * F5 - Display `npm-run` or `yarn-run` scripts from `package.json` ⚡️ /🐱\n\n### Requirements\n\n* iTerm2 3.1.beta.3 (OS 10.10+) - [Download](https://www.iterm2.com/downloads.html)\n* [zsh](http://www.zsh.org/) shell\n* a zsh-framework like [antigen](http://antigen.sharats.me/) or [zgen](https://github.com/tarjoilija/zgen)\n* node (`brew install node`)\n\n**Into iterm2:** Go into `View -\u003e Customize Tool Bar...` and drag \u0026 drop the `Fn` module\n\n### Installing plugin\n\n#### For oh-my-zsh users\n\nClone the repo in your plugins directory:\n\n* `$ cd ${ZSH_CUSTOM1:-$ZSH/custom}/plugins`\n* `$ git clone https://github.com/iam4x/zsh-iterm-touchbar.git`\n\nThen add the plugin into your `~/.zshrc`:\n\n```\nplugins=(... zsh-iterm-touchbar)\n```\n\n#### For antigen users\n\nAdd the following snippet `~/.zshrc` after the line antigen use oh-my-zsh:\n\n```\nantigen theme https://github.com/iam4x/zsh-iterm-touchbar\n```\n\n#### For Zgen users\n\nAdd the following line to your `~/.zshrc` where you're adding your other zsh plugins:\n\n```\nzgen load iam4x/zsh-iterm-touchbar\n```\n\n### Customize\n\nENV variables to enable or disable git:\n\n```shell\nTOUCHBAR_GIT_ENABLED=true\n```\nENV variables for git icons:\n\n```shell\nGIT_UNCOMMITTED=\"+\"\nGIT_UNSTAGED=\"!\"\nGIT_UNTRACKED=\"?\"\nGIT_STASHED=\"$\"\nGIT_UNPULLED=\"⇣\"\nGIT_UNPUSHED=\"⇡\"\n```\n\nENV variables to enable or disable yarn:\n\n```shell\nYARN_ENABLED=true\n```\n\n### Read more / Credits\n\n* [Original iTerm2 issue for TouchBar support](https://gitlab.com/gnachman/iterm2/issues/5281)\n* [Thank's to spaceship-zsh-theme for git functions](https://github.com/denysdovhan/spaceship-zsh-theme/blob/9dbaee2cc6cfe0ac407cf901ebb97894ed279660/spaceship.zsh#L143-L173)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiam4x%2Fzsh-iterm-touchbar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiam4x%2Fzsh-iterm-touchbar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiam4x%2Fzsh-iterm-touchbar/lists"}