Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alichtman/zsh-startify
Fancy start screen for zsh! Inspired by vim-startify.
https://github.com/alichtman/zsh-startify
tmux zsh zsh-configuration zsh-prompt
Last synced: 28 days ago
JSON representation
Fancy start screen for zsh! Inspired by vim-startify.
- Host: GitHub
- URL: https://github.com/alichtman/zsh-startify
- Owner: alichtman
- License: mit
- Created: 2019-08-26T03:18:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-17T01:47:25.000Z (almost 5 years ago)
- Last Synced: 2024-09-27T23:20:55.076Z (about 1 month ago)
- Topics: tmux, zsh, zsh-configuration, zsh-prompt
- Language: Python
- Size: 740 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`:
```bash
$ pip3 install zsh-startify
$ echo "zsh-startify" >> ~/.zshrc
```
But, if you'd like to install it manually:
```bash
$ git clone [email protected]: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:
```bash
$ 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](http://www.figlet.org/examples.html).
- **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:
```bash
export ZSH_STARTIFY_HEADER_TEXT="custom-header"
export ZSH_STARTIFY_HEADER_FONT="slant"
```
### Minimal Configuration
I found myself using this minimal configuration often:
```bash
export ZSH_STARTIFY_NO_SPLASH=true
export ZSH_STARTIFY_NON_INTERACTIVE=true
```
I put this in my `.zshrc`, and found that `Python` was too slow to be running every time I opened a new shell. I rewrote it in `bash` for performance benefits of around half a second. You can find the script here: [`tls.sh`](https://github.com/alichtman/scripts/blob/master/tls.sh).
## `tmux` Integration
This works best when used with these two `tmux` plugins:
- [`tmux-resurrect`](https://github.com/tmux-plugins/tmux-resurrect)
- [`tmux-continuum`](https://github.com/tmux-plugins/tmux-continuum)
## Inspiration
I've used [vim-startify](https://github.com/mhinz/vim-startify) a lot. I figured it was time for `zsh` and `tmux` to have a similar tool.