canvas alias
canvas alias¶
Manage command aliases
Synopsis¶
Create, list, and delete custom command aliases.
Aliases allow you to create shortcuts for frequently used commands. They can include flags and arguments.
Examples:
# Create an alias
canvas alias set ca "assignments list --course-id 123"
# Use the alias
canvas ca
# Create an alias with multiple flags
canvas alias set ungraded "assignments list --course-id 123 --bucket ungraded"
# List all aliases
canvas alias list
# Delete an alias
canvas alias delete ca
Options¶
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)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas alias delete - Delete an alias
- canvas alias list - List all aliases
- canvas alias set - Create or update an alias