sshpushpull 0.1.0a0__tar.gz → 0.1.0a1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sshpushpull
3
- Version: 0.1.0a0
3
+ Version: 0.1.0a1
4
4
  Summary: Dead simple, jargon-free Python tool to make a local TCP port available on a remote host or make a remote TCP port available locally.
5
5
  Author-email: Jifeng Wu <jifengwu2k@gmail.com>
6
6
  License-Expression: MIT
@@ -61,49 +61,62 @@ Both commands run in the foreground and auto-reconnect after transient network f
61
61
  ### Push: Expose a local port on a remote host
62
62
 
63
63
  ```
64
- sshpushpull push -l <local_port> -r <remote_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] [-x]
64
+ sshpushpull push \
65
+ --local-port <local_port> \
66
+ --remote-port <remote_port> \
67
+ --username <user> \
68
+ --host <host> \
69
+ [--port <ssh_port>] \
70
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] \
71
+ [--local-only]
65
72
  ```
66
73
 
67
74
  | Option | Description |
68
75
  |--------|-------------|
69
- | `-l`, `--local-port` | Local TCP port to push from |
70
- | `-r`, `--remote-port` | Remote TCP port to push to |
71
- | `-u`, `--username` | SSH username on the remote host |
72
- | `-h`, `--host` | Remote SSH host name or address |
76
+ | `--local-port` | Local TCP port to push from |
77
+ | `--remote-port` | Remote TCP port to push to |
78
+ | `--username` | SSH username on the remote host |
79
+ | `--host` | Remote SSH host name or address |
73
80
  | `--port` | SSH server port (default: 22) |
74
81
  | `--password` | Password for SSH authentication |
75
82
  | `--rsa-key` | Path to RSA private key for SSH authentication |
76
83
  | `--ed25519-key` | Path to Ed25519 private key for SSH authentication |
77
- | `-x` | Open remote port on localhost only (default: open on all interfaces) |
84
+ | `--local-only` | Open remote port on localhost only (default: open on all interfaces) |
78
85
 
79
86
  **Examples:**
80
87
 
81
88
  ```bash
82
89
  # Make local port 3000 available on dev.example.com:3001 using password auth
83
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --password secret
90
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --password secret
84
91
 
85
92
  # Using an Ed25519 key
86
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519
93
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519
87
94
 
88
95
  # If SSH is running on port 2222
89
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
96
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
90
97
 
91
98
  # Only allow access from the remote host's own localhost
92
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519 -x
99
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519 --local-only
93
100
  ```
94
101
 
95
102
  ### Pull: Access a remote port locally
96
103
 
97
104
  ```
98
- sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
105
+ sshpushpull pull \
106
+ --remote-port <remote_port> \
107
+ --local-port <local_port> \
108
+ --username <user> \
109
+ --host <host> \
110
+ [--port <ssh_port>] \
111
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
99
112
  ```
100
113
 
101
114
  | Option | Description |
102
115
  |--------|-------------|
103
- | `-r`, `--remote-port` | Remote TCP port to pull from |
104
- | `-l`, `--local-port` | Local TCP port to pull to |
105
- | `-u`, `--username` | SSH username on the remote host |
106
- | `-h`, `--host` | Remote SSH host name or address |
116
+ | `--remote-port` | Remote TCP port to pull from |
117
+ | `--local-port` | Local TCP port to pull to |
118
+ | `--username` | SSH username on the remote host |
119
+ | `--host` | Remote SSH host name or address |
107
120
  | `--port` | SSH server port (default: 22) |
108
121
  | `--password` | Password for SSH authentication |
109
122
  | `--rsa-key` | Path to RSA private key for SSH authentication |
@@ -113,13 +126,13 @@ sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <s
113
126
 
114
127
  ```bash
115
128
  # Access remote port 3306 (database) through local port 3307
116
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --password secret
129
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --password secret
117
130
 
118
131
  # Using an Ed25519 key
119
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --ed25519-key ~/.ssh/id_ed25519
132
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --ed25519-key ~/.ssh/id_ed25519
120
133
 
121
134
  # If SSH is running on port 2222
122
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
135
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
123
136
  ```
124
137
 
125
138
  ## Foreground Operation: Visibility Over Stealth
@@ -42,49 +42,62 @@ Both commands run in the foreground and auto-reconnect after transient network f
42
42
  ### Push: Expose a local port on a remote host
43
43
 
