# Functions
Account creates the account commands hierarchy.
Actions creates the action commands hierarchy.
Activations generates the serverless 'activations' subtree for addition to the doctl command.
AddBoolFlag adds a boolean flag to a command.
AddDurationFlag adds a duration flag to a command.
AddIntFlag adds an integr flag to a command.
AddStringFlag adds a string flag to a command.
AddStringMapStringFlag adds a map of strings by strings flag to a command.
AddStringSliceFlag adds a string slice flag to a command.
Apps creates the apps command.
AppsDev creates the apps dev command subtree.
AppsDevConfig creates the apps dev config command subtree.
AskForConfirm parses and verifies user input for confirmation.
AskForConfirmDelete builds a message to ask the user to confirm deleting one or multiple resources and then sends it through to AskForConfirm to parses and verifies user input.
Auth creates auth commands for doctl.
Balance creates the balance commands hierarchy.
BillingHistory creates the BillingHistory commands hierarchy.
CDN creates the CDN command.
Certificate creates the certificate command.
CmdBuilder builds a new command.
ContextualAtoi cleans the error output of Atoi calls.
Databases creates the databases command.
Domain creates the domain commands hierarchy.
Droplet creates the droplet command.
DropletAction creates the droplet-action command.
No description provided by the author
Execute executes the current command using DoitCmd.
Firewall creates the firewall command.
Functions generates the serverless 'functions' subtree for addition to the doctl command.
GarbageCollection creates the garbage-collection subcommand.
ImageAction creates the image action command.
Images creates an image command.
Invoices creates the invoices commands hierarchy.
Kubernetes creates the kubernetes command.
LoadBalancer creates the load balancer command.
Monitoring creates the monitoring commands hierarchy.
Namespaces generates the serverless 'namespaces' subtree for addition to the doctl command.
Network creates the network command.
NewCmdConfig creates an instance of a CmdConfig.
OneClicks creates the 1-click command.
PartnerInterconnectAttachments creates the interconnect attachments command.
Plugin creates the plugin commands hierarchy.
ProjectResourcesCmd creates the project resources commands hierarchy.
Projects creates the projects commands hierarchy.
Region creates the region commands hierarchy.
Registry creates the registry command.
RegistryOptions creates the registry options subcommand.
Repository creates the repository sub-command.
ReservedIP creates the command hierarchy for reserved ips.
ReservedIPAction creates the reserved IP action command.
ReservedIPv6 creates the command hierarchy for reserved IPv6s.
RunAccountGet runs account get.
RunAccountRateLimit retrieves API rate limits for the account.
RunActivationsGet supports the 'activations get' command.
RunActivationsList supports the 'activations list' command.
RunActivationsLogs supports the 'activations logs' command.
RunActivationsResult supports the 'activations result' command.
RunAppListAlerts gets configured alerts on an app.
RunAppListBuildpacks lists buildpacks.
RunAppsConsole initiates a console session for an app.
RunAppsCreate creates an app.
RunAppsCreateDeployment creates a deployment for an app.
RunAppsDelete deletes an app.
RunAppsDevBuild builds an app component locally.
RunAppsDevConfigSet runs the set configuration command.
RunAppsDevConfigUnset runs the unset configuration command.
RunAppsGet gets an app.
RunAppsGetDeployment gets a deployment for an app.
RunAppsGetLogs gets app logs for a given component.
RunAppsList lists all apps.
RunAppsListDeployments lists deployments for an app.
RunAppsListRegions lists all app platform regions.
RunAppsPropose proposes an app spec.
RunAppsRestart restarts an app.
RunAppsSpecGet gets the spec for an app.
RunAppsSpecValidate validates an app spec file doesn't require auth & connection to the API with doctl.ArgSchemaOnly flag.
RunAppsTierGet gets an app tier.
RunAppsTierInstanceSizeGet gets an app tier.
RunAppsTierInstanceSizeList lists all app tiers.
RunAppsTierList lists all app tiers.
RunAppsUpdate updates an app.
No description provided by the author
RunAppUpgradeBuildpack upgrades a buildpack for an app.
RunAuthInit initializes the doctl config.
RunAuthList lists all available auth contexts from the user's doctl config.
RunAuthRemove remove available auth contexts from the user's doctl config.
RunAuthSwitch changes the default context and writes it to the configuration.
RunBalanceGet runs balance get.
RunBillingHistoryList runs invoice list.
RunCancelGarbageCollection gets the specified registry's currently-active garbage collection.
RunCDNCreate creates a cdn.
RunCDNDelete deletes a cdn.
RunCDNFlushCache flushes the cache of an individual cdn.
RunCDNGet returns an individual CDN.
RunCDNList returns a list of CDNs.
RunCDNUpdate updates an individual cdn.
RunCertificateCreate creates a certificate.
RunCertificateDelete deletes a certificate by its identifier.
RunCertificateGet retrieves an existing certificate by its identifier.
RunCertificateList lists certificates.
RunCmdActionGet runs action get.
RunCmdActionList run action list.
RunCmdActionWait waits for an action to complete or error.
RunCmdAlertPolicyCreate runs alert policy create.
RunCmdAlertPolicyDelete runs alert policy delete.
RunCmdAlertPolicyGet runs alert policy get.
RunCmdAlertPolicyList runs alert policy list.
RunCmdAlertPolicyUpdate runs alert policy update.
RunCmdApplyTag applies a tag to one or more resources.
RunCmdRemoveTag removes a tag from one or more resources.
RunCmdTagCreate runs tag create.
RunCmdTagDelete runs tag delete.
RunCmdTagGet runs tag get.
RunCmdTagList runs tag list.
RunDatabaseBackupsList lists all the backups for a database cluster.
No description provided by the author
No description provided by the author
RunDatabaseConnectionGet gets database connection info.
RunDatabaseCreate creates a database cluster.
RunDatabaseDBCreate creates a database for a database cluster.
RunDatabaseDBDelete deletes a database.
RunDatabaseDBGet retrieves a database for a specific database cluster.
RunDatabaseDBList retrieves a list of databases for specific database cluster.
RunDatabaseDelete deletes a database cluster.
RunDatabaseEngineOptions retrieves a list of the available database engines.
RunDatabaseDBList retrieves a list of databases for specific database cluster.
RunDatabaseFirewallRulesAppend creates a firewall rule for a database cluster.
RunDatabaseFirewallRulesList retrieves a list of firewalls for specific database cluster.
RunDatabaseFirewallRulesRemove removes a firewall rule for a database cluster via Firewall rule UUID.
RunDatabaseFirewallRulesUpdate replaces previous rules with the rules passed in to --rules.
RunDatabaseFork creates a database cluster by forking an existing cluster.
RunDatabaseGet returns an individual database cluster.
RunDatabaseGetCA returns a CA certificate for a database.
RunDatabaseGetSQLModes gets the sql modes set on the database.
No description provided by the author
No description provided by the author
RunDatabaseInstallUpdate starts installation of updates.
RunDatabaseList returns a list of database clusters.
RunDatabaseMaintenanceGet retrieves the maintenance window info for a database cluster.
RunDatabaseMaintenanceUpdate updates the maintenance window info for a database cluster.
RunDatabaseMigrate migrates a database cluster to a new region.
RunDatabasePoolCreate creates a database pool for a database cluster.
RunDatabasePoolDelete deletes a database pool.
RunDatabasePoolGet retrieves a database pool for a specific database cluster.
RunDatabasePoolList retrieves a list of pools for specific database cluster.
RunDatabasePoolUpdate updates a database pool.
RunDatabaseRegionOptions retrieves a list of the available regions for a given database engine.
RunDatabaseReplicaConnectionGet gets read-only replica connection info.
RunDatabaseReplicaCreate creates a read-only replica for a database cluster.
RunDatabaseReplicaDelete deletes a read-only replica.
RunDatabaseReplicaGet retrieves a read-only replica for a specific database cluster.
RunDatabaseReplicaList retrieves a list of replicas for specific database cluster.
RunDatabaseReplicaPromote promotes a read-only replica to become a primary cluster.
RunDatabaseResize resizes a database cluster.
RunDatabaseSetSQLModes sets the sql modes on the database.
RunDatabaseSlugOptions retrieves a list of the available slugs for a given database engine.
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
RunDatabaseUserCreate creates a database user for a database cluster.
RunDatabaseUserDelete deletes a database user.
RunDatabaseUserGet retrieves a database user for a specific database cluster.
RunDatabaseUserList retrieves a list of users for specific database cluster.
No description provided by the author
RunDatabaseVersionOptions retrieves a list of the available versions for a given database engine.
RunDockerConfig generates credentials and prints a Docker config that can be used to authenticate a Docker client with the registry.
RunDomainCreate runs domain create.
RunDomainDelete deletes a domain by name.
RunDomainGet retrieves a domain by name.
RunDomainList runs domain create.
RunDropletActionChangeBackupPolicy changes backup policy for a droplet.
RunDropletActionChangeKernel changes the kernel for a droplet.
RunDropletActionDisableBackups disables backups for a droplet.
RunDropletActionEnableBackups disables backups for a droplet.
RunDropletActionEnableIPv6 enables IPv6 for a droplet.
RunDropletActionEnablePrivateNetworking enables private networking for a droplet.
RunDropletActionGet returns a droplet action by id.
RunDropletActionPasswordReset resets the droplet root password.
RunDropletActionPowerCycle power cycles a droplet.
RunDropletActionPowerOff turns droplet power off.
RunDropletActionPowerOn turns droplet power on.
RunDropletActionReboot reboots a droplet.
RunDropletActionRebuild rebuilds a droplet using an image id or slug.
RunDropletActionRename renames a droplet.
RunDropletActionResize resizes a droplet giving a size slug and optionally expands the disk.
RunDropletActionRestore restores a droplet using an image id.
RunDropletActions returns a list of actions for a droplet.
RunDropletActionShutdown shuts a droplet down.
RunDropletActionSnapshot creates a snapshot for a droplet.
RunDropletAutoscaleCreate creates an autoscale pool.
RunDropletAutoscaleDelete deletes an autoscale pool.
RunDropletAutoscaleDeleteDangerous deletes an autoscale pool and all underlying members.
RunDropletAutoscaleGet retrieves an autoscale pool.
RunDropletAutoscaleList lists all autoscale pools.
RunDropletAutoscaleListHistory lists autoscale pool history events.
RunDropletAutoscaleListMembers lists autoscale pool members.
RunDropletAutoscaleUpdate updates an autoscale pool.
RunDropletBackups returns a list of backup images for a droplet.
RunDropletCreate creates a droplet.
RunDropletDelete destroy a droplet by id.
RunDropletGet returns a droplet.
RunDropletGetBackupPolicy retrieves a backup policy for a Droplet.
RunDropletKernels returns a list of available kernels for a droplet.
RunDropletList returns a list of droplets.
RunDropletListBackupPolicies list backup policies for all existing Droplets.
RunDropletListSupportedBackupPolicies list all supported backup policies for Droplets.
RunDropletNeighbors returns a list of droplet neighbors.
RunDropletOneClickList retrieves a list of 1-clicks for Droplets.
RunDropletSnapshots returns a list of available kernels for a droplet.
RunDropletTag adds a tag to a droplet.
RunDropletUntag untags a droplet.
RunFirewallAddDroplets adds droplets to a Firewall.
RunFirewallAddRules adds rules to a Firewall.
RunFirewallAddTags adds tags to a Firewall.
RunFirewallCreate creates a new Firewall with a given configuration.
RunFirewallDelete deletes a Firewall by its identifier.
RunFirewallGet retrieves an existing Firewall by its identifier.
RunFirewallList lists Firewalls.
RunFirewallListByDroplet lists Firewalls for a given Droplet.
RunFirewallRemoveDroplets removes droplets from a Firewall.
RunFirewallRemoveRules removes rules from a Firewall.
RunFirewallRemoveTags removes tags from a Firewall.
RunFirewallUpdate updates an existing Firewall with new configuration.
RunFunctionsGet supports the 'serverless functions get' command.
RunFunctionsInvoke supports the 'serverless functions invoke' command.
RunFunctionsList supports the 'serverless functions list' command.
RunGetGarbageCollection gets the specified registry's currently-active garbage collection.
RunGetPartnerInterconnectAttachmentBGPAuthKey get a bgp auth key of existing Partner Interconnect Attachment.
RunGetPartnerInterconnectAttachmentServiceKey retrieves service key of existing Partner Interconnect Attachment.
No description provided by the author
RunImageActionsGet retrieves an action for an image.
RunImageActionsTransfer an image.
RunImagesCreate creates a new custom image.
RunImagesDelete deletes an image.
RunImagesGet retrieves an image by id or slug.
RunImagesList images.
RunImagesListApplication lists application images.
RunImagesListDistribution lists distributions that are available.
RunImagesListUser lists user images.
RunImagesUpdate updates an image.
RunInvoicesGet runs invoice get.
RunInvoicesGetCSV runs an invoice get csv.
RunInvoicesGetPDF runs an invoice get pdf.
RunInvoicesList runs invoice list.
RunInvoicesSummary runs an invoice summary.
RunKeyCreate uploads a SSH key.
RunKeyDelete deletes a key.
RunKeyGet retrieves a key.
RunKeyImport imports a key from a file.
RunKeyList lists keys.
RunKeyUpdate updates a key.
RunKubernetesManifest prints a Kubernetes manifest that provides read/pull access to the registry.
RunKubernetesOneClickInstall installs 1-click apps on a kubernetes cluster.
RunKubernetesOneClickList retrieves a list of 1-clicks for kubernetes.
RunListGarbageCollections gets the specified registry's currently-active garbage collection.
RunListRepositories lists repositories for the registry.
RunListRepositoriesV2 lists repositories for the registry.
RunListRepositoryManifests lists manifests for the repository in a registry.
RunListRepositoryTags lists tags for the repository in a registry.
RunLoadBalancerAddDroplets adds droplets to a load balancer.
RunLoadBalancerAddForwardingRules adds forwarding rules to a load balancer.
RunLoadBalancerCreate creates a new load balancer with a given configuration.
RunLoadBalancerDelete deletes a load balancer by its identifier.
RunLoadBalancerGet retrieves an existing load balancer by its identifier.
RunLoadBalancerList lists load balancers.
RunLoadBalancerPurgeCache purges cache for a global load balancer by its identifier.
RunLoadBalancerRemoveDroplets removes droplets from a load balancer.
RunLoadBalancerRemoveForwardingRules removes forwarding rules from a load balancer.
RunLoadBalancerUpdate updates an existing load balancer with new configuration.
RunNamespacesCreate supports the 'serverless namespaces create' command.
RunNamespacesDelete supports the 'serverless namespaces delete' command.
RunNamespacesList supports the 'serverless namespaces list' command.
RunNamespacesListRegions supports the 'serverless namespaces list-regions' command.
RunOneClickList retrieves a list of 1-clicks by type.
RunPartnerInterconnectAttachmentCreate creates a new Partner Interconnect Attachment with a given configuration.
RunPartnerInterconnectAttachmentDelete deletes an existing Partner Interconnect Attachment by its identifier.
RunPartnerInterconnectAttachmentGet retrieves an existing Partner Interconnect Attachment by its identifier.
RunPartnerInterconnectAttachmentList lists Partner Interconnect Attachment.
RunPartnerInterconnectAttachmentRegenerateServiceKey regenerates a service key of existing Partner Interconnect Attachment.
RunPartnerInterconnectAttachmentRouteList lists Partner Interconnect Attachment routes.
RunPartnerInterconnectAttachmentUpdate updates an existing Partner Interconnect Attachment with new configuration.
RunPluginList is a command for listing available plugins.
RunPluginRun is a command for running a plugin.
RunProjectResourcesAssign assigns a Project Resource.
RunProjectResourcesGet retrieves a Project Resource.
RunProjectResourcesList lists the Projects.
RunProjectsCreate creates a new Project with a given configuration.
RunProjectsDelete deletes a Project with a given configuration.
RunProjectsGet retrieves an existing Project by its identifier.
RunProjectsList lists Projects.
RunProjectsUpdate updates an existing Project with a given configuration.
RunRecordCreate creates a domain record.
RunRecordDelete deletes a domain record.
RunRecordList list records for a domain.
RunRecordUpdate updates a domain record.
RunRegionList all regions.
RunRegistryCreate creates a registry.
RunRegistryDelete delete the registry.
RunRegistryGet returns the registry.
RunRegistryLogin logs in Docker to the registry.
RunRegistryLogout logs Docker out of the registry.
No description provided by the author
RunRepositoryDeleteManifest deletes one or more repository manifests by digest.
RunRepositoryDeleteTag deletes one or more repository tags.
RunReservedIPActionsAssign assigns a reserved IP to a droplet.
RunReservedIPActionsGet retrieves an action for a reserved IP.
RunReservedIPActionsUnassign unassigns a reserved IP to a droplet.
RunReservedIPCreate runs reserved IP create.
RunReservedIPDelete runs reserved IP delete.
RunReservedIPGet retrieves a reserved IP's details.
RunReservedIPList runs reserved IP create.
RunReservedIPv6Create runs reserved IP create.
RunReservedIPv6Delete runs reserved IP delete.
RunReservedIPv6Get retrieves a reserved IP's details.
RunReservedIPv6List runs reserved IP list.
RunReservedIPv6sAssign assigns a reserved IP to a droplet.
RunReservedIPv6sUnassign unassigns a reserved IP to a droplet.
RunServerlessConnect implements the serverless connect command.
RunServerlessExec is a variant of ServerlessExec convenient for calling from stylized command runners Sets up the arguments and (especially) the flags for the actual call.
RunServerlessExecStreaming is like RunServerlessExec but assumes that output will not be captured and can be streamed.
RunServerlessExtraCreate supports the 'serverless init' command.
RunServerlessExtraDeploy supports the 'serverless deploy' command.
RunServerlessExtraGetMetadata supports the 'serverless get-metadata' command.
RunServerlessExtraWatch supports 'serverless watch' This is not the usual boiler-plate because the command is intended to be long-running in a separate window.
RunServerlessInstall performs the network installation of the 'nim' adjunct to support serverless development.
RunServerlessStatus gives a report on the status of the serverless (installed, up to date, connected).
RunServerlessUndeploy implements the 'doctl serverless undeploy' command.
RunServerlessUninstall removes the serverless support and any stored credentials.
RunServerlessUpgrade is a variant on RunServerlessInstall for installing over an existing version when the existing version is inadequate as detected by checkServerlessStatus().
RunSizeList all sizes.
RunSnapshotDelete destroys snapshot(s) by id.
RunSnapshotGet returns a snapshot.
RunSnapshotList returns a list of snapshots.
RunSSH finds a droplet to ssh to given input parameters (name or id).
RunStartGarbageCollection starts a garbage collection for the specified registry.
RunTriggersGet provides the logic for 'doctl sls trig get'.
RunTriggersList provides the logic for 'doctl sls trig list'.
RunTriggerToggle provides the logic for 'doctl sls trig enabled/disabled'.
RunUptimeAlertsCreate creates an uptime alert.
RunUptimeAlertsDelete deletes an uptime alert by ID.
RunUptimeAlertsGet gets an uptime alert by ID.
RunUptimeAlertsList returns a list of uptime alerts.
RunUptimeAlertsUpdate updates an uptime alert by ID.
RunUptimeChecksCreate creates an uptime check.
RunUptimeChecksDelete deletes an uptime check by ID.
RunUptimeChecksGet gets an uptime check by ID.
RunUptimeChecksList returns a list of uptime checks.
RunUptimeChecksUpdate updates an uptime check by ID.
RunVolumeActionsGet returns a Volume Action.
RunVolumeActionsList returns a Volume Action.
RunVolumeAttach attaches a volume to a droplet.
RunVolumeCreate creates a volume.
RunVolumeDelete deletes a volume.
RunVolumeDetach detaches a volume by droplet ID.
RunVolumeGet gets a volume.
RunVolumeList returns a list of volumes.
RunVolumeResize resizes a volume.
RunVolumeSnapshot creates a snapshot of a volume.
RunVPCCreate creates a new VPC with a given configuration.
RunVPCDelete deletes a VPC by its identifier.
RunVPCGet retrieves an existing VPC by its identifier.
RunVPCList lists VPCs.
RunVPCPeeringCreate creates a new VPC Peering with a given configuration.
RunVPCPeeringDelete deletes a VPC Peering by its identifier.
RunVPCPeeringGet retrieves an existing VPC Peering by its identifier.
RunVPCPeeringList lists VPC Peerings.
RunVPCPeeringUpdate updates an existing VPC Peering with new configuration.
RunVPCUpdate updates an existing VPC with new configuration.
Serverless contains support for 'serverless' commands provided by a hidden install of the Nimbella CLI.
ServerlessExec executes a serverless command.
ServerlessExtras adds commands to the 'serverless' subtree for which the cobra wrappers were autogenerated from oclif equivalents and subsequently modified.
Size creates the size commands hierarchy.
Snapshot creates the snapshot command.
SSH creates the ssh commands hierarchy.
SSHKeys creates the ssh key commands hierarchy.
Tags creates the tag commands hierarchy.
Triggers generates the serverless 'triggers' subtree for addition to the doctl command.
UptimeAlert creates the UptimeAlert command.
UptimeCheck creates the UptimeCheck command.
Version creates a version command.
Volume creates the Volume command.
VolumeAction creates the volume command.
VPCPeerings creates the vpc peerings command.
VPCs creates the vpcs command.
# Constants
AppsDevDefaultEnvFile is the default env file path.
DefaultDevConfigFile is the name of the default dev configuration file.
DOSecretOperatorAnnotation is the annotation key so that dosecret operator can do it's magic and help users pull private images automatically in their DOKS clusters.
TokenValidationServer is the default server used to validate an OAuth token.
# Variables
APIURL customize API base URL.
Context current auth context.
DoitCmd is the root level doctl command that all other commands attach to.
ErrExitSilently instructs doctl to exit silently with a bad status code.
ErrUnknownTerminal signifies an unknown terminal.
Interactive toggle interactive behavior.
Output global output format.
Retry settings to pass through to godo.RetryConfig.
No description provided by the author
No description provided by the author
Token global authorization token.
Trace toggles http tracing output.
Verbose toggle verbose output on and off.
Writer wires up stdout for all commands to write to.
# Structs
CmdConfig is a command configuration.
Command is a wrapper around cobra.Command that adds doctl specific functionality.
KubernetesCommandService is used to execute Kubernetes commands.
ShownActivation is what is actually shown as an activation ..
UnknownSchemeError signifies an unknown HTTP scheme.
# Interfaces
KubeconfigProvider allows a user to read from a remote and local Kubeconfig, and write to a local Kubeconfig.
# Type aliases
CmdRunner runs a command and passes in a cmdConfig.
No description provided by the author