Skip to content

Commit dd90e10

Browse files
committed
update help text
1 parent 155907b commit dd90e10

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ tunnel at `localhost:5000` to the temporary registry on your remote host, withou
3232

3333
```bash
3434
$ docker-push-ssh --help
35-
usage: docker-push-ssh [-h] [-i SSH_IDENTITY_FILE] [-p SSH_PORT]
35+
usage: cli.py [-h] [-i SSH_IDENTITY_FILE] [-p SSH_PORT] [-r REGISTRY_PORT]
36+
[--prime-image PRIME_IMAGE]
3637
ssh_host docker_image [docker_image ...]
3738

3839
A utility to securely push a docker image from your local host to a remote
@@ -56,6 +57,10 @@ optional arguments:
5657
-r REGISTRY_PORT, --registry-port REGISTRY_PORT
5758
[optional] Remote registry port on ssh host to forward
5859
to. (Default is 5000)
60+
--prime-image PRIME_IMAGE
61+
[optional] [list] Base images with which to prime the
62+
registry from the remote host. Docker pull is
63+
performed on the remote host.
5964
```
6065

6166
## Examples

docker_push_ssh/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ def main():
228228
parser.add_argument("-r", "--registry-port", type=str,
229229
help="[optional] Remote registry port on ssh host to forward to. (Default is 5000)", default="5000")
230230

231-
parser.add_argument("--prime", help="[optional][list] Base images with which to prime the registry from the remote host. (docker pull is performed on the remote host)", action="append")
231+
parser.add_argument("--prime-image", help="[optional] [list] Base images with which to prime the registry from the remote host. Docker pull is performed on the remote host.", action="append")
232232

233233
args = parser.parse_args()
234234

@@ -239,7 +239,7 @@ def main():
239239
print("[REQUIRED] Ensure localhost:5000 is added to your insecure registries.")
240240

241241
success = pushImage(args.docker_image, args.ssh_host, sshIdentityFileAbsolutePath,
242-
args.ssh_port, args.prime, args.registry_port)
242+
args.ssh_port, args.prime_image, args.registry_port)
243243

244244
if not success:
245245
sys.exit(1)

0 commit comments

Comments
 (0)