Categorygithub.com/digitalocean/doctl
modulepackage
1.123.0
Repository: https://github.com/digitalocean/doctl.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
26
Dependents
5
Files
1.2k SLOC

# README

doctl

The doctl mascot.

Build Status GoDoc Go Report Card 

doctl is a command-line interface (CLI) for the DigitalOcean API.

Usage:
  doctl [command]

Available Commands:
  1-click         Display commands that pertain to 1-click applications
  account         Display commands that retrieve account details
  apps            Display commands for working with apps
  auth            Display commands for authenticating doctl with an account
  balance         Display commands for retrieving your account balance
  billing-history Display commands for retrieving your billing history
  completion      Modify your shell so doctl commands autocomplete with TAB
  compute         Display commands that manage infrastructure
  databases       Display commands that manage databases
  help            Help about any command
  invoice         Display commands for retrieving invoices for your account
  kubernetes      Displays commands to manage Kubernetes clusters and configurations
  monitoring      [Beta] Display commands to manage monitoring
  projects        Manage projects and assign resources to them
  registry        Display commands for working with container registries
  version         Show the current version
  vpcs            Display commands that manage VPCs

Flags:
  -t, --access-token string   API V2 access token
  -u, --api-url string        Override default API endpoint
  -c, --config string         Specify a custom config file (default "$HOME/.config/doctl/config.yaml")
      --context string        Specify a custom authentication context name
  -h, --help                  help for doctl
  -o, --output string         Desired output format [text|json] (default "text")
      --trace                 Show a log of network activity while performing a command
  -v, --verbose               Enable verbose output

Use "doctl [command] --help" for more information about a command.

See the full reference documentation for information about each available command.

Installing doctl

Using a Package Manager (Preferred)

A package manager allows you to install and keep up with new doctl versions using only a few commands. Our community distributes doctl via a growing set of package managers in addition to the officially supported set listed below; chances are good a solution exists for your platform.

MacOS

Use Homebrew to install doctl on macOS:

brew install doctl

doctl is also available via MacPorts. Note that the port is community maintained and may not be on the latest version.

Snap supported OS

Use Snap on Snap-supported systems to install doctl:

sudo snap install doctl
Use with kubectl

Using kubectl requires the kube-config personal-files connection for doctl:

sudo snap connect doctl:kube-config
Using doctl compute ssh

Using doctl compute ssh requires the core ssh-keys interface:

sudo snap connect doctl:ssh-keys :ssh-keys
Use with Docker

Using doctl registry login requires the dot-docker personal-files connection for doctl:

sudo snap connect doctl:dot-docker

This allows doctl to add DigitalOcean container registry credentials to your Docker configuration file.

Arch Linux

doctl is available in the official Arch Linux repository:

sudo pacman -S doctl

Fedora

doctl is available in the official Fedora repository:

sudo dnf install doctl

Nix supported OS

Users of NixOS or other supported platforms may install doctl from Nixpkgs. Please note this package is also community maintained and may not be on the latest version.

Docker Hub

Containers for each release are available under the digitalocean organization on Docker Hub. Links to the containers are available in the GitHub releases.

Downloading a Release from GitHub

Visit the Releases page for the doctl GitHub project, and find the appropriate archive for your operating system and architecture. Download the archive from your browser or copy its URL and retrieve it to your home directory with wget or curl.

For example, with wget:

cd ~
wget https://github.com/digitalocean/doctl/releases/download/v<version>/doctl-<version>-linux-amd64.tar.gz

Or with curl:

cd ~
curl -OL https://github.com/digitalocean/doctl/releases/download/v<version>/doctl-<version>-linux-amd64.tar.gz

Extract the binary:

tar xf ~/doctl-<version>-linux-amd64.tar.gz

Or download and extract with this oneliner:

curl -sL https://github.com/digitalocean/doctl/releases/download/v<version>/doctl-<version>-linux-amd64.tar.gz | tar -xzv

