Skip to main content

zsh-startify

You can also use it in a more minimal configuration, like this:


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.
  • ZSH_STARTIFY_NO_SPLASH
    • Set this environment variable to not print the splash screen.
    • Default: Not set. If set to anything, the splash screen will not be printed.
  • ZSH_STARTIFY_NON_INTERACTIVE
    • Set this environment variable to not display the action picking menu.
    • Default: Not set. If set to anything, the interactive menu will not be displayed.

An example of this could be:

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

My configuration is:

export ZSH_STARTIFY_NO_SPLASH=true
export ZSH_STARTIFY_NON_INTERACTIVE=true

tmuxIntegration

This works best when used with these two tmux plugins:

Inspiration

I've used vim-startify a lot. I figured it was time for zsh and tmux to have a similar tool.

Release files for zsh-startify 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for zsh-startify 0.3.0
File Interpreter ABI Platform
zsh_startify-0.3.0-py3.7.egg Legacy Egg format - - Details
zsh_startify-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 15.9 kB

Release files / zsh_startify-0.3.0-py3.7.egg

Download URL zsh_startify-0.3.0-py3.7.egg
Size 9.4 kB
Tags Egg
SHA-256 checksum
How to use checksums
c88157f2a257a7e24c1a14901d644d972af6992ac3e40831a4abbb91b8c27332
BLAKE2b-256 checksum
How to use checksums
e396d4830894fc19af0f0a1304caffb3261401e855d706875d6cf06064676824
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Release files / zsh_startify-0.3.0-py3-none-any.whl

Download URL zsh_startify-0.3.0-py3-none-any.whl
Size 6.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f2ec1b6435024b1f48426c3315aca254fc58b6004691ea1cfe7ea64595f3204a
BLAKE2b-256 checksum
How to use checksums
d60f60bb312d50f3a4c7f844dab7df9faa4d65fdfb18362bbe1ab5de40601266
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.4

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

1 release file

0.1.0

3 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page