44
44
  ```
45
- sshpushpull push -l <local_port> -r <remote_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] [-x]
45
+ sshpushpull push \
46
+ --local-port <local_port> \
47
+ --remote-port <remote_port> \
48
+ --username <user> \
49
+ --host <host> \
50
+ [--port <ssh_port>] \
51
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] \
52
+ [--local-only]
46
53
  ```
47
54
 
48
55
  | Option | Description |
49
56
  |--------|-------------|
50
- | `-l`, `--local-port` | Local TCP port to push from |
51
- | `-r`, `--remote-port` | Remote TCP port to push to |
52
- | `-u`, `--username` | SSH username on the remote host |
53
- | `-h`, `--host` | Remote SSH host name or address |
57
+ | `--local-port` | Local TCP port to push from |
58
+ | `--remote-port` | Remote TCP port to push to |
59
+ | `--username` | SSH username on the remote host |
60
+ | `--host` | Remote SSH host name or address |
54
61
  | `--port` | SSH server port (default: 22) |
55
62
  | `--password` | Password for SSH authentication |
56
63
  | `--rsa-key` | Path to RSA private key for SSH authentication |
57
64
  | `--ed25519-key` | Path to Ed25519 private key for SSH authentication |
58
- | `-x` | Open remote port on localhost only (default: open on all interfaces) |
65
+ | `--local-only` | Open remote port on localhost only (default: open on all interfaces) |
59
66
 
60
67
  **Examples:**
61
68
 
62
69
  ```bash
63
70
  # Make local port 3000 available on dev.example.com:3001 using password auth
64
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --password secret
71
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --password secret
65
72
 
66
73
  # Using an Ed25519 key
67
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519
74
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519
68
75
 
69
76
  # If SSH is running on port 2222
70
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
77
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
71
78
 
72
79
  # Only allow access from the remote host's own localhost
73
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519 -x
80
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519 --local-only
74
81
  ```
75
82
 
76
83
  ### Pull: Access a remote port locally
77
84
 
78
85
  ```
79
- sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
86
+ sshpushpull pull \
87
+ --remote-port <remote_port> \
88
+ --local-port <local_port> \
89
+ --username <user> \
90
+ --host <host> \
91
+ [--port <ssh_port>] \
92
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
80
93
  ```
81
94
 
82
95
  | Option | Description |
83
96
  |--------|-------------|
84
- | `-r`, `--remote-port` | Remote TCP port to pull from |
85
- | `-l`, `--local-port` | Local TCP port to pull to |
86
- | `-u`, `--username` | SSH username on the remote host |
87
- | `-h`, `--host` | Remote SSH host name or address |
97
+ | `--remote-port` | Remote TCP port to pull from |
98
+ | `--local-port` | Local TCP port to pull to |
99
+ | `--username` | SSH username on the remote host |
100
+ | `--host` | Remote SSH host name or address |
88
101
  | `--port` | SSH server port (default: 22) |
89
102
  | `--password` | Password for SSH authentication |
90
103
  | `--rsa-key` | Path to RSA private key for SSH authentication |
@@ -94,13 +107,13 @@ sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <s
94
107
 
95
108
  ```bash
96
109
  # Access remote port 3306 (database) through local port 3307
97
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --password secret
110
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --password secret
98
111
 
99
112
  # Using an Ed25519 key
100
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --ed25519-key ~/.ssh/id_ed25519
113
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --ed25519-key ~/.ssh/id_ed25519
101
114
 
102
115
  # If SSH is running on port 2222
103
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
116
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
104
117
  ```
105
118
 
106
119
  ## Foreground Operation: Visibility Over Stealth
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sshpushpull"
7
- version = "0.1.0a0"
7
+ version = "0.1.0a1"
8
8
  description = "Dead simple, jargon-free Python tool to make a local TCP port available on a remote host or make a remote TCP port available locally."
9
9
  readme = "README.md"
10
10
  requires-python = ">=2"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sshpushpull
3
- Version: 0.1.0a0
3
+ Version: 0.1.0a1
4
4
  Summary: Dead simple, jargon-free Python tool to make a local TCP port available on a remote host or make a remote TCP port available locally.
5
5
  Author-email: Jifeng Wu <jifengwu2k@gmail.com>
6
6
  License-Expression: MIT
@@ -61,49 +61,62 @@ Both commands run in the foreground and auto-reconnect after transient network f
61
61
  ### Push: Expose a local port on a remote host