where <version> is the full semantic version, e.g., 1.17.0.

On Windows systems, you should be able to double-click the zip archive to extract the doctl executable.

Move the doctl binary to somewhere in your path. For example, on GNU/Linux and OS X systems:

sudo mv ~/doctl /usr/local/bin

Windows users can follow How to: Add Tool Locations to the PATH Environment Variable in order to add doctl to their PATH.

Building with Docker

If you have Docker configured, you can build a local Docker image using doctl's Dockerfile and run doctl within a container.

docker build --tag=doctl .

Then you can run it within a container.

docker run --rm --interactive --tty --env=DIGITALOCEAN_ACCESS_TOKEN="your_DO_token" doctl any_doctl_command

Building the Development Version from Source

If you have a Go environment configured, you can install the development version of doctl from the command line.

go install github.com/digitalocean/doctl/cmd/doctl@latest

While the development version is a good way to take a peek at doctl's latest features before they get released, be aware that it may have bugs. Officially released versions will generally be more stable.

Dependencies

doctl uses Go modules with vendoring.

Authenticating with DigitalOcean

To use doctl, you need to authenticate with DigitalOcean by providing an access token, which can be created from the Applications & API section of the Control Panel. You can learn how to generate a token by following the DigitalOcean API guide.

Docker users will have to use the DIGITALOCEAN_ACCESS_TOKEN environmental variable to authenticate, as explained in the Installation section of this document.

If you're not using Docker to run doctl, authenticate with the auth init command.

doctl auth init

You will be prompted to enter the DigitalOcean access token that you generated in the DigitalOcean control panel.

DigitalOcean access token: your_DO_token

After entering your token, you will receive confirmation that the credentials were accepted. If the token doesn't validate, make sure you copied and pasted it correctly.

Validating token: OK

This will create the necessary directory structure and configuration file to store your credentials.

Logging into multiple DigitalOcean accounts

doctl allows you to log in to multiple DigitalOcean accounts at the same time and easily switch between them with the use of authentication contexts.

By default, a context named default is used. To create a new context, run doctl auth init --context <new-context-name>. You may also pass the new context's name using the DIGITALOCEAN_CONTEXT environment variable. You will be prompted for your API access token which will be associated with the new context.

To use a non-default context, pass the context name to any doctl command. For example:

doctl compute droplet list --context <new-context-name>

To set a new default context, run doctl auth switch --context <new-context-name>. This command will save the current context to the config file and use it for all commands by default if a context is not specified.

The --access-token flag or DIGITALOCEAN_ACCESS_TOKEN environment variable are acknowledged only if the default context is used. Otherwise, they will have no effect on what API access token is used. To temporarily override the access token if a different context is set as default, use doctl --context default --access-token your_DO_token ....

Configuring Default Values

The doctl configuration file is used to store your API Access Token as well as the defaults for command flags. If you find yourself using certain flags frequently, you can change their default values to avoid typing them every time. This can be useful when, for example, you want to change the username or port used for SSH.

On OS X, doctl saves its configuration as ${HOME}/Library/Application Support/doctl/config.yaml. The ${HOME}/Library/Application Support/doctl/ directory will be created once you run doctl auth init.

On Linux, doctl saves its configuration as ${XDG_CONFIG_HOME}/doctl/config.yaml if the ${XDG_CONFIG_HOME} environmental variable is set, or ~/.config/doctl/config.yaml if it is not. On Windows, the config file location is %APPDATA%\doctl\config.yaml.

The configuration file is automatically created and populated with default properties when you authenticate with doctl for the first time. The typical format for a property is category.command.sub-command.flag: value. For example, the property for the force flag with tag deletion is tag.delete.force.

To change the default SSH user used when connecting to a Droplet with doctl, look for the compute.ssh.ssh-user property and change the value after the colon. In this example, we changed it to the username sammy.

