Skip to main content

Fancy start screen for zsh w/ tmux integration and more!

Project description

zsh-startify

TODO: Insert demo.

This is a fancy start screen for zsh. After starting a terminal session, it will:

  • Start a tmux server if it's not already running
  • Allow you to easily attach to any tmux sessions
  • Allow you to easily create new tmux sessions
  • Allow you to quickly launch a zsh session, by Ctrl-C'ing or Ctrl-D'ing out of the prompt.

Installation

The recommended installation method is through PyPi:

$ pip3 install zsh-startify
$ echo "zsh-startify >> ~/.zshrc"

But, if you'd like to install it manually:

$ git clone git@github.com:alichtman/zsh-startify.git && cd zsh-startify
$ python3 setup.py install
$ echo "zsh-startify >> ~/.zshrc"

Note: This tool depends on Python 3.6+. You can check what version you have with:

$ python3 --version
Python 3.7.4

Configuration

This tool comes with sensible defaults. No configuration is necessary, however, the following settings may be changed in your ~/.zshrc file:

  • ZSH_STARTIFY_HEADER_FONT
    • This is the Figlet font that the header text will be printed in.
    • Default: univers. Accepts any Figlet font.
  • ZSH_STARTIFY_HEADER_TEXT
    • This string will be printed as the header.
    • Default: zsh. Accepts any string.

A simple example of this is:

export ZSH_STARTIFY_HEADER_TEXT="custom-header"
export ZSH_STARTIFY_HEADER_FONT="slant"

Inspiration

I've used vim-startify pretty much every day for the past year. I figured it was time for zsh and tmux to have a similar tool.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zsh-startify-0.1.0.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distributions

zsh_startify-0.1.0-py3.7.egg (9.2 kB view hashes)

Uploaded Source

zsh_startify-0.1.0-py2.py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page