62
62
 
63
63
  ```
64
- sshpushpull push -l <local_port> -r <remote_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] [-x]
64
+ sshpushpull push \
65
+ --local-port <local_port> \
66
+ --remote-port <remote_port> \
67
+ --username <user> \
68
+ --host <host> \
69
+ [--port <ssh_port>] \
70
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>] \
71
+ [--local-only]
65
72
  ```
66
73
 
67
74
  | Option | Description |
68
75
  |--------|-------------|
69
- | `-l`, `--local-port` | Local TCP port to push from |
70
- | `-r`, `--remote-port` | Remote TCP port to push to |
71
- | `-u`, `--username` | SSH username on the remote host |
72
- | `-h`, `--host` | Remote SSH host name or address |
76
+ | `--local-port` | Local TCP port to push from |
77
+ | `--remote-port` | Remote TCP port to push to |
78
+ | `--username` | SSH username on the remote host |
79
+ | `--host` | Remote SSH host name or address |
73
80
  | `--port` | SSH server port (default: 22) |
74
81
  | `--password` | Password for SSH authentication |
75
82
  | `--rsa-key` | Path to RSA private key for SSH authentication |
76
83
  | `--ed25519-key` | Path to Ed25519 private key for SSH authentication |
77
- | `-x` | Open remote port on localhost only (default: open on all interfaces) |
84
+ | `--local-only` | Open remote port on localhost only (default: open on all interfaces) |
78
85
 
79
86
  **Examples:**
80
87
 
81
88
  ```bash
82
89
  # Make local port 3000 available on dev.example.com:3001 using password auth
83
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --password secret
90
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --password secret
84
91
 
85
92
  # Using an Ed25519 key
86
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519
93
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519
87
94
 
88
95
  # If SSH is running on port 2222
89
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
96
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --port 2222 --rsa-key ~/.ssh/id_rsa
90
97
 
91
98
  # Only allow access from the remote host's own localhost
92
- sshpushpull push -l 3000 -r 3001 -u dev -h dev.example.com --ed25519-key ~/.ssh/id_ed25519 -x
99
+ sshpushpull push --local-port 3000 --remote-port 3001 --username dev --host dev.example.com --ed25519-key ~/.ssh/id_ed25519 --local-only
93
100
  ```
94
101
 
95
102
  ### Pull: Access a remote port locally
96
103
 
97
104
  ```
98
- sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <ssh_port>] [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
105
+ sshpushpull pull \
106
+ --remote-port <remote_port> \
107
+ --local-port <local_port> \
108
+ --username <user> \
109
+ --host <host> \
110
+ [--port <ssh_port>] \
111
+ [--password <pwd> | --rsa-key <path> | --ed25519-key <path>]
99
112
  ```
100
113
 
101
114
  | Option | Description |
102
115
  |--------|-------------|
103
- | `-r`, `--remote-port` | Remote TCP port to pull from |
104
- | `-l`, `--local-port` | Local TCP port to pull to |
105
- | `-u`, `--username` | SSH username on the remote host |
106
- | `-h`, `--host` | Remote SSH host name or address |
116
+ | `--remote-port` | Remote TCP port to pull from |
117
+ | `--local-port` | Local TCP port to pull to |
118
+ | `--username` | SSH username on the remote host |
119
+ | `--host` | Remote SSH host name or address |
107
120
  | `--port` | SSH server port (default: 22) |
108
121
  | `--password` | Password for SSH authentication |
109
122
  | `--rsa-key` | Path to RSA private key for SSH authentication |
@@ -113,13 +126,13 @@ sshpushpull pull -r <remote_port> -l <local_port> -u <user> -h <host> [--port <s
113
126
 
114
127
  ```bash
115
128
  # Access remote port 3306 (database) through local port 3307
116
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --password secret
129
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --password secret
117
130
 
118
131
  # Using an Ed25519 key
119
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --ed25519-key ~/.ssh/id_ed25519
132
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --ed25519-key ~/.ssh/id_ed25519
120
133
 
121
134
  # If SSH is running on port 2222
122
- sshpushpull pull -r 3306 -l 3307 -u admin -h db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
135
+ sshpushpull pull --remote-port 3306 --local-port 3307 --username admin --host db.internal --port 2222 --rsa-key ~/.ssh/id_rsa
123
136
  ```
124
137
 
125
138
  ## Foreground Operation: Visibility Over Stealth
File without changes
File without changes