canvas planner
canvas planner¶
Manage Canvas planner items and notes
Synopsis¶
Manage Canvas planner items, notes, and overrides.
The planner provides a unified view of assignments, quizzes, calendar events, and personal notes. Use this command to view upcoming items or manage notes.
Examples:
canvas planner items
canvas planner notes list
canvas planner notes create --title "Study Session"
canvas planner complete Assignment 123
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 planner complete - Mark an item as complete
- canvas planner dismiss - Dismiss an item from the planner
- canvas planner items - List planner items
- canvas planner notes - Manage planner notes
- canvas planner overrides - List planner overrides