Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.02 KB

readme.md

File metadata and controls

43 lines (27 loc) · 1.02 KB

Shipyard CLI

CLI client for Shipyard

Note: This is under active development and is currently very limited in functionality.

Building

  • make

Usage

When you first run (and any time you want to change endpoints) you will need to run shipyard as follows:

./shipyard --username <shipyard-username> --key <shipyard-api-key> --url <shipyard-url>

You can also specify and optional --api-version option for a specify version of the Shipyard API.

Once you run as above, Shipyard will cache the credentials in $HOME/.shipyard.cfg. You can then run the Shipyard CLI without passing creds each time.

Show Help

./shipyard -h

Show Applications

./shipyard show-applications

Show Application Details

./shipyard show-applications --name <app-name>

Show Containers

./shipyard show-containers

Show Container Details

./shipyard show-applications --id <container-id>

Show Hosts

./shipyard show-hosts

Show Host Details

./shipyard show-hosts --name <short-name-of-host>