Have ideas to improve npm?Join in the discussion! »

    typewritten

    1.4.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

    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.

    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

    💻 🚧 📖

    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

    💻 🤔

    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

    Inspiration

    pure layout is inspired by Pure

    Install

    npm i typewritten

    DownloadsWeekly Downloads

    62

    Version

    1.4.1

    License

    MIT

    Unpacked Size

    47.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • avatar