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

updates help output in documentation #87

Closed
wants to merge 1 commit into from
Closed

updates help output in documentation #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 23 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,28 @@
![Travis Build Status](https://travis-ci.org/bryanl/doit.svg?branch=master)

```
doctl is a command line interface for the DigitalOcean API.

Usage:
doctl [command]

Available Commands:
account account commands
auth auth commands
compute compute commands
version show the current version

Flags:
-t, --access-token string DigitalOcean API V2 Access Token
-h, --help help for doctl
-o, --output string output format [text|json] (default "text")
-v, --verbose verbose output

Use "doctl [command] --help" for more information about a command.
NAME:
doctl - Digital Ocean Control TooL.

USAGE:
doctl [global options] command [command options] [arguments...]

COMMANDS:
account, whoami Account commands.
action, a Action commands.
domain, dns Domain commands.
droplet, d Droplet commands. Lists by default.
region Region commands.
size Size commands.
sshkey, ssh, keys SSH Key commands.
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--api-key, -k API Key for DO APIv2. [$DIGITALOCEAN_API_KEY, $ DIGITAL_OCEAN_API_KEY]
--format, -f "yaml" Format for output.
--debug, -d Turn on debug output.
--help, -h show help
--version, -v print the version
```

## Installation
Expand Down Expand Up @@ -143,4 +147,4 @@ repository is required.

[tutorial]: https://www.digitalocean.com/community/tutorials/how-to-use-doctl-the-official-digitalocean-command-line-client
[doctl-releases]: https://github.com/digitalocean/doctl/releases
[windows-release]: https://github.com/digitalocean/doctl/releases/download/v1.1.0/doctl-1.1.0-windows-4.0-amd64.zip
[windows-release]: https://github.com/digitalocean/doctl/releases/download/v1.1.0/doctl-1.1.0-windows-4.0-amd64.zip