Skip to content

reobin/typewritten

Repository files navigation

typewritten

typewritten

A minimal zsh prompt


All contributors

typewritten zsh prompt demo

Terminal is iTerm2 β€” Font is JetBrains Mono β€” Terminal theme is Seoul256

See how to make your terminal look exactly like the demo here

Features

Quick start

npm install -g typewritten

That's it. The script will make the necessary symlinks to fpath and set the prompt in your .zshrc.

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:

Example of 3 customized typewritten prompts

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Robin Gagnon
Robin Gagnon

πŸ’» 🚧 πŸ“–
thbe
thbe

πŸ’»
Erik Reinertsen
Erik Reinertsen

πŸ’» πŸ“–
Artem Zinnatullin :slowpoke:
Artem Zinnatullin :slowpoke:

πŸ’» πŸ“–
Nizar
Nizar

πŸ’»
John Letey
John Letey

πŸ“–
Niranjan
Niranjan

πŸ’»
Nikhil
Nikhil

πŸ€”
Tobias Deekens
Tobias Deekens

πŸ€”
Caleb Cushing
Caleb Cushing

πŸ€”
Konstantin Petrov
Konstantin Petrov

πŸ’» πŸ“–
Krzysztof Tomasz Zembrowski
Krzysztof Tomasz Zembrowski

πŸ“–
Ivan Velickovic
Ivan Velickovic

πŸ“–
Jeremy Barisch-Rooney
Jeremy Barisch-Rooney

πŸ€”
Gino
Gino

πŸ›
frdrk
frdrk

πŸ› πŸ““
Huy Ha
Huy Ha

πŸ› πŸ““
yanyan
yanyan

πŸ’»
Louis de Charsonville
Louis de Charsonville

πŸ› πŸ’»
Jack Chapman
Jack Chapman

πŸ’» πŸ›
GPSBach
GPSBach

πŸ’» πŸ€”
Will Lorey
Will Lorey

πŸ“–
Gabriel Ataide
Gabriel Ataide

πŸ› πŸ’»
Scupake
Scupake

πŸ€” ⚠️
Crystal Adkins
Crystal Adkins

πŸ’» πŸ€”
J.B.C
J.B.C

πŸ› πŸ’»
Jeeva K
Jeeva K

πŸ› πŸ€”
awakened
awakened

πŸ€”
spamwax
spamwax

πŸ€”
Austin Ray
Austin Ray

πŸ’» πŸ›
Alan
Alan

πŸ›
Vedant Nandwana
Vedant Nandwana

πŸ“–
Kyle Dozier
Kyle Dozier

πŸ“– πŸ€”
Daniel Bayley
Daniel Bayley

πŸ’» πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

Supporters 🌞

Stargazers repo roster for @reobin/typewritten

Forkers repo roster for @reobin/typewritten

Credits