https://github.com/amjaradat01/awesome-lazy-zsh

Awesome-Lazy-Zsh is a streamlined, customizable Zsh setup tool that simplifies plugin and theme management. It enhances your terminal experience by offering an easy-to-use CLI for configuring your Zsh environment, managing .zshrc backups, and automating dependency checks for tools like Git, Node.js, and Homebrew.
https://github.com/amjaradat01/awesome-lazy-zsh

List: awesome-lazy-zsh

automation awesome bash cli lazy oh-my-zsh shell terminal terminal-customization zsh zsh-configuration zsh-plugins zsh-themes zshrc

Last synced: 3 months ago
JSON representation

Awesome-Lazy-Zsh is a streamlined, customizable Zsh setup tool that simplifies plugin and theme management. It enhances your terminal experience by offering an easy-to-use CLI for configuring your Zsh environment, managing .zshrc backups, and automating dependency checks for tools like Git, Node.js, and Homebrew.

• Host: GitHub
• URL: https://github.com/amjaradat01/awesome-lazy-zsh
• Owner: AmJaradat01
• License: mit
• Created: 2024-08-14T19:05:17.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T20:23:00.000Z (4 months ago)
• Last Synced: 2024-09-28T07:40:11.771Z (3 months ago)
• Topics: automation, awesome, bash, cli, lazy, oh-my-zsh, shell, terminal, terminal-customization, zsh, zsh-configuration, zsh-plugins, zsh-themes, zshrc
• Language: JavaScript
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

README

        
# Awesome Lazy Zsh

[![Awesome](https://awesome.re/badge.svg)](https://awesome.re) ![Version](https://img.shields.io/badge/version-v2.0.1-blue.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Awesome-Lazy-Zsh is a simplified and customizable Zsh setup tool for managing plugins and themes. It streamlines your terminal environment with an easy-to-use CLI interface, allowing you to manage `.zshrc` configurations effectively.

## Features

- **Plugin Management**: Install and manage plugins easily.

- **Theme Customization**: Apply a variety of Zsh themes.

- **Backup and Restore**: Safeguard your `.zshrc` configurations.

- **Interactive CLI**: User-friendly setup options.

- **Dependency Management**: Automatically checks for Git, Node.js, and Homebrew.

## Table of Contents

- [Awesome Lazy Zsh](#awesome-lazy-zsh)

  - [Features](#features)

  - [Table of Contents](#table-of-contents)

  - [Installation](#installation)

    - [Step-by-Step Installation](#step-by-step-installation)

  - [Usage](#usage)

    - [Starting the Setup](#starting-the-setup)

    - [Fresh Installation](#fresh-installation)

    - [Default Installation](#default-installation)

    - [Backup/Restore](#backuprestore)

  - [Contributing](#contributing)

  - [License](#license)

## Installation

To start using Awesome-Lazy-Zsh, clone the repository and run the `setup.sh` script.

### Step-by-Step Installation

1. **Clone the Repository**:

    ```bash

    git clone https://github.com/AmJaradat01/awesome-lazy-zsh.git

    cd awesome-lazy-zsh

    ```

2. **Run the Setup Script**:

    ```bash

    chmod +x setup.sh

    ./setup.sh

    ```

    The script will install Git, Node.js, and Homebrew if necessary, and provide options for managing themes, plugins, and backups.

## Usage

After running `setup.sh`, you can proceed with a fresh installation, default installation, or backup/restore options via the CLI.

### Starting the Setup

Upon running `setup.sh`, the CLI will offer the following options:

1. **Fresh Installation**: Select plugins and themes manually.

2. **Default Installation**: Apply pre-configured plugins and themes.

3. **Backup/Restore**: Manage `.zshrc` backups and restorations.

### Fresh Installation

This option allows you to select plugins and themes interactively, which will be installed and applied to your `.zshrc` configuration.

### Default Installation

This option installs a set of pre-configured plugins, such as `git`, `nvm`, `docker`, and applies the `spaceship` theme.

### Backup/Restore

This option lets you back up or restore your `.zshrc` file.

## Contributing

We welcome contributions! To contribute:

1. Fork the repository.

2. Create a feature branch.

3. Commit and push your changes.

4. Open a pull request.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.