doctl Verified current stable Not installed? Documentation

Doctl / Display Help

Display Help

Displays detailed help information for account commands.

$
Terminal
doctl account -h

When To Use

When initially familiarizing with `doctl` account management.

Pro Tip

Use `--all` flag for comprehensive output including usage examples.

Terminal Output

Expected runtime feedback

Simulated preview
>
Output
$ doctl account --help

Usage: doctl account [flags]

Flags:
  -h, --help   help for account

Available Commands:
  get          Get account information
  list         List all accounts
  update       Update account settings

Global Flags:
  -v, --verbose   Enable verbose output
  -q, --quiet     Suppress output

Anatomy of Output

Understanding the result

Usage: doctl account [command] General usage

Indicates that `account` is a sub-command.

Available Commands: retrieve-account-info, show-api-rate-limit Commands List

Lists all sub-commands.

Flags: --help, -h Flags

Common flags for help and usage.

Power User Variants

Optimized versions

doctl account help --verbose

Detailed help output.

doctl account --help --all

Comprehensive help with extended usage scenarios.

Troubleshooting

Common pitfalls

Error: No help available for that command

Solution: Check the command spelling; ensure the command exists.

Error: Unknown command 'foo'

Solution: Verify the list of available commands using doctl account --help.

Error: malformed flags

Solution: Review flag syntax and ensure valid options.

Command Breakdown

What each part is doing

doctl
Base Command
The executable that performs this operation. Here it runs Doctl before the shell applies any redirect operators.
-h
h| help
The value supplied for h| help.
-h
Command Option
Tool-specific option used by this command invocation.

How To Run

Execution path

  1. Step 1

    Run `doctl account --help` to view available commands.

  2. Step 2

    Use `doctl account get` to retrieve your account information.

Alternative Approaches

Comparable commands in other tools

Alternative documentation tools for the same job.