Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme fixes API2 #188

Merged
merged 2 commits into from
Oct 23, 2015
Merged

Readme fixes API2 #188

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bd9925
API 2.0 README updates
petems Oct 22, 2015
bdbe3e4
Removing for now
petems Oct 22, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 34 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,44 +148,61 @@ Print a single attribute.

### List Available Images

You can list images that you have created.
You can list all images

$ tugboat images
My Images:
pearkes-admin-001 2013-05-19 (id: 13231512, distro: Ubuntu)
Showing both private and public images
Private Images:
My application image (id: 6376601, distro: Ubuntu)

Public Images:
745.1.0 (alpha) (slug: coreos-alpha, id: 12789325, distro: CoreOS)
723.3.0 (beta) (slug: coreos-beta, id: 12789350, distro: CoreOS)
717.3.0 (stable) (slug: coreos-stable, id: 12789351, distro: CoreOS)
....

Optionally, list images provided by DigitalOcean as well.
Or just list images that you have created.

$ tugboat images --global
My Images:
pearkes-admin-001 2013-05-19 (id: 13231512, distro: Ubuntu)
$ tugboat images --show_just_private_images # or -p
Showing just private images
Private Images:
My application image (id: 6376601, distro: Ubuntu)
....
Global Images:
CentOS 5.8 x64 (id: 1601, distro: CentOS)
...

### List Available Sizes

$ tugboat sizes
Sizes:
512MB (id: 66)
1GB (id: 63)
Disk: 20GB, Memory: 512MB (slug: 512mb)
Disk: 30GB, Memory: 1024MB (slug: 1gb)
Disk: 40GB, Memory: 2048MB (slug: 2gb)
Disk: 60GB, Memory: 4096MB (slug: 4gb)
Disk: 80GB, Memory: 8192MB (slug: 8gb)
Disk: 160GB, Memory: 16384MB (slug: 16gb)
Disk: 320GB, Memory: 32768MB (slug: 32gb)
Disk: 480GB, Memory: 49152MB (slug: 48gb)
Disk: 640GB, Memory: 65536MB (slug: 64gb)
...

### List Available Regions

$ tugboat regions
Regions:
New York 1 (id: 1) (slug: nyc1)
Amsterdam 1 (id: 2) (slug: ams1)
San Francisco 1 (id: 3) (slug: sfo1)
Amsterdam 1 (slug: ams1)
Amsterdam 2 (slug: ams2)
Amsterdam 3 (slug: ams3)
London 1 (slug: lon1)
New York 1 (slug: nyc1)
New York 2 (slug: nyc2)
New York 3 (slug: nyc3)
San Francisco 1 (slug: sfo1)
Singapore 1 (slug: sgp1)

### List SSH Keys

$ tugboat keys
Keys:
pearkes (id: 10501)
Name: pearkes, (id: 231192), fingerprint: 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa
...

### Wait for Droplet State
Expand Down Expand Up @@ -213,7 +230,6 @@ For a complete overview of all of the available commands, run:

$ tugboat help


Depending on your local configuration, you may need to install a CA bundle (OS X only) using [homebrew](http://brew.sh/) to communicate with DigitalOcean through SSL/TLS:

$ brew install curl-ca-bundle
Expand All @@ -226,12 +242,8 @@ After installation, source the bundle path in your `.bash_profile`/`.bashrc`:

Yes, please!

It's very helpful if you can run `DEBUG=1 tugboat ...` with the command
that is causing you issues, and then include that in the issue.

You can create a new issue [here](https://github.com/pearkes/tugboat/issues/new). Thank you!

## Contributing

See the [contributing guide](CONTRIBUTING.md).

See the [contributing guide](CONTRIBUTING.md).