canvas modules
canvas modules¶
Manage Canvas course modules
Synopsis¶
Manage Canvas course modules including listing, viewing, creating, and updating modules.
Modules are collections of learning materials useful for organizing courses and optionally providing a linear flow through them. Module items can be accessed linearly or sequentially depending on module configuration.
Examples:
canvas modules list --course-id 123
canvas modules get --course-id 123 456
canvas modules create --course-id 123 --name "Week 1"
canvas modules items list --course-id 123 --module-id 456
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 modules create - Create a new module
- canvas modules delete - Delete a module
- canvas modules get - Get details of a specific module
- canvas modules items - Manage module items
- canvas modules list - List modules in a course
- canvas modules publish - Publish a module
- canvas modules relock - Re-lock module progressions
- canvas modules unpublish - Unpublish a module
- canvas modules update - Update an existing module