canvas calendar
canvas calendar¶
Manage Canvas calendar events
Synopsis¶
Manage Canvas calendar events including listing, viewing, creating, and updating events.
Calendar events can be associated with courses, groups, users, or accounts. Use context codes to specify which calendars to query.
Examples:
canvas calendar list --course-id 123
canvas calendar list --start-date 2024-01-01 --end-date 2024-12-31
canvas calendar get 456
canvas calendar create --course-id 123 --title "Team Meeting"
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 calendar create - Create a new calendar event
- canvas calendar delete - Delete a calendar event
- canvas calendar get - Get a specific calendar event
- canvas calendar list - List calendar events
- canvas calendar reserve - Reserve a time slot
- canvas calendar update - Update an existing calendar event