https://github.com/reobin/typewritten
A minimal, lightweight, informative zsh prompt theme
https://github.com/reobin/typewritten
async git hacktoberfest minimal prompt shell terminal theme zsh
Last synced: 6 months ago
JSON representation
A minimal, lightweight, informative zsh prompt theme
- Host: GitHub
- URL: https://github.com/reobin/typewritten
- Owner: reobin
- License: mit
- Created: 2019-12-31T00:27:19.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-01T17:29:52.000Z (10 months ago)
- Last Synced: 2025-04-10T00:36:32.409Z (7 months ago)
- Topics: async, git, hacktoberfest, minimal, prompt, shell, terminal, theme, zsh
- Language: Shell
- Homepage: https://typewritten.dev
- Size: 6.14 MB
- Stars: 924
- Watchers: 5
- Forks: 66
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-me - typewritten - A minimal, informative zsh prompt theme. (Developments / CLI tools)
- awesome-me - typewritten - A minimal, informative zsh prompt theme. (Developments / CLI tools)
README
typewritten
A minimal zsh prompt
> 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 🌞
[](https://github.com/reobin/typewritten/stargazers)
[](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)