https://github.com/pascal-zarrad/psh
A tool to generate and install a pre-configured delightful zsh experience
https://github.com/pascal-zarrad/psh
antigen antigen-config zsh-configuration zsh-plugin zsh-theme zshrc
Last synced: 5 months ago
JSON representation
A tool to generate and install a pre-configured delightful zsh experience
- Host: GitHub
- URL: https://github.com/pascal-zarrad/psh
- Owner: pascal-zarrad
- License: apache-2.0
- Created: 2019-10-10T18:46:18.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T20:40:25.000Z (about 1 year ago)
- Last Synced: 2024-07-27T20:55:48.544Z (about 1 year ago)
- Topics: antigen, antigen-config, zsh-configuration, zsh-plugin, zsh-theme, zshrc
- Language: Shell
- Homepage:
- Size: 8.41 MB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# psh [](https://github.com/pascal-zarrad/psh/actions/workflows/ci.yml)
psh - which stands for Pascal's Shell is a configuration tool for zsh.
It is a composition of the finest plugins and a nice looking theme (currently it is one bundled with oh-my-zsh)
that helps myself and hopefully also others to grow their productivity by customizing their shell experience.
This installer enables the fast installation of zsh, zplug, oh-my-zsh and other plugins that provide a great zsh experience.
The installer generates always a custom .zshrc which can be modified by adding own customizations to the plugins folder.
To make customizations even easier, psh has a template system that allows the import of personalized .zshrc snippets that are composed together
and inserted into the generated configuration!
It was never that easy and therefore fast to install a customized shell than with psh - and with some knowledge about shell scripting with bash/zsh,
you will be able to implement everything you could imagine in a configuration for zsh.
> Why psh if I could just use zplug?
>
> Firstly, psh is pre-configured in a way that is already quite powerful.
> The target of the default configuration is to make shell enjoyable and move people
> to prefer shell over GUI.
>
> Secondly, psh takes care of dependencies. You setup your new os, clone this repository
> and run the `install.sh` script. If your system is supported, psh installs
> everything necessary - from zsh to git or curl.
> After the install script, your zsh is ready to go.
The targets of psh are:
* Create a great zsh experience out of the box
* Automate and simplify installation by using an installer
* Be extendable for forks and own variations of the installer
## What is used
You can find a list of used frameworks and plugins in the wiki under [Technologies](https://github.com/pascal-zarrad/psh/wiki/Technologies).
## Compatibility
In theory all configuration done by psh should work on any system that is compatible with zsh and all dependencies
that are used to enhance the zsh experience. However, due to package management, not all operating systems are supported.
Currently psh is only tested in the following environments:
* Arch Linux
* Manjaro Linux
* Ubuntu
* Debian
* PopOs!
* Windows Subsystem for Linux 2 (WSL2)
* macOS (experimental support)
psh is is only tested on the current OS releases when a release is made.
If you want to be sure, test psh in a virtual machine before installing it.
You can find further information in the wiki under [Compatibility](https://github.com/pascal-zarrad/psh/wiki/Compatibility).
## Installation
The installation is documented in the wiki under [Installation](https://github.com/pascal-zarrad/psh/wiki/Installation).
## Updating
Updating psh is as simple as installing it - you just need to pull the newest version from GitHub.
You find information on how to update psh in the wiki under [Updating](https://github.com/pascal-zarrad/psh/wiki/Updating).
## Creating templates
A guide on templates is also available on the wiki under [Templates](https://github.com/pascal-zarrad/psh/wiki/Templates).
## Code Quality
To ensure code quality, the scripts in the repository are being checked by [shellcheck](https://github.com/koalaman/shellcheck).
Please refer to the shellcheck repository's README on how to install shellcheck on your computer.
To check code quality run: ```shellcheck **/*.sh```
**NOTE:** When pushing to this repository, TravisCI will check your changes.There's no way around the check.
## Contributing
You are welcome to contribute to psh if you have improvements or bug fixes.
You are also welcome to suggest own plugins that should be added to the default
psh installation. Refer to [Contributing](https://github.com/pascal-zarrad/psh/blob/master/CONTRIBUTING.md)
if you want to be a contributor or simply create an issue.