quay / quayctl

quayctl is a command-line client for Quay
Apache License 2.0
91 stars 17 forks source link

quayctl UX review #38

Closed philips closed 8 years ago

philips commented 8 years ago

@meghanschofield @robszumski can y'all take a look at the current UX on the CLI tool and give any feedback? We need to add rkt support which will make the UX more complex too. The current idea is that:

 quayctl torrent pull quay.io/coreos/clair

becomes

 quayctl rkt torrent pull quay.io/coreos/clair
 quayctl docker torrent pull quay.io/coreos/clair
robszumski commented 8 years ago

Just took a look at this. A few random things first,

  1. Squashed doesn't work ./quayctl torrent pull quay.io/aptible/ubuntu --squashed was giving a 406. Filed #44
  2. The interaction with docker is kinda vague. This line could be more descriptive. What is it doing? 2016/03/31 20:21:56 Connecting to docker

Regarding the rkt/docker support, what we have seems most logical, but I'll throw out this for discussion:

$ quayctl torrent pull rkt://quay.io/coreos/clair
$ quayctl torrent pull docker://quay.io/coreos/clair

Side note, is there a reason to not default quayctl pull to always do torrent unless --direct-download or similar?

robszumski commented 8 years ago

If we swap the order to be container runtime first, then pull, it will match the direct runtime commands as well. So we can say, just put quayctl in front of the command you normally run. This assumes we always due torrent by default:

$ quayctl rkt pull quay.io/coreos/clair
$ quayctl docker pull quay.io/coreos/clair
josephschorr commented 8 years ago

Yeah, the current plan is:

$ quayctl rkt torrent pull quay.io/coreos/clair
$ quayctl docker torrent pull quay.io/coreos/clair
josephschorr commented 8 years ago

@robszumski: The UX has been updated. PTAL

robszumski commented 8 years ago

The help content could be a little more clear:

$ ./quayctl -h
Various utilities for working with the Quay container registry

Usage:
  quayctl [flags]
  quayctl [command]

Available Commands:
  rkt         rkt
  docker      Docker Engine
  version     print the current version

Use "quayctl [command] --help" for more information about a command.

For rkt, what about:

Interact with a rkt/ACI registry for pushing/pulling containers with a torrent or HTTP.

And similar for docker:

Interact with a Docker registry for pushing/pulling containers with a torrent or HTTP.

robszumski commented 8 years ago

Related: https://github.com/coreos/quayctl/pull/49

josephschorr commented 8 years ago

@robszumski: Anything else for this issue?

robszumski commented 8 years ago

@josephschorr I don't think so