canvas groups
canvas groups¶
Manage Canvas groups
Synopsis¶
Manage Canvas groups and group categories.
Groups allow students and instructors to collaborate on projects and activities. Groups can be organized into categories with different self-signup options.
Examples:
canvas groups list --course-id 123
canvas groups get 456
canvas groups categories list --course-id 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")
--quiet Suppress informational messages, only output data and errors
--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 groups activity-stream - Get group activity stream
- canvas groups assignment-override - Get assignment override for a group
- canvas groups categories - Manage group categories
- canvas groups collaborations - List group collaborations
- canvas groups conferences - List group conferences
- canvas groups content-exports - Manage group content exports
- canvas groups create - Create a new group
- canvas groups create-standalone - Create a standalone group (account-level, no category required)
- canvas groups delete - Delete a group
- canvas groups external-feeds - Manage group external feeds
- canvas groups get - Get group details
- canvas groups invite - Invite users to a group
- canvas groups list - List groups
- canvas groups members - Manage group members
- canvas groups memberships - Manage group memberships
- canvas groups permissions - Get group permissions for current user
- canvas groups tabs - List group navigation tabs
- canvas groups update - Update a group
- canvas groups users - Manage group users