Documentation ¶
Index ¶
- Variables
- func AddBoolFlag(cmd *Command, name, shorthand string, def bool, desc string, opts ...flagOpt)
- func AddIntFlag(cmd *Command, name, shorthand string, def int, desc string, opts ...flagOpt)
- func AddStringFlag(cmd *Command, name, shorthand, dflt, desc string, opts ...flagOpt)
- func AddStringSliceFlag(cmd *Command, name, shorthand string, def []string, desc string, ...)
- func AskForConfirm(message string) error
- func Execute()
- func RunAccountGet(c *CmdConfig) error
- func RunAccountRateLimit(c *CmdConfig) error
- func RunAuthInit(retrieveUserTokenFunc func() (string, error)) func(c *CmdConfig) error
- func RunAuthSwitch(c *CmdConfig) error
- func RunCDNCreate(c *CmdConfig) error
- func RunCDNDelete(c *CmdConfig) error
- func RunCDNFlushCache(c *CmdConfig) error
- func RunCDNGet(c *CmdConfig) error
- func RunCDNList(c *CmdConfig) error
- func RunCDNUpdateTTL(c *CmdConfig) error
- func RunCertificateCreate(c *CmdConfig) error
- func RunCertificateDelete(c *CmdConfig) error
- func RunCertificateGet(c *CmdConfig) error
- func RunCertificateList(c *CmdConfig) error
- func RunCmdActionGet(c *CmdConfig) error
- func RunCmdActionList(c *CmdConfig) error
- func RunCmdActionWait(c *CmdConfig) error
- func RunCmdTagCreate(c *CmdConfig) error
- func RunCmdTagDelete(c *CmdConfig) error
- func RunCmdTagGet(c *CmdConfig) error
- func RunCmdTagList(c *CmdConfig) error
- func RunCompletionBash(c *CmdConfig) error
- func RunCompletionZsh(c *CmdConfig) error
- func RunDomainCreate(c *CmdConfig) error
- func RunDomainDelete(c *CmdConfig) error
- func RunDomainGet(c *CmdConfig) error
- func RunDomainList(c *CmdConfig) error
- func RunDropletActionChangeKernel(c *CmdConfig) error
- func RunDropletActionDisableBackups(c *CmdConfig) error
- func RunDropletActionEnableBackups(c *CmdConfig) error
- func RunDropletActionEnableIPv6(c *CmdConfig) error
- func RunDropletActionEnablePrivateNetworking(c *CmdConfig) error
- func RunDropletActionGet(c *CmdConfig) error
- func RunDropletActionPasswordReset(c *CmdConfig) error
- func RunDropletActionPowerCycle(c *CmdConfig) error
- func RunDropletActionPowerOff(c *CmdConfig) error
- func RunDropletActionPowerOn(c *CmdConfig) error
- func RunDropletActionReboot(c *CmdConfig) error
- func RunDropletActionRebuild(c *CmdConfig) error
- func RunDropletActionRename(c *CmdConfig) error
- func RunDropletActionResize(c *CmdConfig) error
- func RunDropletActionRestore(c *CmdConfig) error
- func RunDropletActionShutdown(c *CmdConfig) error
- func RunDropletActionSnapshot(c *CmdConfig) error
- func RunDropletActions(c *CmdConfig) error
- func RunDropletBackups(c *CmdConfig) error
- func RunDropletCreate(c *CmdConfig) error
- func RunDropletDelete(c *CmdConfig) error
- func RunDropletGet(c *CmdConfig) error
- func RunDropletKernels(c *CmdConfig) error
- func RunDropletList(c *CmdConfig) error
- func RunDropletNeighbors(c *CmdConfig) error
- func RunDropletSnapshots(c *CmdConfig) error
- func RunDropletTag(c *CmdConfig) error
- func RunDropletUntag(c *CmdConfig) error
- func RunFirewallAddDroplets(c *CmdConfig) error
- func RunFirewallAddRules(c *CmdConfig) error
- func RunFirewallAddTags(c *CmdConfig) error
- func RunFirewallCreate(c *CmdConfig) error
- func RunFirewallDelete(c *CmdConfig) error
- func RunFirewallGet(c *CmdConfig) error
- func RunFirewallList(c *CmdConfig) error
- func RunFirewallListByDroplet(c *CmdConfig) error
- func RunFirewallRemoveDroplets(c *CmdConfig) error
- func RunFirewallRemoveRules(c *CmdConfig) error
- func RunFirewallRemoveTags(c *CmdConfig) error
- func RunFirewallUpdate(c *CmdConfig) error
- func RunFloatingIPActionsAssign(c *CmdConfig) error
- func RunFloatingIPActionsGet(c *CmdConfig) error
- func RunFloatingIPActionsUnassign(c *CmdConfig) error
- func RunFloatingIPCreate(c *CmdConfig) error
- func RunFloatingIPDelete(c *CmdConfig) error
- func RunFloatingIPGet(c *CmdConfig) error
- func RunFloatingIPList(c *CmdConfig) error
- func RunImageActionsGet(c *CmdConfig) error
- func RunImageActionsTransfer(c *CmdConfig) error
- func RunImagesDelete(c *CmdConfig) error
- func RunImagesGet(c *CmdConfig) error
- func RunImagesList(c *CmdConfig) error
- func RunImagesListApplication(c *CmdConfig) error
- func RunImagesListDistribution(c *CmdConfig) error
- func RunImagesListUser(c *CmdConfig) error
- func RunImagesUpdate(c *CmdConfig) error
- func RunKeyCreate(c *CmdConfig) error
- func RunKeyDelete(c *CmdConfig) error
- func RunKeyGet(c *CmdConfig) error
- func RunKeyImport(c *CmdConfig) error
- func RunKeyList(c *CmdConfig) error
- func RunKeyUpdate(c *CmdConfig) error
- func RunLoadBalancerAddDroplets(c *CmdConfig) error
- func RunLoadBalancerAddForwardingRules(c *CmdConfig) error
- func RunLoadBalancerCreate(c *CmdConfig) error
- func RunLoadBalancerDelete(c *CmdConfig) error
- func RunLoadBalancerGet(c *CmdConfig) error
- func RunLoadBalancerList(c *CmdConfig) error
- func RunLoadBalancerRemoveDroplets(c *CmdConfig) error
- func RunLoadBalancerRemoveForwardingRules(c *CmdConfig) error
- func RunLoadBalancerUpdate(c *CmdConfig) error
- func RunPluginList(c *CmdConfig) error
- func RunPluginRun(c *CmdConfig) error
- func RunProjectResourcesAssign(c *CmdConfig) error
- func RunProjectResourcesGet(c *CmdConfig) error
- func RunProjectResourcesList(c *CmdConfig) error
- func RunProjectsCreate(c *CmdConfig) error
- func RunProjectsDelete(c *CmdConfig) error
- func RunProjectsGet(c *CmdConfig) error
- func RunProjectsList(c *CmdConfig) error
- func RunProjectsUpdate(c *CmdConfig) error
- func RunRecordCreate(c *CmdConfig) error
- func RunRecordDelete(c *CmdConfig) error
- func RunRecordList(c *CmdConfig) error
- func RunRecordUpdate(c *CmdConfig) error
- func RunRegionList(c *CmdConfig) error
- func RunSSH(c *CmdConfig) error
- func RunSizeList(c *CmdConfig) error
- func RunSnapshotDelete(c *CmdConfig) error
- func RunSnapshotGet(c *CmdConfig) error
- func RunSnapshotList(c *CmdConfig) error
- func RunVolumeAttach(c *CmdConfig) error
- func RunVolumeCreate(c *CmdConfig) error
- func RunVolumeDelete(c *CmdConfig) error
- func RunVolumeDetach(c *CmdConfig) error
- func RunVolumeGet(c *CmdConfig) error
- func RunVolumeList(c *CmdConfig) error
- func RunVolumeResize(c *CmdConfig) error
- func RunVolumeSnapshot(c *CmdConfig) error
- type CmdConfig
- type CmdRunner
- type Command
- func Account() *Command
- func Actions() *Command
- func Auth() *Command
- func CDN() *Command
- func Certificate() *Command
- func CmdBuilder(parent *Command, cr CmdRunner, cliText, desc string, out io.Writer, ...) *Command
- func Completion() *Command
- func Domain() *Command
- func Droplet() *Command
- func DropletAction() *Command
- func Firewall() *Command
- func FloatingIP() *Command
- func FloatingIPAction() *Command
- func ImageAction() *Command
- func Images() *Command
- func LoadBalancer() *Command
- func Plugin() *Command
- func ProjectResourcesCmd() *Command
- func Projects() *Command
- func Region() *Command
- func SSH(parent *Command) *Command
- func SSHKeys() *Command
- func Size() *Command
- func Snapshot() *Command
- func Tags() *Command
- func Version() *Command
- func Volume() *Command
- func VolumeAction() *Command
- type UnknownSchemeError
Constants ¶
This section is empty.
Variables ¶
var ApiURL string
ApiURL holds the API URL to use.
var Context string
Context holds the current auth context
var DoitCmd = &Command{ Command: &cobra.Command{ Use: "doctl", Short: "doctl is a command line interface for the DigitalOcean API.", }, }
DoitCmd is the base command.
var ErrNoAccessToken = errors.New("no access token has been configured")
ErrNoAccessToken is an error for when there is no access token.
var ErrUnknownTerminal = errors.New("unknown terminal")
ErrUnknownTerminal signifies an unknown terminal. It is returned when doit can't ascertain the current terminal type with requesting an auth token.
var Output string
Output holds the global output format.
var Token string
Token holds the global authorization token.
var Trace bool
Trace toggles http tracing output.
var Verbose bool
Verbose toggles verbose output.
var Writer = os.Stdout
Writer is where output should be written to.
Functions ¶
func AddBoolFlag ¶ added in v1.0.0
AddBoolFlag adds a boolean flag to a command.
func AddIntFlag ¶ added in v1.0.0
AddIntFlag adds an integr flag to a command.
func AddStringFlag ¶ added in v1.0.0
AddStringFlag adds a string flag to a command.
func AddStringSliceFlag ¶ added in v1.0.0
func AddStringSliceFlag(cmd *Command, name, shorthand string, def []string, desc string, opts ...flagOpt)
AddStringSliceFlag adds a string slice flag to a command.
func AskForConfirm ¶ added in v1.5.0
AskForConfirm parses and verifies user input for confirmation.
func RunAccountRateLimit ¶ added in v1.0.0
RunAccountRateLimit retrieves API rate limits for the account.
func RunAuthInit ¶ added in v1.4.0
RunAuthInit initializes the doctl config. Configuration is stored in $XDG_CONFIG_HOME/doctl. On Unix, if XDG_CONFIG_HOME is not set, use $HOME/.config. On Windows use %APPDATA%/doctl/config.
func RunAuthSwitch ¶ added in v1.8.0
func RunCDNCreate ¶ added in v1.9.0
RunCDNCreate creates a cdn.
func RunCDNDelete ¶ added in v1.9.0
RunCDNDelete deletes a cdn.
func RunCDNFlushCache ¶ added in v1.9.0
RunCDNFlushCache flushes the cache of an individual cdn
func RunCDNList ¶ added in v1.9.0
RunCDNList returns a list of CDNs.
func RunCDNUpdateTTL ¶ added in v1.9.0
RunCDNUpdateTTL updates an individual cdn ttl
func RunCertificateCreate ¶ added in v1.6.0
RunCertificateCreate creates a certificate.
func RunCertificateDelete ¶ added in v1.6.0
RunCertificateDelete deletes a certificate by its identifier.
func RunCertificateGet ¶ added in v1.6.0
RunCertificateGet retrieves an existing certificate by its identifier.
func RunCertificateList ¶ added in v1.6.0
RunCertificateList lists certificates.
func RunCmdActionWait ¶ added in v1.0.0
RunCmdActionWait waits for an action to complete or error.
func RunCmdTagCreate ¶ added in v1.1.0
RunCmdTagCreate runs tag create.
func RunCmdTagDelete ¶ added in v1.1.0
RunCmdTagDelete runs tag delete.
func RunCmdTagGet ¶ added in v1.1.0
RunCmdTagGet runs tag get.
func RunCmdTagList ¶ added in v1.1.0
RunCmdTagList runs tag list.
func RunCompletionBash ¶ added in v1.6.1
RunCompletionBash outputs completion code for bash.
func RunCompletionZsh ¶ added in v1.6.1
RunCompletionZsh outputs completion code for zsh shell.
func RunDomainDelete ¶
RunDomainDelete deletes a domain by name.
func RunDropletActionChangeKernel ¶
RunDropletActionChangeKernel changes the kernel for a droplet.
func RunDropletActionDisableBackups ¶
RunDropletActionDisableBackups disables backups for a droplet.
func RunDropletActionEnableBackups ¶ added in v1.8.2
RunDropletActionEnableBackups disables backups for a droplet.
func RunDropletActionEnableIPv6 ¶
RunDropletActionEnableIPv6 enables IPv6 for a droplet.
func RunDropletActionEnablePrivateNetworking ¶
RunDropletActionEnablePrivateNetworking enables private networking for a droplet.
func RunDropletActionGet ¶
RunDropletActionGet returns a droplet action by id.
func RunDropletActionPasswordReset ¶
RunDropletActionPasswordReset resets the droplet root password.
func RunDropletActionPowerCycle ¶
RunDropletActionPowerCycle power cycles a droplet.
func RunDropletActionPowerOff ¶
RunDropletActionPowerOff turns droplet power off.
func RunDropletActionPowerOn ¶
RunDropletActionPowerOn turns droplet power on.
func RunDropletActionReboot ¶
RunDropletActionReboot reboots a droplet.
func RunDropletActionRebuild ¶
RunDropletActionRebuild rebuilds a droplet using an image id or slug.
func RunDropletActionRename ¶
RunDropletActionRename renames a droplet.
func RunDropletActionResize ¶
RunDropletActionResize resizesx a droplet giving a size slug and optionally expands the disk.
func RunDropletActionRestore ¶
RunDropletActionRestore restores a droplet using an image id.
func RunDropletActionShutdown ¶
RunDropletActionShutdown shuts a droplet down.
func RunDropletActionSnapshot ¶
RunDropletActionSnapshot creates a snapshot for a droplet.
func RunDropletActions ¶
RunDropletActions returns a list of actions for a droplet.
func RunDropletBackups ¶
RunDropletBackups returns a list of backup images for a droplet.
func RunDropletCreate ¶
RunDropletCreate creates a droplet.
func RunDropletDelete ¶
RunDropletDelete destroy a droplet by id.
func RunDropletKernels ¶
RunDropletKernels returns a list of available kernels for a droplet.
func RunDropletList ¶
RunDropletList returns a list of droplets.
func RunDropletNeighbors ¶
RunDropletNeighbors returns a list of droplet neighbors.
func RunDropletSnapshots ¶
RunDropletSnapshots returns a list of available kernels for a droplet.
func RunDropletTag ¶ added in v1.1.0
RunDropletTag adds a tag to a droplet.
func RunDropletUntag ¶ added in v1.1.0
RunDropletUntag untags a droplet.
func RunFirewallAddDroplets ¶ added in v1.7.0
RunFirewallAddDroplets adds droplets to a Firewall.
func RunFirewallAddRules ¶ added in v1.7.0
RunFirewallAddRules adds rules to a Firewall.
func RunFirewallAddTags ¶ added in v1.7.0
RunFirewallAddTags adds tags to a Firewall.
func RunFirewallCreate ¶ added in v1.7.0
RunFirewallCreate creates a new Firewall with a given configuration.
func RunFirewallDelete ¶ added in v1.7.0
RunFirewallDelete deletes a Firewall by its identifier.
func RunFirewallGet ¶ added in v1.7.0
RunFirewallGet retrieves an existing Firewall by its identifier.
func RunFirewallList ¶ added in v1.7.0
RunFirewallList lists Firewalls.
func RunFirewallListByDroplet ¶ added in v1.7.0
RunFirewallListByDroplet lists Firewalls for a given Droplet.
func RunFirewallRemoveDroplets ¶ added in v1.7.0
RunFirewallRemoveDroplets removes droplets from a Firewall.
func RunFirewallRemoveRules ¶ added in v1.7.0
RunFirewallRemoveRules removes rules from a Firewall.
func RunFirewallRemoveTags ¶ added in v1.7.0
RunFirewallRemoveTags removes tags from a Firewall.
func RunFirewallUpdate ¶ added in v1.7.0
RunFirewallUpdate updates an existing Firewall with new configuration.
func RunFloatingIPActionsAssign ¶
RunFloatingIPActionsAssign assigns a floating IP to a droplet.
func RunFloatingIPActionsGet ¶
RunFloatingIPActionsGet retrieves an action for a floating IP.
func RunFloatingIPActionsUnassign ¶
RunFloatingIPActionsUnassign unassigns a floating IP to a droplet.
func RunFloatingIPCreate ¶
RunFloatingIPCreate runs floating IP create.
func RunFloatingIPDelete ¶
RunFloatingIPDelete runs floating IP delete.
func RunFloatingIPGet ¶
RunFloatingIPGet retrieves a floating IP's details.
func RunFloatingIPList ¶
RunFloatingIPList runs floating IP create.
func RunImageActionsGet ¶
RunImageActionsGet retrieves an action for an image.
func RunImageActionsTransfer ¶
RunImageActionsTransfer an image.
func RunImagesGet ¶
RunImagesGet retrieves an image by id or slug.
func RunImagesListApplication ¶
RunImagesListApplication lists application iamges.
func RunImagesListDistribution ¶
RunImagesListDistribution lists distributions that are available.
func RunImagesListUser ¶
RunImagesListUser lists user images.
func RunLoadBalancerAddDroplets ¶ added in v1.6.0
RunLoadBalancerAddDroplets adds droplets to a load balancer.
func RunLoadBalancerAddForwardingRules ¶ added in v1.6.0
RunLoadBalancerAddForwardingRules adds forwarding rules to a load balancer.
func RunLoadBalancerCreate ¶ added in v1.6.0
RunLoadBalancerCreate creates a new load balancer with a given configuration.
func RunLoadBalancerDelete ¶ added in v1.6.0
RunLoadBalancerDelete deletes a load balancer by its identifier.
func RunLoadBalancerGet ¶ added in v1.6.0
RunLoadBalancerGet retrieves an existing load balancer by its identifier.
func RunLoadBalancerList ¶ added in v1.6.0
RunLoadBalancerList lists load balancers.
func RunLoadBalancerRemoveDroplets ¶ added in v1.6.0
RunLoadBalancerRemoveDroplets removes droplets from a load balancer.
func RunLoadBalancerRemoveForwardingRules ¶ added in v1.6.0
RunLoadBalancerRemoveForwardingRules removes forwarding rules from a load balancer.
func RunLoadBalancerUpdate ¶ added in v1.6.0
RunLoadBalancerUpdate updates an existing load balancer with new configuration.
func RunPluginList ¶ added in v1.0.0
RunPluginList is a command for listing available plugins.
func RunPluginRun ¶ added in v1.0.0
RunPluginRun is a command for running a plugin.
func RunProjectResourcesAssign ¶ added in v1.11.0
func RunProjectResourcesGet ¶ added in v1.11.0
func RunProjectResourcesList ¶ added in v1.11.0
func RunProjectsCreate ¶ added in v1.11.0
RunProjectsCreate creates a new Project with a given configuration.
func RunProjectsDelete ¶ added in v1.11.0
func RunProjectsGet ¶ added in v1.11.0
RunProjectsGet retrieves an existing Project by its identifier. Use "default" as an identifier to retrieve your default project.
func RunProjectsList ¶ added in v1.11.0
RunProjectsList lists Projects.
func RunProjectsUpdate ¶ added in v1.11.0
func RunRecordCreate ¶
RunRecordCreate creates a domain record.
func RunRecordDelete ¶
RunRecordDelete deletes a domain record.
func RunRecordList ¶
RunRecordList list records for a domain.
func RunRecordUpdate ¶
RunRecordUpdate updates a domain record.
func RunSnapshotDelete ¶ added in v1.6.0
RunSnapshotDelete destroys snapshot(s) by id
func RunSnapshotGet ¶ added in v1.6.0
RunSnapshotGet returns a snapshot
func RunSnapshotList ¶ added in v1.6.0
RunSnapshotList returns a list of snapshots
func RunVolumeAttach ¶ added in v1.3.0
RunVolumeAttach attaches a volume to a droplet.
func RunVolumeCreate ¶ added in v1.3.0
RunVolumeCreate creates a volume.
func RunVolumeDelete ¶ added in v1.3.0
RunVolumeDelete deletes a volume.
func RunVolumeDetach ¶ added in v1.3.0
RunVolumeDetachByDropletID detaches a volume by droplet ID
func RunVolumeGet ¶ added in v1.3.0
RunVolumeGet gets a volume.
func RunVolumeList ¶ added in v1.3.0
RunVolumeList returns a list of volumes.
func RunVolumeResize ¶ added in v1.6.0
RunVolumeResize resizes a volume
func RunVolumeSnapshot ¶ added in v1.6.0
RunVolumeSnapshot creates a snapshot of a volume
Types ¶
type CmdConfig ¶ added in v1.0.0
type CmdConfig struct { NS string Doit doctl.Config Out io.Writer Args []string // services Keys func() do.KeysService Sizes func() do.SizesService Regions func() do.RegionsService Images func() do.ImagesService ImageActions func() do.ImageActionsService LoadBalancers func() do.LoadBalancersService FloatingIPs func() do.FloatingIPsService FloatingIPActions func() do.FloatingIPActionsService Droplets func() do.DropletsService DropletActions func() do.DropletActionsService Domains func() do.DomainsService Actions func() do.ActionsService Account func() do.AccountService Tags func() do.TagsService Volumes func() do.VolumesService VolumeActions func() do.VolumeActionsService Snapshots func() do.SnapshotsService Certificates func() do.CertificatesService Firewalls func() do.FirewallsService CDNs func() do.CDNsService Projects func() do.ProjectsService // contains filtered or unexported fields }
CmdConfig is a command configuration.
func NewCmdConfig ¶ added in v1.0.0
func NewCmdConfig(ns string, dc doctl.Config, out io.Writer, args []string, initGodo bool) (*CmdConfig, error)
NewCmdConfig creates an instance of a CmdConfig.
func (*CmdConfig) Display ¶ added in v1.0.0
func (c *CmdConfig) Display(d displayers.Displayable) error
Display displayes the output from a command.
type Command ¶ added in v1.0.0
type Command struct { *cobra.Command // DocCategories are the documentation categories this command belongs to. DocCategories []string IsIndex bool // contains filtered or unexported fields }
Command is a wrapper around cobra.Command that adds doctl specific functionality.
func Certificate ¶ added in v1.6.0
func Certificate() *Command
Certificate creates the certificate command.
func CmdBuilder ¶ added in v1.0.0
func CmdBuilder(parent *Command, cr CmdRunner, cliText, desc string, out io.Writer, options ...cmdOption) *Command
CmdBuilder builds a new command.
func Completion ¶ added in v1.6.1
func Completion() *Command
Completion creates the completion command
func DropletAction ¶
func DropletAction() *Command
DropletAction creates the droplet-action command.
func FloatingIP ¶
func FloatingIP() *Command
FloatingIP creates the command heirarchy for floating ips.
func FloatingIPAction ¶
func FloatingIPAction() *Command
FloatingIPAction creates the floating IP action commmand.
func LoadBalancer ¶ added in v1.6.0
func LoadBalancer() *Command
LoadBalancer creates the load balancer command.
func ProjectResourcesCmd ¶ added in v1.11.0
func ProjectResourcesCmd() *Command
func VolumeAction ¶ added in v1.3.0
func VolumeAction() *Command
VolumeAction creates the volume command
func (*Command) AddCommand ¶ added in v1.0.0
AddCommand adds child commands and adds child commands for cobra as well.
func (*Command) ChildCommands ¶ added in v1.0.0
ChildCommands returns the child commands.
type UnknownSchemeError ¶ added in v0.6.0
type UnknownSchemeError struct {
Scheme string
}
UnknownSchemeError signifies an unknown HTTP scheme.
func (*UnknownSchemeError) Error ¶ added in v0.6.0
func (use *UnknownSchemeError) Error() string
Source Files ¶
- account.go
- actions.go
- auth.go
- cdns.go
- certificates.go
- command.go
- command_config.go
- commands.go
- completion.go
- confirmation.go
- doit.go
- domains.go
- droplet_actions.go
- droplets.go
- errors.go
- extract.go
- firewalls.go
- floating_ip_actions.go
- floating_ips.go
- image_actions.go
- images.go
- load_balancers.go
- plugin.go
- projects.go
- regions.go
- sizes.go
- snapshots.go
- ssh.go
- sshkeys.go
- tags.go
- util.go
- version.go
- volume_actions.go
- volumes.go
- xdg.go