https://github.com/sukkaw/zsh-osx-autoproxy

An oh-my-zsh plugin that configures proxy environment variables based on macOS's system preferences automatically
https://github.com/sukkaw/zsh-osx-autoproxy

oh-my-zsh oh-my-zsh-plugin proxy-configuration zsh zsh-plugin

Last synced: 12 days ago
JSON representation

An oh-my-zsh plugin that configures proxy environment variables based on macOS's system preferences automatically

• Host: GitHub
• URL: https://github.com/sukkaw/zsh-osx-autoproxy
• Owner: SukkaW
• License: mit
• Created: 2020-11-30T18:17:00.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-05T01:35:57.000Z (over 3 years ago)
• Last Synced: 2025-01-19T13:55:58.012Z (13 days ago)
• Topics: oh-my-zsh, oh-my-zsh-plugin, proxy-configuration, zsh, zsh-plugin
• Language: Shell
• Homepage:
• Size: 3.91 KB
• Stars: 112
• Watchers: 4
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zsh-osx-autoproxy

[![Author](https://img.shields.io/badge/Author-Sukka-b68469.svg?style=flat-square)](https://skk.moe)

[![License](https://img.shields.io/github/license/sukkaw/zsh-osx-autoproxy.svg?style=flat-square)](./LICENSE)

:nut_and_bolt: An [`oh-my-zsh`](https://ohmyz.sh/) plugin that configures proxy environment variables based on macOS's system preferences automatically.

## Installation

### oh-my-zsh

1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)

```bash

git clone https://github.com/sukkaw/zsh-osx-autoproxy ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-osx-autoproxy

```

2. Add the plugin to the list of plugins for oh-my-zsh to load (inside `~/.zshrc`):

```

plugins=(

    [plugins

     ...]

    zsh-osx-autoproxy

)

```

3. Start a new terminal session.

### Antigen

[Antigen](https://github.com/zsh-users/antigen) is a zsh plugin manager, and it support `oh-my-zsh` plugin as well. You only need to add `antigen bundle sukkaw/zsh-osx-autoproxy` to your `.zshrc` with your other bundle commands if you are using Antigen. Antigen will handle cloning the plugin for you automatically the next time you start zsh. You can also add the plugin to a running zsh with `antigen bundle sukkaw/zsh-osx-autoproxy` for testing before adding it to your `.zshrc`.

## Usage

After install the plugin and have proxy configured in `System Prefrences`, start a new terminal session and following environment variables will be set (if applicable):

- `http_proxy`

- `https_proxy`

- `ftp_proxy`

- `all_proxy`

## Uninstallation

**If you install `zsh-osx-autoproxy` with Antigen**, you need to remove `antigen bundle sukkaw/zsh-osx-autoproxy` to disable the plugin.

**If you install `zsh-osx-autoproxy` with oh-myzsh**, you need to remove `zsh-osx-autoproxy` item from plugin array, then `rm -rf ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-osx-autoproxy` to remove the plugin.

## Author

**zsh-osx-autoproxy** © [Sukka](https://github.com/SukkaW), Released under the [MIT](./LICENSE) License.


Authored and maintained by Sukka with help from contributors ([list](https://github.com/SukkaW/zsh-osx-autoproxy/graphs/contributors)).

> [Personal Website](https://skk.moe) · [Blog](https://blog.skk.moe) · GitHub [@SukkaW](https://github.com/SukkaW) · Telegram Channel [@SukkaChannel](https://t.me/SukkaChannel) · Twitter [@isukkaw](https://twitter.com/isukkaw) · Keybase [@sukka](https://keybase.io/sukka)