{"id":13512386,"url":"https://github.com/SukkaW/zsh-proxy","last_synced_at":"2025-03-30T22:32:36.957Z","repository":{"id":34672118,"uuid":"167003032","full_name":"SukkaW/zsh-proxy","owner":"SukkaW","description":":nut_and_bolt: An oh-my-zsh plugin to configure proxy","archived":false,"fork":false,"pushed_at":"2024-03-19T07:57:20.000Z","size":24,"stargazers_count":385,"open_issues_count":7,"forks_count":61,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-28T19:47:57.212Z","etag":null,"topics":["oh-my-zsh","oh-my-zsh-plugin","proxy","zsh"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SukkaW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-22T13:55:51.000Z","updated_at":"2025-03-28T09:39:28.000Z","dependencies_parsed_at":"2024-01-03T04:17:48.327Z","dependency_job_id":"fc3f608c-0c1f-49cb-9615-9fdebe4d44a5","html_url":"https://github.com/SukkaW/zsh-proxy","commit_stats":{"total_commits":31,"total_committers":9,"mean_commits":"3.4444444444444446","dds":0.3870967741935484,"last_synced_commit":"2ec61be1b0b97c36cb008b780eccc5f407d9d0cd"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fzsh-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fzsh-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fzsh-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SukkaW%2Fzsh-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SukkaW","download_url":"https://codeload.github.com/SukkaW/zsh-proxy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246150433,"owners_count":20731419,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oh-my-zsh","oh-my-zsh-plugin","proxy","zsh"],"created_at":"2024-08-01T03:01:48.256Z","updated_at":"2025-03-30T22:32:31.946Z","avatar_url":"https://github.com/SukkaW.png","language":"Shell","readme":"# zsh-proxy\n\n[![Author](https://img.shields.io/badge/Author-Sukka-b68469.svg?style=flat-square)](https://skk.moe)\n[![License](https://img.shields.io/github/license/sukkaw/zsh-proxy.svg?style=flat-square)](./LICENSE)\n\n:nut_and_bolt: An [`oh-my-zsh`](https://ohmyz.sh/) plugin to configure proxy for some packages manager and software.\n\n## Installation\n\n### oh-my-zsh\n\nFirstly, clone this repository in `oh-my-zsh`'s plugins directory.\n\n```bash\ngit clone https://github.com/sukkaw/zsh-proxy.git ~/.oh-my-zsh/custom/plugins/zsh-proxy\n```\n\nSecondly, activate the plugin in `~/.zshrc`. Enable it by adding `zsh-proxy` to the [plugins array](https://github.com/robbyrussell/oh-my-zsh/blob/master/templates/zshrc.zsh-template#L66).\n\n```\nplugins=(\n    [plugins\n     ...]\n    zsh-proxy\n)\n```\n\n### Antigen\n\n[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-proxy` 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-proxy` for testing before adding it to your `.zshrc`.\n\n----\n\nCongratulations! Open a new terminal or run `source $HOME/.zshrc`. If you see following lines, you have successfully installed `zsh-proxy`:\n\n```\n----------------------------------------\nYou should run following command first:\n$ init_proxy\n----------------------------------------\n```\n\n## Usage\n\n### `init_proxy`\n\nThe tip mentioned below will show up next time you open a new terminal if you haven't  initialized the plugin with `init_proxy`.\n\nAfter you run `init_proxy`, it is time to configure the plugin.\n\n### `config_proxy`\n\nExecute `config_proxy` will lead you to zsh-proxy configuration. Fill in socks5 \u0026 http proxy address in format `address:port` like `127.0.0.1:1080` \u0026 `127.0.0.1:8080`.\n\nDefault configuration of socks5 proxy is `127.0.0.1:1080`, and http proxy is `127.0.0.1:8080`. You can leave any of them blank during configuration to use their default configuration.\n\nCurrently `zsh-proxy` doesn't support proxy with authentication, but I am working on it.\n\n### `proxy`\n\nAfter you configure the `zsh-proxy`, you are good to go. Try following command will enable proxy for supported package manager \u0026 software:\n\n```bash\n$ proxy\n```\n\nAnd next time you open a new terminal, zsh-proxy will automatically enable proxy for you.\n\n### `noproxy`\n\nIf you want to disable proxy, you can run following command:\n\n```bash\n$ noproxy\n```\n\n### `myip`\n\nIf you forget whether you have enabled proxy or not, it is fine to run `proxy` command directly, as `proxy` will reset all the proxy before enable them. But the smarter way is to use following command to check which IP you are using now:\n\n```bash\n$ myip\n```\n\nCheck procedure will use `curl` and the IP data come from `ipip.net`, `ip.cn` \u0026 `ip.gs`.\n\n## Uninstallation\n\n**If you install `zsh-proxy` with Antigen**, you need to remove `antigen bundle sukkaw/zsh-proxy` to disable the plugin.\n**If you install `zsh-proxy` with oh-myzsh**, you need to remove `zsh-proxy` item from plugin array, then run `rm -rf ~/.oh-my-zsh/custom/plugins/zsh-proxy` to remove the plugin.\n\nAnd you can clean up files \u0026 folders created by `zsh-proxy` using following command:\n\n```bash\n$ rm -rf ~/.zsh-proxy\n```\n\n## Supported\n\n`zsh-proxy` currently support those package manager \u0026 software:\n\n- `http_proxy`\n- `https_proxy`\n- `ftp_proxy`\n- `rsync_proxy`\n- `all_proxy`\n- git (http)\n- npm \u0026 yarn\n- apt\n\n## Todo List\n\n- socks5 \u0026 http proxy with authentication.\n- check whether the program exist before enable proxy for it\n- proxy for sudo user (`env_keep` or sorts of things)\n- proxy for:\n  - yum\n  - pip\n  - gradle\n  - git with ssh\n  - gem\n- `no_proxy` config\n- learn some from [arch wiki](https://wiki.archlinux.org/index.php/Proxy_server)\n\n## Author\n\n**zsh-proxy** © [Sukka](https://github.com/SukkaW), Released under the [MIT](https://github.com/SukkaW/zsh-proxy/blob/master/LICENSE) License.\u003cbr\u003e\nAuthored and maintained by Sukka with help from contributors ([list](https://github.com/SukkaW/zsh-proxy/graphs/contributors)).\n\n\u003e [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)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/sponsors/SukkaW/\"\u003e\n    \u003cimg src=\"https://sponsor.cdn.skk.moe/sponsors.svg\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","funding_links":["https://github.com/sponsors/SukkaW/"],"categories":["Plugins","Shell"],"sub_categories":["ZSH on Windows","Zinit (née zplugin)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSukkaW%2Fzsh-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSukkaW%2Fzsh-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSukkaW%2Fzsh-proxy/lists"}