# README
DOIT
[![Coverage Status]
(https://coveralls.io/repos/bryanl/doit/badge.svg?branch=master)]
(https://coveralls.io/r/bryanl/doit?branch=master)
Usage:
doit [command]
Available Commands:
account account commands
action action commands
auth auth commands
domain domain commands
droplet-action droplet action commands
droplet droplet commands
floating-ip floating IP commands
floating-ip-action floating IP action commands
image image commands
region region commands
size size commands
ssh-key sshkey commands
ssh ssh to droplet
Flags:
-t, --access-token="": DigtialOcean API V2 Access Token
-h, --help[=false]: help for doit
-o, --output="text": output formt [text|json]
Use "doit [command] --help" for more information about a command.
Initialization
Configuration
By default, doit
will load a configuration file from $HOME/.doitcfg
if found.
Configuration OPTIONS
access-token
- The DigitalOcean access token. You can generate a token in the Apps & API Of the DigitalOcean control panel.output
- Type of output to display results in. Choices arejson
ortext
. If not supplied,doit
will default totext
.
Example:
{
access-token: MY_TOKEN
output: text
}
Building and dependencies
doit
's dependencies are managed by godep. To add new packages, you must
run godep save ./...
to update the vendored dependencies. External dependencies have been rewritten using godep
.
# Functions
DisplayOutput displays an object or group of objects to a user.
No description provided by the author
NewLiveCommand creates a LiveCommand.
NewMissingArgsErr creates a MissingArgsErr instance.
NewMockCommand createsd a MockCommand.
PaginateResp paginates a Response.
# Constants
ArgActionID is an action id argument.
ArgBackups is an enable backups argument.
ArgDomainName is a domain name argument.
ArgDropletID is a droplet id argument.
ArgDropletName is a droplet name argument.
ArgDropletWait is a wait for a droplet to be created argument.
ArgImage is an image argument.
ArgImageID is an image id argument.
ArgImageName name is an image name argument.
ArgImagePublic is a public image argument.
ArgImageSlug is an image slug argment.
ArgIPAddress is an IP address argument.
ArgIPv6 is an enable IPv6 argument.
ArgKernelID is a ekrnel id argument.
ArgKey is a key argument.
ArgKeyName is a key name argument.
ArgKeyPublicKey is a public key argument.
ArgKeyPublicKeyFile is a public key file argument.
ArgOutput is an output type argument.
ArgPrivateNetworking is an enable private networking argument.
ArgRecordData is a record data argument.
ArgRecordID is a record id argument.
ArgRecordName is a record name argument.
ArgRecordPort is a record port argument.
ArgRecordPriority is a record priority argument.
ArgRecordType is a record type argument.
ArgRecordWeight is a record weight argument.
ArgRegionSlug is a region slug argument.
ArgResizeDisk is a resize disk argument.
ArgSizeSlug is a size slug argument.
ArgSnapshotName is a snapshot name arugment.
ArgSSHKeys is a ssh key argument.
ArgSSHUser is a SSH user argument.
ArgsSSHKeyPath is a ssh argument.
ArgsSSHPort is a ssh argument.
ArgUserData is a user data argument.
ArgUserDataFile is a user data file location argument.
NSRoot is a configuration key that signifies this value is at the root.
# Variables
DoitConfig holds the app's current configuration.
# Structs
AccountServiceMock mocks github.com/digitalocean/AccountService.
ActionsServiceMock mocks github.com/digitalocean/godo/ActionsService.
No description provided by the author
DomainsServiceMock mocks github.com/digitalocean/godo/DomainsService.
DropletActionsServiceMock mocks github.com/digitalocean/godo/DropletActionsServiceMock.
DropletsServiceMock mocks github.com/digitalocean/godo/DropletsService.
FloatingIPActionsServiceMock mocks github.com/digitalocean/godo/FloatingIPActionsService.
FloatingIPsServiceMock mocks github.com/digitalocean/godo/FloatingIPsService.
ImageActionsServiceMock mocks github.com/digitalocean/godo/ImagesActionsService.
ImagesServiceMock mocks github.com/digitalocean/godo/ImagesService.
KeysServiceMock mocks github.com/digitalocean/godo/KeysService.
LiveCommand is a live implementation of Command.
LiveConfig is an implementation of Config for live values.
MissingArgsErr is an error returned when their are too few arguments for a command.
MockCommand is a mock command implementation.
MockRunner is an implemenation of Runner for mocking.
RegionsServiceMock mocks github.com/digitalocean/godo/RegionsService.
SizesServiceMock mocks github.com/digitalocean/godo/SizesService.
TokenSource holds an oauth token.
# Type aliases
Generator is a function that generates the list to be paginated.