typewritten

1.5.1 • Public • Published

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

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:

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

Package Sidebar

Install

npm i typewritten

Weekly Downloads

17

Version

1.5.1

License

MIT

Unpacked Size

60.7 kB

Total Files

9

Last publish

Collaborators

  • reobin