Finalzsh

Use Your Terminal Like A Hacker
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

README

• en English
• zh_CN 简体中文

About The Project

Finalzsh aims to configure your terminal with one click through scripts to realize terminal appearance customization, enhanced commands, plugin management, and other functions. This project is based on the Z shell terminal simulator, using a series of Zsh plugins to improve the terminal and achieve simple commands to complete complex interactive interface operations.

Feature

• Plugin Manager (Install, Update, Uninstall Plugins)
• Terminal appearance customization
• Enhanced Command
• Automatic installation, update and uninstall software through scripts

Getting Started

Prerequisites

Finalzsh utilizes shell scripts to execute automated operations, thus requiring a Unix-like platform environment. Finalzsh supports the following platforms:

• Ubuntu
• MacOS
• Parrot
• Wsl2 (windows)

Installation

run the following script:

 ./install.sh

(back to top)

Usage

Shortcut keys

• CTRL + \ Automatically complete commands
• ESC Automatically add sudo prefix when failing commands because of Execution permissions.

Command

1. customize the appearance of your terminal

p10k configuration

2. find some files

fzf

3. jump the target directory

j target_dir

4. jump and open the target directory

jo target_dir

5. return to the previous directory （note that 1 is a level）

up 1

6. Open the GitHub webpage of the project

git-open

7.Decompress the file

extract

8.generate the .gitignore template

gi

(back to top)

Roadmap

• Add a command like help
• Add some extra initial plugins
• Improve the install.sh scripts

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

ToSeven - Byone.heng@gmail.com

Project Link: https://github.com/ToSeven/finalzsh

Acknowledgments

• Shell

(back to top)