. . .
compute.ssh.ssh-user: sammy
. . .

Save and close the file. The next time you use doctl, the new default values you set will be in effect. In this example, that means that it will SSH as the sammy user (instead of the default root user) next time you log into a Droplet.

Environment variables

In addition to specifying configuration using config.yaml file or program arguments, it is also possible to override values just for the given session with environment variables:

# Use instead of --context argument
DIGITALOCEAN_CONTEXT=my-context doctl auth list

# Use instead of --access-token argument
DIGITALOCEAN_ACCESS_TOKEN=my-do-token doctl

Enabling Shell Auto-Completion

doctl also has auto-completion support. It can be set up so that if you partially type a command and then press TAB, the rest of the command is automatically filled in. For example, if you type doctl comp<TAB><TAB> drop<TAB><TAB> with auto-completion enabled, you'll see doctl compute droplet appear on your command prompt.

Note: Shell auto-completion is not available for Windows users.

How you enable auto-completion depends on which operating system you're using. If you installed doctl via Homebrew, auto-completion is activated automatically, though you may need to configure your local environment to enable it.

doctl can generate an auto-completion script with the doctl completion your_shell_here command. Valid arguments for the shell are Bash (bash), ZSH (zsh), and fish (fish). By default, the script will be printed to the command line output. For more usage examples for the completion command, use doctl completion --help.

Linux Auto Completion

The most common way to use the completion command is by adding a line to your local profile configuration. At the end of your ~/.profile file, add this line:

source <(doctl completion your_shell_here)

If you are using ZSH, add this line to your ~/.zshrc file:

compdef _doctl doctl

Then refresh your profile.

source ~/.profile

MacOS (bash)

macOS users will have to install the bash-completion framework to use the auto-completion feature.

brew install bash-completion

After it's installed, load bash_completion by adding the following line to your .profile or .bashrc file.

source $(brew --prefix)/etc/bash_completion

Then refresh your profile using the appropriate command for the bash configurations file.

source ~/.profile
source ~/.bashrc

MacOS (zsh)

Add the following line to your ~/.zshrc file:

autoload -U +X compinit; compinit

Then refresh your profile.

Uninstalling doctl

Using a Package Manager

MacOS Uninstall

Use Homebrew to uninstall all current and previous versions of the doctl formula on macOS:

brew uninstall -f doctl

To completely remove the configuration, also remove the following directory:

rm -rf "$HOME/Library/Application Support/doctl"

Examples

doctl is able to interact with all of your DigitalOcean resources. Below are a few common usage examples. To learn more about the features available, see the full tutorial on the DigitalOcean community site.

  • List all Droplets on your account:
doctl compute droplet list
  • Create a Droplet:
doctl compute droplet create <name> --region <region-slug> --image <image-slug> --size <size-slug>
  • Assign a Floating IP to a Droplet:
doctl compute floating-ip-action assign <ip-addr> <droplet-id>
  • Create a new A record for an existing domain:
doctl compute domain records create --record-type A --record-name www --record-data <ip-addr> <domain-name>

doctl also simplifies actions without an API endpoint. For instance, it allows you to SSH to your Droplet by name:

doctl compute ssh <droplet-name>

By default, it assumes you are using the root user. If you want to SSH as a specific user, you can do that as well:

doctl compute ssh <user>@<droplet-name>

Tutorials

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

CommandName returns the name by which doctl was invoked.
NewMissingArgsErr creates a MissingArgsErr instance.
NewTestConfig creates a new, ready-to-use instance of a TestConfig.
NewTooManyArgsErr creates a TooManyArgsErr instance.

# Constants

