canvas doctor

canvas doctor

Run system diagnostics

Synopsis

Run diagnostic checks to verify Canvas CLI configuration and connectivity.

The doctor command performs the following checks: - Environment (OS, architecture, Go version) - Configuration (base URL, access token) - Connectivity (network connection to Canvas) - Authentication (API token validation) - API Access (Canvas API availability) - Disk Space (cache directory availability) - Permissions (file and directory permissions)

Examples:

# Run all diagnostic checks
canvas doctor

# Run with verbose output
canvas doctor --verbose

# Output results as JSON
canvas doctor --json

canvas doctor [flags]

Options

  -h, --help      help for doctor
      --json      Output results as JSON
  -v, --verbose   Show detailed output

Options inherited from parent commands

      --as-user int       Masquerade as another user (admin feature, requires permission)
      --columns strings   Select specific columns to display (comma-separated)
      --config string     config file (default is $HOME/.canvas-cli/config.yaml)
      --dry-run           Print curl commands instead of executing requests
      --filter string     Filter results by text (case-insensitive substring match)
      --instance string   Canvas instance URL (overrides config)
      --limit int         Limit number of results for list operations (0 = unlimited)
      --no-cache          Disable caching of API responses
  -o, --output string     Output format: table, json, yaml, csv (default "table")
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)

SEE ALSO

• canvas - Canvas LMS CLI - Interact with Canvas from the command line

Auto generated by spf13/cobra on 25-Jan-2026