qucli

README

qcli

Description

Manage repository in Quay

Table of Contents

• Requirements
• Installation
  • Using Homebrew (OS X only)
  • Precompiled binary
  • From source
  • Run in a Docker container
• Usage
  • Options
• Development
• Author
• License

Requirements

• Enviroment QUAY_API_TOKEN
• Get Api Token. Applications and Tokens

$ export QUAY_API_TOKEN=foobar

Installation

Using Homebrew (OS X only)

Formula is available at koudaiii/homebrew-tools.

$ brew tap koudaiii/tools
$ brew install qcli

Precompiled binary

Precompiled binaries for Windows, OS X, Linux are available at Releases.

From source

To install, use go get:

$ go get -d github.com/koudaiii/qcli
$ cd $GOPATH/src/github.com/koudaiii/qcli
$ make deps
$ make install

Run in a Docker container

docker image is available at quay.io/koudaiii/qcli.

# -t is required to colorize logs
$ docker run \
    --rm \
    -t \
    -e QUAY_API_TOKEN=foobar \
    quay.io/koudaiii/qcli:latest

Usage

usage: qcli [--version] [--help] <command> [<args>]

Available commands are:
    add-team       Add team in repository
    add-user       Add user in repository
    create         Create repository in Quay
    delete         Delete repository in Quay
    delete-team    Delete team in repository
    delete-user    Delete user in repository
    get            Get repository and Permissions in Quay
    list           List repository and Permissions in Quay
    version        Print qcli version and quit

list

List repository in namespace

With --is-public option, you can true or false

$ qcli list koudaiii
NAME				isPublic	DESCRIPTION
quay.io/koudaiii/apig-sample	true
quay.io/koudaiii/qcli	true
quay.io/koudaiii/kubeps		true
quay.io/koudaiii/test		true

get

Get repository and Permissions in Quay

$ qcli get wantedly/test
Repository:
	quay.io/wantedly/test
Visibility:
	private
Permissions:
	koudaiii(admin)

create

Create repository in Quay

With --visibility option, you can public or private

$ qcli create wantedly/test --visibility private
Created! quay.io/wantedly/test

delete

Delete repository in Quay

$ qcli delete wantedly/test
Deleted! quay.io/wantedly/test

$ qcli get wantedly/test
err: HTTP error!
URL: https://quay.io/api/v1/repository/wantedly/test
status code: 404
body:
{"status": 404, "error_message": "Not Found", "title": "not_found", "error_type": "not_found", "detail": "Not Found", "type": "https://quay.io/api/v1/error/not_found"}

add-user

Add user in repository

With --role option, you can read or write or admin

$ qcli add-user wantedly/test dtan4 --role write
Added! dtan4(write) in quay.io/wantedly/test

$ qcli get wantedly/test
Repository:
	quay.io/wantedly/test
Visibility:
	private
Permissions:
	koudaiii(admin)
	dtan4(write)

add-team

Add team in repository

With --role option, you can read or write or admin

$ qcli add-team wantedly/test infrastructure --role write
Added! infrastructure(write) in quay.io/wantedly/test

$ qcli get wantedly/test
Repository:
	quay.io/wantedly/test
Visibility:
	private
Permissions:
	koudaiii(admin)
	dtan4(write)
	infrastructure(write)

delete-user

Delete user from repository

$ qcli delete-user wantedly/test dtan4
Deleted! dtan4 in quay.io/wantedly/test

$ qcli get wantedly/test
Repository:
	quay.io/wantedly/test
Visibility:
	private
Permissions:
	koudaiii(admin)
	infrastructure(write)

delete-team

Delete team from repository

$ qcli delete-team wantedly/test infrastructure
Deleted! infrastructure in quay.io/wantedly/test

$ qcli get wantedly/test
Repository:
	quay.io/wantedly/test
Visibility:
	private
Permissions:
	koudaiii(admin)

Options

Option	Description	Required	Default
--visibility=VISIBILITY	"visibility set to 'public' or 'private'		public
--role=ROLE	role to use for the user or team = ['read', 'write', 'admin']		read
--is-public=bool	repository type is public. true or false		true
--help	Print command line usage
-v, --version	Print version

Development

Clone this repository and build using make.

$ go get -d github.com/koudaiii/qcli
$ cd $GOPATH/src/github.com/koudaiii/qcli
$ make

Contribution

1. Fork (https://github.com/koudaiii/qcli/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create a new Pull Request

Author

koudaiii

License