ArgAccessToken is the access token to be used for the operations.
ArgActionAfter is an action after argument.
ArgActionBefore is an action before argument.
ArgActionID is an action id argument.
ArgActionRegion is an action region argument.
ArgActionResourceType is an action resource type argument.
ArgActionStatus is an action status argument.
ArgActionType is an action type argument.
ArgAlertPolicyCompare is the alert policy comparator.
ArgAlertPolicyDescription is the flag to pass in the alert policy description.
ArgAlertPolicyEmails are the emails to send alerts to.
ArgAlertPolicyEnabled is whether the alert policy is enabled.
ArgAlertPolicyEntities is the alert policy entities.
ArgAlertPolicySlackChannels are the Slack channels to send alerts to.
ArgAlertPolicySlackURLs are the Slack URLs to send alerts to.
ArgAlertPolicyTags is the alert policy tags.
ArgAlertPolicyType is the alert policy type.
ArgAlertPolicyValue is the alert policy value.
ArgAlertPolicyWindow is the alert policy window.
ArgAllowList is the list of firewall rules for ALLOWING traffic to the loadbalancer.
ArgApp is the app ID.
ArgAppAlertDestinations is a path to an app alert destination file.
ArgAppComponents is a list of components to restart.
ArgAppDeployment is the deployment ID.
ArgAppDevConfig is the path to the app dev link config.
ArgAppForceRebuild forces a deployment rebuild.
ArgAppLogFollow follow logs.
ArgAppLogTail tail logs.
ArgAppLogType the type of log.
ArgAppSpec is a path to an app spec.
ArgAppWithProjects will determine whether project ids should be fetched along with listed apps.
ArgAutoscaleCooldownMinutes is an autoscale cooldown duration (minutes) argument.
ArgAutoscaleCpuTarget is an autoscale target cpu utilization argument.
ArgAutoscaleID is an autoscale id argument.
ArgAutoscaleMaxInstances is an autoscale max instance argument.
ArgAutoscaleMemTarget is an autoscale target memory utilization argument.
ArgAutoscaleMinInstances is an autoscale min instance argument.
ArgAutoscaleName is an autoscale name argument.
ArgAutoscaleTargetInstances is an autoscale target instance argument.
ArgAutoUpgrade is a cluster's auto-upgrade argument.
ArgBackups is an enable backups argument.
ArgBuildCommand is an optional build command to set for local development.
ArgBuildpack is a buildpack id.
ArgCDNCertificateID is a certificate id to use with a custom domain.
ArgCDNDomain is a cdn custom domain argument.
ArgCDNFiles is a cdn files argument.
ArgCDNTTL is a cdn ttl argument.
ArgCertificateChainPath is a path to a certificate chain.
ArgCertificateDNSNames is a list of DNS names.
ArgCertificateName is a name of the certificate.
ArgCertificateType is a certificate type.
ArgClusterAutoscalerScaleDownUnneededTime is the cluster autoscaler scale down unneeded time.
ArgClusterAutoscalerScaleDownUtilizationThreshold is the cluster autoscaler scale down utilization threshold.
ArgClusterName is a cluster name argument.
ArgClusterNodePool are a cluster's node pools arguments.
ArgClusterSubnet is a cluster pod CIDR argument.
ArgClusterUpdateKubeconfig updates the local kubeconfig.
ArgClusterVersionSlug is a cluster version argument.
ArgClusterVPCUUID is a cluster vpc-uuid argument.
ArgCommandUpdateSources tells the respective operation to also update the underlying sources.
ArgCommandUpsert is an upsert for a resource to be created or updated argument.
ArgCommandWait is a wait for a resource to be created argument.
ArgContext is the name of the auth context.
ArgControlPlaneFirewallAllowedAddresses list of allowed addresses that can access the control plane.
ArgDangerous indicates whether to delete the cluster and all it's associated resources.
ArgDatabaseConfigJson is a flag for specifying the database configuration in JSON format for an update.
ArgDatabaseEngine is a flag for specifying which database engine to use.
ArgDatabaseFirewallRule the firewall rules.
ArgDatabaseFirewallRuleUUID is the UUID for the firewall rules.
ArgDatabaseMaintenanceDay is the new day for the maintenance window.
ArgDatabaseMaintenanceHour is the new hour for the maintenance window.
ArgDatabaseNumNodes is the number of nodes in the database cluster.
ArgDatabasePoolDBName is the database for use with connection pool.
ArgDatabasePoolMode is the flag for connection pool mode.
ArgDatabasePoolSize is the flag for connection pool size.
ArgDatabasePoolUserName is the name of user for use with connection pool.
ArgDatabasePrivateConnectionBool determine if the private connection details should be shown.
ArgDatabaseRestoreFromClusterID is a flag for specifying the id of an existing database cluster from which the new database will be forked from.
ArgDatabaseRestoreFromClusterName is a flag for specifying the name of an existing database cluster from which the backup will be restored.
ArgDatabaseRestoreFromTimestamp is a flag for specifying the timestamp of an existing database cluster backup in ISO8601 combined date and time format.
ArgDatabaseStorageSizeMib is the amount of disk space, in MiB, that should be allocated to the database cluster.
ArgDatabaseTopicCleanupPolicy is the cleanup policy associated with a kafka topic.
ArgDatabaseTopicCompressionType is the compression algorithm used for a kafka topic.
ArgDatabaseTopicDeleteRetentionMS is the amount of time, in ms, to retain delete tombstone markers for a kafka topic.
ArgDatabaseTopicFileDeleteDelayMS is the amount of time, in ms, to wait before deleting a file from the filesystem.
ArgDatabaseTopicFlushMessages is the size, in bytes, of all messages to accumulate on a partition before flushing them to disk.
ArgDatabaseTopicFlushMS is the amount of time, in ms, a message is kept in memory before it is flushed to disk.
ArgDatabaseTopicIntervalIndexBytes is the number of bytes between entries being added into the offset index.
ArgDatabaseTopicMaxCompactionLagMS is the maximum amount of time, in ms, that a message will remain uncompacted (if compaction is enabled).
ArgDatabaseTopicMaxMessageBytes is the maximum size, in bytes, of the largest record batch that can be sent to the server.
ArgDatabaseTopicMessageDownConversionEnable determines whether brokers should convert messages for consumers expecting older message formats.
ArgDatabaseTopicMessageFormatVersion is the version used by the broker to append messages to the kafka topic logs.
ArgDatabaseTopicMessageTimestampType is the timestamp used for messages.
ArgDatabaseTopicMinCleanableDirtyRatio is ratio, between 0 and 1, specifying the frequenty of log compaction.
ArgDatabaseTopicMinCompactionLagMS is the minimum time, in ms, that a message will remain uncompacted.
ArgDatabaseTopicMinInsyncReplicas is the minimum number of replicas that must ACK a write for the write to be considered successful.
ArgDatabaseTopicPartitionCount is the number of partitions that are associated with a kafka topic.
ArgDatabaseTopicPreallocate determines whether a file should be preallocated on disk when creating a new log segment.
ArgDatabaseTopicReplicationFactor is the replication factor of a kafka topic.
ArgDatabaseTopicRetentionBytes is the maximum size, in bytes, of a topic log before messages are deleted.
ArgDatabaseTopicRetentionMS is the maximum time, in ms, that a message is retained before deleting it.
ArgDatabaseTopicSegmentBytes is the maximum size, in bytes, of a single log file.
ArgDatabaseTopicSegmentJitterMS is the maximum random jitter, in ms, subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling.
ArgDatabaseTopicSegmentMS is the period of time, in ms, after which the log will be forced to roll if the segment file isn't full.
ArgDatabaseUserKafkaACLs will specify permissions on topics in kafka clsuter.
ArgDatabaseUserMySQLAuthPlugin is a flag for setting the MySQL user auth plugin.
ArgDatabaseUserOpenSearchACLs will specify permissions on indexes in opensearch clsuter.
ArgDefaultContext is the default auth context.
ArgDenyList is a list of firewall rules for DENYING traffic to the loadbalancer.
ArgDisableLetsEncryptDNSRecords is a flag that when set will disable the creation of DNS records pointing to the load balancer IP from the apex domain in the cert.
ArgDropletAgent is an argument for enabling/disabling the Droplet agent.
ArgDropletBackupPolicyHour sets backup policy hour.
ArgDropletBackupPolicyPlan sets a frequency plan for backups.
ArgDropletBackupPolicyWeekday sets backup policy day of the week.
ArgDropletID is a droplet id argument.
ArgDropletIDs is a list of droplet IDs.
ArgDropletName is a droplet name argument.
ArgEnableBackendKeepalive is a flag that indicates whether keepalive connections should be enabled to target droplets from the load balancer.
ArgEnableControlPlaneFirewall enable control plane firewall.
ArgEnableProxyProtocol is a flag that indicates whether PROXY protocol should be enabled on the load balancer.
ArgEnableRoutingAgent enables the routing-agent cluster plugin.
ArgEnvFile is an environment file to load variables from.
ArgFirewallName is a name of the firewall.
ArgForce forces confirmation on actions.
ArgFormat is columns to include in output argument.
ArgForwardingRules is a list of forwarding rules for the load balancer.
ArgGCExcludeUnreferencedBlobs indicates that a garbage collection should not delete unreferenced blobs.
ArgGCIncludeUntaggedManifests indicates that a garbage collection should delete all untagged manifests.
ArgGlobalLoadBalancerCDNSettings is global load balancer CDN settings.
ArgGlobalLoadBalancerSettings is global load balancer settings.
ArgGPUs specifies to list GPU Droplets.
ArgHA is a cluster's highly available control plane argument.
ArgHealthCheck is a list of health check settings for the load balancer.
ArgHTTPIdleTimeoutSeconds is the http idle time out configuration for the load balancer.
ArgImage is an image argument.
ArgImageDescription is free text that describes the image.
ArgImageDistro is the name of a custom image's distribution.
ArgImageExternalURL is a URL that returns an image file.
ArgImageID is an image id argument.
ArgImageName name is an image name argument.
ArgImagePublic is a public image argument.
ArgImageSlug is an image slug argument.
ArgInboundRules is a list of inbound rules for the firewall.
ArgInteractive is the argument to enable an interactive CLI.
ArgInterconnectAttachmentType is the type of the Interconnect Attachment e.g.
ArgIPAddress is an IP address argument.
ArgIPv6 is an enable IPv6 argument.
ArgKernelID is a kernel 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.
ArgKubeConfigExpirySeconds indicates the length of time the token in a kubeconfig will be valid in seconds.
ArgKubernetesAlias is a Kubernetes alias argument that saves authentication information under the specified context.
ArgKubernetesLabel is a Kubernetes label argument.
ArgKubernetesTaint is a Kubernetes taint argument.
ArgLeafCertificatePath is a path to a certificate leaf.
ArgLoadBalancerAlgorithm is a load balancing algorithm.
ArgLoadBalancerDomains is list of domains supported for global load balancer.
ArgLoadBalancerList is the IDs of many load balancers.
ArgLoadBalancerName is a name of the load balancer.
ArgLoadBalancerNetwork is the type of network the load balancer is accessible from.
ArgLoadBalancerNetworkStack is the network stack type the load balancer will be configured with (e.g IPv4, Dual Stack: IPv4 and IPv6).
ArgLoadBalancerType is the type of the load balancer.
ArgMaintenanceWindow is a cluster's maintenance window argument.
ArgMajorVersion is a major version number.
ArgMonitoring is an enable monitoring argument.
ArgNoCache represents whether or not to omit the cache on the next command.
ArgNodePoolAutoScale is a cluster's node pool auto_scale argument.
ArgNodePoolCount is a cluster's node pool count argument.
ArgNodePoolMaxNodes is a cluster's node pool max_nodes argument.
ArgNodePoolMinNodes is a cluster's node pool min_nodes argument.
ArgNodePoolName is a cluster's node pool name argument.
ArgNodePoolNodeIDs is a cluster's node pool nodes argument.
ArgNoHeader hides the output header.
ArgNoPrefix no prefix to json logs.
ArgObjectName is the Kubernetes object name.
ArgObjectNamespace is the Kubernetes object namespace.
ArgOneClicks is the flag to pass in 1-click application slugs.
ArgOneClickType is the type of 1-Click.
ArgOutboundRules is a list of outbound rules for the firewall.
ArgOutput is an output type argument.
ArgPartnerInterconnectAttachmentBGPAuthKey is the BGP MD5 authentication key.
ArgPartnerInterconnectAttachmentBGPLocalASN is the BGP Autonomous System Number (ASN) of the local device.
ArgPartnerInterconnectAttachmentBGPLocalRouterIP is the BGP IP address of the local device.
ArgPartnerInterconnectAttachmentBGPPeerASN is the BGP Autonomous System Number (ASN) of the peer device.
ArgPartnerInterconnectAttachmentBGPPeerIPAddress is the BGP IP address of the peer device.
ArgPartnerInterconnectAttachmentConnectionBandwidthInMbps is the connection bandwidth in megabits per second.
ArgPartnerInterconnectAttachmentNaaSProvider is the name of the Network as a Service provider.
ArgPartnerInterconnectAttachmentName is a name of the Partner Interconnect Attachment.
ArgPartnerInterconnectAttachmentRegion is the region slug.
ArgPartnerInterconnectAttachmentVPCIDs are the IDs of the VPCs which the Partner Interconnect Attachment is connected.
ArgPollTime is how long before the next poll argument.
ArgPrivateKeyPath is a path to a private key for the certificate.
ArgPrivateNetworking is an enable private networking argument.
ArgPrivateNetworkUUID is the flag for VPC UUID.
ArgProjectDescription is the description of a project.
ArgProjectEnvironment is the environment of a project.
ArgProjectID is the ID of a project.
ArgProjectIsDefault is used to change the default project.
ArgProjectName is the name of a project.
ArgProjectPurpose is the purpose of a project.
ArgProjectResource is a flag for your resource URNs.
ArgReadWrite indicates a generated token should be read/write.
ArgRecordData is a record data argument.
ArgRecordFlags is a record flags 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.
ArgRecordTag is a record tag argument.
ArgRecordTTL is a record ttl argument.
ArgRecordType is a record type argument.
ArgRecordWeight is a record weight argument.
ArgRedirectHTTPToHTTPS is a flag that indicates whether HTTP requests to the load balancer on port 80 should be redirected to HTTPS on port 443.
ArgRegionSlug is a region slug argument.
ArgRegistry indicates the name of the registry.
ArgRegistryAuthorizationServerEndpoint is the endpoint of the OAuth authorization server used to revoke credentials on logout.
ArgRegistryExpirySeconds indicates the length of time the token will be valid in seconds.
ArgRegistryNeverExpire indicates that a generated registry API token should never expire.
ArgRegistryReadOnly indicates that a generated registry API token should be read-only.
ArgResizeDisk is a resize disk argument.
ArgResourceType is the resource type for snapshot.
ArgSchemaOnly is a schema only argument.
ArgServiceSubnet is a cluster service CIDR argument.
ArgSetCurrentContext is a flag to set the new kubeconfig context as current.
ArgShortForce forces confirmation on actions.
ArgSizeSlug is a size slug argument.
ArgSizeUnit is a size unit argument.
ArgSnapshotDesc is the description for volume snapshot.
ArgSnapshotName is a snapshot name argument.
ArgSSHCommand is a ssh argument.
ArgSSHKeys is a ssh key argument.
ArgSSHRetryMax is a ssh argument.
ArgSSHUser is a SSH user argument.
ArgsSSHAgentForwarding is a ssh argument.
ArgsSSHKeyPath is a ssh argument.
ArgsSSHPort is a ssh argument.
ArgsSSHPrivateIP is a ssh argument.
ArgStickySessions is a list of sticky sessions settings for the load balancer.
ArgSubscriptionTier is a subscription tier slug.
ArgSurgeUpgrade is a cluster's surge-upgrade argument.
ArgTag specifies tag.
ArgTagName is a tag name NOTE: ArgTagName will be deprecated once existing uses have been migrated to use `--tag` (ArgTag).
ArgTagNames is a slice of possible tag names NOTE: ArgTagNames will be deprecated once existing uses have been migrated to use `--tag` (ArgTag).
ArgTargetLoadBalancerIDs is a list of target load balancer IDs.
ArgTemplate is template format.
ArgTimeout is a timeout duration.
ArgTokenValidationServer is the server used to validate an OAuth token.
ArgTriggerDeployment indicates whether to trigger a deployment.
ArgUptimeAlertComparison is the uptime alert comparator.
ArgUptimeAlertEmails are the emails to send uptime alerts to.
ArgUptimeAlertName is the name of an uptime alert.
ArgUptimeAlertPeriod is the time threshold at which an uptime alert will trigger.
ArgUptimeAlertSlackChannels are the Slack channels to send uptime alerts to.
ArgUptimeAlertSlackURLs are the Slack URLs to send uptime alerts to.
ArgUptimeAlertThreshold the threshold at which an uptime alert will trigger.
ArgUptimeAlertType is the type of an uptime alert.
ArgUptimeCheckEnabled is whether or not an uptime check is enabled.
ArgUptimeCheckName is the name of an uptime check.
ArgUptimeCheckRegions are the regions of an uptime check.
ArgUptimeCheckTarget is the target of an uptime check.
ArgUptimeCheckType is the type of an uptime check.
ArgUserData is a user data argument.
ArgUserDataFile is a user data file location argument.
ArgVerbose enables verbose output.
ArgVersion is the version of the command to use.
ArgVolumeDesc is the description of a volume.
ArgVolumeFilesystemLabel is the filesystem label for a volume.
ArgVolumeFilesystemType is the filesystem type for a volume.
ArgVolumeList is the IDs of many volumes.
ArgVolumeRegion is the region of a volume.
ArgVolumeSize is the size of a volume.
ArgVolumeSnapshot is the snapshot from which to create a volume.
ArgVolumeSnapshotList is the IDs of many volume snapshots.
ArgVPCDefault is the VPC default argument, to update a specific VPC to the default VPC.
ArgVPCDescription is a VPC description.
ArgVPCIPRange is a VPC range of IP addresses in CIDR notation.
ArgVPCName is a name of the VPC.
ArgVPCPeeringName is a name of the VPC Peering.
ArgVPCPeeringVPCID is id of the VPC.
ArgVPCPeeringVPCIDs is the vpc ids of the peering.
ArgVPCUUID is a VPC UUID argument.
LatestReleaseURL is the latest release URL endpoint.

# Variables

Build is set at build time.
DoitVersion is doctl's version.
Label is set at build time.
Major is set at build time.
Minor is set at build time.
Patch is set at build time.
TraceHTTP traces http connections.

# Structs

GithubLatestVersioner retrieves the latest version from GitHub.
LiveConfig is an implementation of Config for live values.
MissingArgsErr is returned when there are too few arguments for a command.
MockListener is an implementation of ListenerService for mocking.
MockRunner is an implementation of Runner for mocking.
MockTerminal is an implementation of Terminal for mocking.
TestConfig is an implementation of Config for testing.
TooManyArgsErr is returned when there are too many arguments for a command.
Version is the version info for doit.

# Interfaces

Config is an interface that represent doit's config.
LatestVersioner an interface for detecting the latest version.