typewritten

A minimal zsh prompt

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
  • Colors for any of the prompt sections
  • Prompt layout
  • Prompt symbol
  • Constant display of git home directory
  • Cursor
  • Prefix on right prompt

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

Contributors ✨

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!

Supporters 🌞

Credits

• pure layout is inspired by Pure
• npm install and uninstall scripts are from Spaceship prompt