Skip to content

canvas course-nicknames

canvas course-nicknames

Manage course nicknames

Synopsis

Manage nicknames for Canvas courses for the current user.

Examples:

canvas course-nicknames list
canvas course-nicknames get 123
canvas course-nicknames set 123 --nickname "My Fav Course"
canvas course-nicknames delete 123
canvas course-nicknames delete-all

Options

  -h, --help   help for course-nicknames

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")
      --quiet             Suppress informational messages, only output data and errors
      --show-token        Show actual token in dry-run output (default: redacted)
      --sort string       Sort results by field (prefix with - for descending, e.g., -name)
  -v, --verbose           Enable verbose output

SEE ALSO

Auto generated by spf13/cobra on 14-Jul-2026