Skip to content

Scripts to automate the setup of development terminal - WezTerm on macOS, features include proxy configuration, Homebrew installation, WezTerm setup, Starship prompt configuration, and Zsh plugin installation.

License

Notifications You must be signed in to change notification settings

riverify/wezterm-autoconfig

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WezTerm Autoconfig

License

🌐 Languages: English | 简体中文 | 日本語

This project provides a script to configure my development environment with various tools and settings. I provide a easy way for you to configure your environment with the same tools and settings just like the picture below.

Features

  • Language Selection: Choose between English, Simplified Chinese, and Japanese for the configuration script.
  • Zsh Configuration: Automatically configures .zshrc with:
    • Starship prompt
    • zsh-syntax-highlighting
    • zsh-autosuggestions
    • Proxy settings
    • Useful aliases
    • Greeting function

Prerequisites

  • macOS: The scripts are designed to run on macOS. But you can still use it on other systems with some modifications. Try it at your own risk.
  • Remove Existing Configurations: Before running the script, better to remove existing Starship and WezTerm configurations, it is okay if you don't, you will have to see what you want to keep.
  • Smooth Internet: The script will download and install various tools and packages, so a good internet connection is a must.

Once you have done the little things above, you can start to install the script immediately.

Installation

There are two ways to install the script:

Method 1: Using curl (Recommended)

  1. Run the following command in your terminal:
    sh -c "$(curl -fsSL https://raw.githubusercontent.com/riverify/wezterm-autoconfig/main/autoconfig_curl.sh)"
  2. The script will automatically configure your environment.
  3. If you encounter any issues, please let me know by creating an issue.

Method 2: Using git

  1. Clone the repository:

    git clone https://github.com/riverify/wezterm-autoconfig.git
    cd wezterm-autoconfig
  2. Make the main script executable:

    chmod +x autoconfig.sh
  3. Run the script:

    ./autoconfig.sh

Usage

  1. When prompted, select your preferred language:

    Please select a language:
    1) English
    2) 简体中文
    3) 日本語
    Press Enter to use English by default.
    
  2. The script will automatically configure your environment based on your selection.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

Contributing

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes.
  4. Commit your changes (git commit -am 'Add new feature').
  5. Push to the branch (git push origin feature-branch).
  6. Create a new Pull Request.

Acknowledgements

About

Scripts to automate the setup of development terminal - WezTerm on macOS, features include proxy configuration, Homebrew installation, WezTerm setup, Starship prompt configuration, and Zsh plugin installation.

Topics

Resources

License

Stars

Watchers

Forks