Awesome
<p align="center"> <img src="docs/_media/logo.svg" alt="typewritten" /> </p> <h1 align="center">typewritten</h1> <p align="center">A minimal <a href="https://www.zsh.org/">zsh</a> prompt</p> <br /> <p align="center"> <a href="https://github.com/reobin/typewritten/blob/master/LICENSE"> <img src="https://img.shields.io/github/license/reobin/typewritten?style=flat-square" /> </a> <a href="https://github.com/reobin/typewritten/releases"> <img src="https://img.shields.io/github/v/release/reobin/typewritten?style=flat-square" /> </a> <a href="https://npmjs.com/package/typewritten"> <img src="https://img.shields.io/npm/dm/typewritten?style=flat-square&logo=npm" /> </a> </p> <p align="center"> <a href="https://github.com/reobin/typewritten/stargazers"> <img src="https://img.shields.io/github/stars/reobin/typewritten?style=flat-square&logo=github" /> </a> <a href="https://github.com/reobin/typewritten/network/members"> <img src="https://img.shields.io/github/forks/reobin/typewritten?style=flat-square&logo=github" /> </a> <a href="#contributors"> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <img src="https://img.shields.io/badge/all_contributors-34-orange.svg?style=flat-square" alt="All contributors" /> <!-- ALL-CONTRIBUTORS-BADGE:END --> </a> </p> <p align="center"> <img src="docs/_media/typewritten.gif?raw=true" alt="typewritten zsh prompt demo" /> </p>Terminal is iTerm2 — Font is JetBrains Mono — Terminal theme is Seoul256
See how to make your terminal look exactly like the demo here
Features
- Asynchronous git info
- Fully customizable
Quick start
npm
npm install -g typewritten
That's it. The script will make the necessary symlinks to fpath and set the prompt in your .zshrc.
Homebrew
brew install typewritten
Then load typewritten in your .zshrc by using zsh prompinit:
autoload -U promptinit; promptinit
prompt typewritten
Manual
Clone the typewritten repository somewhere you can easily link. I recommend creating a .zsh directory at root.
mkdir -p "$HOME/.zsh"
git clone https://github.com/reobin/typewritten.git "$HOME/.zsh/typewritten"
Load typewritten in your .zshrc by using zsh prompinit:
fpath+=$HOME/.zsh/typewritten
autoload -U promptinit; promptinit
prompt typewritten
Note: if using oh-my-zsh, set ZSH_THEME="" in your .zshrc to disable oh-my-zsh themes.
Other ways to install
Many other ways to install typewritten are available in the docs
Customization
typewritten is customizable in many ways. To keep the readme file as lean as possible, the documentation was moved to https://typewritten.dev.
The documentation is separated into two parts:
- Prompt customization, everything to do with how and where the info is displayed
- Prompt color customization, set a custom color for any of the prompt sections
Example of 3 customized typewritten prompts
<p align="center"> <img src="docs/_media/configuration_examples/bash.png" width="800" /> </p> <p align="center"> <img src="docs/_media/configuration_examples/pure.png" width="400" /> <img src="docs/_media/configuration_examples/half_pure.png" width="400" /> </p>Contributors ✨
Thanks goes to these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center"><a href="https://github.com/reobin"><img src="https://avatars1.githubusercontent.com/u/5920450?v=4?s=100" width="100px;" alt="Robin Gagnon"/><br /><sub><b>Robin Gagnon</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=reobin" title="Code">💻</a> <a href="#maintenance-reobin" title="Maintenance">🚧</a> <a href="https://github.com/reobin/typewritten/commits?author=reobin" title="Documentation">📖</a></td> <td align="center"><a href="https://www.thbe.org/"><img src="https://avatars3.githubusercontent.com/u/495530?v=4?s=100" width="100px;" alt="thbe"/><br /><sub><b>thbe</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=thbe" title="Code">💻</a></td> <td align="center"><a href="http://erikreinertsen.com"><img src="https://avatars2.githubusercontent.com/u/1253422?v=4?s=100" width="100px;" alt="Erik Reinertsen"/><br /><sub><b>Erik Reinertsen</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=erikr" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/commits?author=erikr" title="Documentation">📖</a></td> <td align="center"><a href="https://twitter.com/artem_zin"><img src="https://avatars0.githubusercontent.com/u/967132?v=4?s=100" width="100px;" alt="Artem Zinnatullin :slowpoke:"/><br /><sub><b>Artem Zinnatullin :slowpoke:</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=artem-zinnatullin" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/commits?author=artem-zinnatullin" title="Documentation">📖</a></td> <td align="center"><a href="https://nizarmah.me/"><img src="https://avatars1.githubusercontent.com/u/5631091?v=4?s=100" width="100px;" alt="Nizar"/><br /><sub><b>Nizar</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=nizarmah" title="Code">💻</a></td> <td align="center"><a href="https://github.com/johnletey"><img src="https://avatars1.githubusercontent.com/u/62398724?v=4?s=100" width="100px;" alt="John Letey"/><br /><sub><b>John Letey</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=johnletey" title="Documentation">📖</a></td> <td align="center"><a href="http://www.linkedin.com/in/ninja18"><img src="https://avatars2.githubusercontent.com/u/19199814?v=4?s=100" width="100px;" alt="Niranjan"/><br /><sub><b>Niranjan</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=ninja18" title="Code">💻</a></td> </tr> <tr> <td align="center"><a href="https://github.com/mrillusi0n"><img src="https://avatars1.githubusercontent.com/u/37063502?v=4?s=100" width="100px;" alt="Nikhil"/><br /><sub><b>Nikhil</b></sub></a><br /><a href="#ideas-mrillusi0n" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="http://tdeekens.name"><img src="https://avatars3.githubusercontent.com/u/1877073?v=4?s=100" width="100px;" alt="Tobias Deekens"/><br /><sub><b>Tobias Deekens</b></sub></a><br /><a href="#ideas-tdeekens" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="https://xenoterracide.com"><img src="https://avatars3.githubusercontent.com/u/5517?v=4?s=100" width="100px;" alt="Caleb Cushing"/><br /><sub><b>Caleb Cushing</b></sub></a><br /><a href="#ideas-xenoterracide" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="http://k.petrov4y@outlook.com"><img src="https://avatars2.githubusercontent.com/u/51177852?v=4?s=100" width="100px;" alt="Konstantin Petrov"/><br /><sub><b>Konstantin Petrov</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=eleven4y" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/commits?author=eleven4y" title="Documentation">📖</a></td> <td align="center"><a href="https://rechtlogisch.de"><img src="https://avatars0.githubusercontent.com/u/2451083?v=4?s=100" width="100px;" alt="Krzysztof Tomasz Zembrowski"/><br /><sub><b>Krzysztof Tomasz Zembrowski</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=zembrowski" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/Ivan-Velickovic"><img src="https://avatars0.githubusercontent.com/u/10481259?v=4?s=100" width="100px;" alt="Ivan Velickovic"/><br /><sub><b>Ivan Velickovic</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=Ivan-Velickovic" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/barischrooneyj"><img src="https://avatars0.githubusercontent.com/u/6631452?v=4?s=100" width="100px;" alt="Jeremy Barisch-Rooney"/><br /><sub><b>Jeremy Barisch-Rooney</b></sub></a><br /><a href="#ideas-barischrooneyj" title="Ideas, Planning, & Feedback">🤔</a></td> </tr> <tr> <td align="center"><a href="https://github.com/oniGino"><img src="https://avatars3.githubusercontent.com/u/33404137?v=4?s=100" width="100px;" alt="Gino"/><br /><sub><b>Gino</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3AoniGino" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/frdrk"><img src="https://avatars3.githubusercontent.com/u/3447600?v=4?s=100" width="100px;" alt="frdrk"/><br /><sub><b>frdrk</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3Afrdrk" title="Bug reports">🐛</a> <a href="#userTesting-frdrk" title="User Testing">📓</a></td> <td align="center"><a href="https://github.com/huy-ha"><img src="https://avatars0.githubusercontent.com/u/33562579?v=4?s=100" width="100px;" alt="Huy Ha"/><br /><sub><b>Huy Ha</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3Ahuy-ha" title="Bug reports">🐛</a> <a href="#userTesting-huy-ha" title="User Testing">📓</a></td> <td align="center"><a href="https://github.com/foruniverse"><img src="https://avatars3.githubusercontent.com/u/32241199?v=4?s=100" width="100px;" alt="yanyan"/><br /><sub><b>yanyan</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=foruniverse" title="Code">💻</a></td> <td align="center"><a href="http://louisdecharson.github.io"><img src="https://avatars1.githubusercontent.com/u/3234544?v=4?s=100" width="100px;" alt="Louis de Charsonville"/><br /><sub><b>Louis de Charsonville</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3Alouisdecharson" title="Bug reports">🐛</a> <a href="https://github.com/reobin/typewritten/commits?author=louisdecharson" title="Code">💻</a></td> <td align="center"><a href="https://jack-chapman.com"><img src="https://avatars1.githubusercontent.com/u/38158363?v=4?s=100" width="100px;" alt="Jack Chapman"/><br /><sub><b>Jack Chapman</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=crepppy" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/issues?q=author%3Acrepppy" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/GPSBach"><img src="https://avatars1.githubusercontent.com/u/35227624?v=4?s=100" width="100px;" alt="GPSBach"/><br /><sub><b>GPSBach</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=GPSBach" title="Code">💻</a> <a href="#ideas-GPSBach" title="Ideas, Planning, & Feedback">🤔</a></td> </tr> <tr> <td align="center"><a href="http://williamlorey.com"><img src="https://avatars3.githubusercontent.com/u/22795803?v=4?s=100" width="100px;" alt="Will Lorey"/><br /><sub><b>Will Lorey</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=wwlorey" title="Documentation">📖</a></td> <td align="center"><a href="https://gartunius.github.io"><img src="https://avatars0.githubusercontent.com/u/27605237?v=4?s=100" width="100px;" alt="Gabriel Ataide"/><br /><sub><b>Gabriel Ataide</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3Agartunius" title="Bug reports">🐛</a> <a href="https://github.com/reobin/typewritten/commits?author=gartunius" title="Code">💻</a></td> <td align="center"><a href="https://github.com/Scupake"><img src="https://avatars0.githubusercontent.com/u/61241021?v=4?s=100" width="100px;" alt="Scupake"/><br /><sub><b>Scupake</b></sub></a><br /><a href="#ideas-Scupake" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/reobin/typewritten/commits?author=Scupake" title="Tests">⚠️</a></td> <td align="center"><a href="https://github.com/CrystalJewell"><img src="https://avatars.githubusercontent.com/u/21298255?v=4?s=100" width="100px;" alt="Crystal Adkins"/><br /><sub><b>Crystal Adkins</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=CrystalJewell" title="Code">💻</a> <a href="#ideas-CrystalJewell" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="https://github.com/juanCortelezzi"><img src="https://avatars.githubusercontent.com/u/57237705?v=4?s=100" width="100px;" alt="J.B.C"/><br /><sub><b>J.B.C</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3AjuanCortelezzi" title="Bug reports">🐛</a> <a href="https://github.com/reobin/typewritten/commits?author=juanCortelezzi" title="Code">💻</a></td> <td align="center"><a href="https://github.com/jeevatattva"><img src="https://avatars.githubusercontent.com/u/26855245?v=4?s=100" width="100px;" alt="Jeeva K"/><br /><sub><b>Jeeva K</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3Ajeevatattva" title="Bug reports">🐛</a> <a href="#ideas-jeevatattva" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="https://github.com/subhajit-halder"><img src="https://avatars.githubusercontent.com/u/54535412?v=4?s=100" width="100px;" alt="awakened"/><br /><sub><b>awakened</b></sub></a><br /><a href="#ideas-subhajit-halder" title="Ideas, Planning, & Feedback">🤔</a></td> </tr> <tr> <td align="center"><a href="https://github.com/spamwax"><img src="https://avatars.githubusercontent.com/u/1251233?v=4?s=100" width="100px;" alt="spamwax"/><br /><sub><b>spamwax</b></sub></a><br /><a href="#ideas-spamwax" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="https://austinray.io"><img src="https://avatars.githubusercontent.com/u/1640737?v=4?s=100" width="100px;" alt="Austin Ray"/><br /><sub><b>Austin Ray</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=Austin-Ray" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/issues?q=author%3AAustin-Ray" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/Pound-Hash"><img src="https://avatars.githubusercontent.com/u/51193876?v=4?s=100" width="100px;" alt="Alan"/><br /><sub><b>Alan</b></sub></a><br /><a href="https://github.com/reobin/typewritten/issues?q=author%3APound-Hash" title="Bug reports">🐛</a></td> <td align="center"><a href="http://vedantnandwana.me"><img src="https://avatars.githubusercontent.com/u/70624701?v=4?s=100" width="100px;" alt="Vedant Nandwana"/><br /><sub><b>Vedant Nandwana</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=vedantnn71" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/KEDLogic"><img src="https://avatars.githubusercontent.com/u/9738036?v=4?s=100" width="100px;" alt="Kyle Dozier"/><br /><sub><b>Kyle Dozier</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=KEDLogic" title="Documentation">📖</a> <a href="#ideas-KEDLogic" title="Ideas, Planning, & Feedback">🤔</a></td> <td align="center"><a href="http://vimeo.com/danielbayley"><img src="https://avatars.githubusercontent.com/u/7797479?v=4?s=100" width="100px;" alt="Daniel Bayley"/><br /><sub><b>Daniel Bayley</b></sub></a><br /><a href="https://github.com/reobin/typewritten/commits?author=danielbayley" title="Code">💻</a> <a href="https://github.com/reobin/typewritten/commits?author=danielbayley" title="Documentation">📖</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!
Supporters 🌞
Credits
purelayout is inspired by Purenpminstall and uninstall scripts are from Spaceship prompt