canvas announcements
canvas announcements¶
Manage Canvas announcements
Synopsis¶
Manage Canvas announcements including listing, viewing, and creating announcements.
Announcements are a special type of discussion topic that appear in the announcements section of a course. They are used for important course updates.
Examples:
canvas announcements list --course-id 123
canvas announcements get --course-id 123 456
canvas announcements create --course-id 123 --title "Welcome!"
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 announcements create - Create a new announcement
- canvas announcements delete - Delete an announcement
- canvas announcements get - Get a specific announcement
- canvas announcements list - List announcements
- canvas announcements update - Update an existing announcement