Skip to content

Kqpa/zeesh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

zeesh

A lightweight, fast and easy-to-use framework for the Z Shell.

▒▒▒▒ ▒▒   ▒▒▒▒ ▒▒   ▒▒▒▒ ▒▒
▒▒ ■ ▒▒   ▒▒ ■ ▒▒   ▒▒ ■ ▒▒
▒▒ ▒▒▒▒   ▒▒ ▒▒▒▒   ▒▒ ▒▒▒▒

Installation

In order to install zeesh, you'll first need to have the following packages installed on your system:

  1. zsh: Required for zeesh to function as a whole.
  2. curl: Used to run the installation script.
  3. git: Used to download the repository & for other internal components

After ensuring that those packages are installed, run this command in your terminal:

zsh -c "$(curl -s 'https://raw.githubusercontent.com/Kqpa/zeesh/master/.install.sh')"

Information

  • You can manage zeesh's configuration by running zeesh config. You have a bunch of options like editing & resetting your zeesh configuraiton.

  • If you want to uninstall zeesh, run zeesh uninstall in your terminal and reload your shell configuration by running source ~/.zshrc.

  • If you want to update your current zeesh installation, run zeesh update in your terminal and reload your shell configuration by running source ~/.zshrc.

  • If your zeesh configuration is not up-to-date, you can see the latest configuration file by running zeesh config example. If you want to use the latest zeesh configuration, run zeesh config reset, this will reset your configuration to the default configuration of your zeesh installation. You can roll-back to your previous zeesh configuration by running zeesh config recover.

  • If you want to disable a shell script or a whole directory, you can add a dot before the file/folder. For example, if you want to disable ./src/scripts/ccp.sh, you can change the file name of ccp.sh to .ccp.sh. - If you want to disable a directory, let's say ./src/scripts, you can change the directory name from scripts to .scripts.

Features

  • zeesh ships itself with a lot of convinient shell aliases that are sourced from ./src/aliases/*
  • zeesh has a lot of convinient shell scripts that allow you to automate tasks, which are sourced from ./src/scripts/*.
  • zeesh gives you the ability to tweak your terminal with pre-configured prompts & TTY themes.

Shell Prompts

  • Minimal

  • Space

  • Classic

TTY Themes

  • Solarized Light

  • Solarized Dark

  • Dracula Dark

  • Soft Dark