Marc Cornellà 4fcf52c2b1 fix: don't use `$functions_source` for compatibility with zsh < 5.4 1 year ago
..
.editorconfig 9fa3f46122 fix(shell-proxy): make ssh-proxy compatible with macOS (#10640) 2 years ago
README.md e96b8bd523 refactor(shell-proxy)!: rename env vars to `SHELLPROXY_*` and add usage message (#10456) 2 years ago
proxy.py e96b8bd523 refactor(shell-proxy)!: rename env vars to `SHELLPROXY_*` and add usage message (#10456) 2 years ago
shell-proxy.plugin.zsh 4fcf52c2b1 fix: don't use `$functions_source` for compatibility with zsh < 5.4 1 year ago
ssh-agent.py d57131dc49 fix(shell-proxy): change NAME env variable for WSL clash (#9447) 3 years ago
ssh-proxy.py 9fa3f46122 fix(shell-proxy): make ssh-proxy compatible with macOS (#10640) 2 years ago

README.md

shell-proxy plugin

This a pure user-space program, shell-proxy setter, written in Python3 and Zsh.

To use it, add shell-proxy to the plugins array in your zshrc file:

plugins=(... shell-proxy)

Key features

  • Supports macOS and Linux (Ubuntu, Archlinux, etc.)
  • Supports git via setting $GIT_SSH
  • Supports ssh, sftp, scp, slogin and ssh-copy-id via setting aliases
  • Built-in autocomplete

Usage

Method 1

Set SHELLPROXY_URL environment variable to the URL of the proxy server:

SHELLPROXY_URL="http://127.0.0.1:8123"
proxy enable

Method 2

Write a program file in $HOME/.config/proxy so that the proxy URL is defined dynamically. Note that the program file must be executable.

Example:

#!/bin/bash

if [[ "$(uname)" = Darwin ]]; then
  echo "http://127.0.0.1:6152" # Surge Mac
else
  echo "http://127.0.0.1:8123" # polipo
fi

Method 3

Use method 2 but define the location of the program file by setting the SHELLPROXY_CONFIG environment variable:

SHELLPROXY_CONFIG="$HOME/.dotfiles/proxy-config"

Reference

Maintainer