typewritten

A minimal zsh prompt

typewritten zsh prompt demo

> Terminal is [iTerm2](https://iterm2.com/) — Font is [JetBrains Mono](https://www.jetbrains.com/lp/mono/) — Terminal theme is [Seoul256](https://github.com/junegunn/seoul256.vim) > > See how to make your terminal look exactly like the demo [here](https://github.com/reobin/typewritten/discussions/128) ## Features - Asynchronous git info - Fully customizable - [Colors for any of the prompt sections](https://typewritten.dev/#/prompt_color_customization) - [Prompt layout](https://typewritten.dev/#/prompt_customization?id=typewritten_prompt_layout) - [Prompt symbol](https://typewritten.dev/#/prompt_customization?id=typewritten_symbol) - [Constant display of git home directory](https://typewritten.dev/#/prompt_customization?id=typewritten_git_relative_path) - [Cursor](https://typewritten.dev/#/prompt_customization?id=typewritten_cursor) - [Prefix on right prompt](https://typewritten.dev/#/prompt_customization?id=typewritten_right_prompt_prefix) ## Quick start ### [npm](https://npmjs.com/get-npm) ```shell npm install -g typewritten ``` That's it. The script will make the necessary symlinks to `fpath` and set the prompt in your `.zshrc`. ### [Homebrew](https://brew.sh) ```shell brew install typewritten ``` Then load typewritten in your `.zshrc` by using zsh prompinit: ```shell autoload -U promptinit; promptinit prompt typewritten ``` ### Manual Clone the typewritten repository somewhere you can easily link. I recommend creating a `.zsh` directory at root. ```shell mkdir -p "$HOME/.zsh" git clone https://github.com/reobin/typewritten.git "$HOME/.zsh/typewritten" ``` Load typewritten in your `.zshrc` by using zsh prompinit: ```shell 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](https://typewritten.dev/#/installation) ## Customization typewritten is customizable in many ways. To keep the readme file as lean as possible, the documentation was moved to [https://typewritten.dev](https://typewritten.dev). The documentation is separated into two parts: - [Prompt customization](https://typewritten.dev/#/prompt_customization), everything to do with how and where the info is displayed - [Prompt color customization](https://typewritten.dev/#/prompt_color_customization), set a custom color for any of the prompt sections **Example of 3 customized typewritten prompts**

## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_{Robin Gagnon} 💻 🚧 📖	_thbe 💻	_{Erik Reinertsen} 💻 📖	_{Artem Zinnatullin :slowpoke:} 💻 📖	_Nizar 💻	_{John Letey} 📖	_Niranjan 💻
_Nikhil 🤔	_{Tobias Deekens} 🤔	_{Caleb Cushing} 🤔	_{Konstantin Petrov} 💻 📖	_{Krzysztof Tomasz Zembrowski} 📖	_{Ivan Velickovic} 📖	_{Jeremy Barisch-Rooney} 🤔
_Gino 🐛	_frdrk 🐛 📓	_{Huy Ha} 🐛 📓	_yanyan 💻	_{Louis de Charsonville} 🐛 💻	_{Jack Chapman} 💻 🐛	_GPSBach 💻 🤔
_{Will Lorey} 📖	_{Gabriel Ataide} 🐛 💻	_Scupake 🤔 ⚠️	_{Crystal Adkins} 💻 🤔	_J.B.C 🐛 💻	_{Jeeva K} 🐛 🤔	_awakened 🤔
_spamwax 🤔	_{Austin Ray} 💻 🐛	_Alan 🐛	_{Vedant Nandwana} 📖	_{Kyle Dozier} 📖 🤔	_{Daniel Bayley} 💻 📖

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## Supporters 🌞 [![Stargazers repo roster for @reobin/typewritten](https://reporoster.com/stars/reobin/typewritten)](https://github.com/reobin/typewritten/stargazers) [![Forkers repo roster for @reobin/typewritten](https://reporoster.com/forks/reobin/typewritten)](https://github.com/reobin/typewritten/network/members) ## Credits - `pure` layout is inspired by [Pure](https://github.com/sindresorhus/pure) - `npm` install and uninstall scripts are from [Spaceship prompt](https://github.com/spaceship-prompt/spaceship-prompt)