canvas
canvas¶
Canvas LMS CLI - Interact with Canvas from the command line
Synopsis¶
canvas-cli is a powerful command-line interface for Canvas LMS. It provides comprehensive access to Canvas API features including courses, assignments, users, submissions, and more.
Examples:
canvas auth login # Authenticate with Canvas
canvas courses list # List all courses
canvas assignments list --course-id 123 # List assignments for a course
canvas submissions bulk-grade --course-id 123 --csv grades.csv # Bulk grade from CSV
Options¶
--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)
-h, --help help for canvas
--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 accounts - Manage Canvas accounts
- canvas admins - Manage account administrators
- canvas alias - Manage command aliases
- canvas analytics - View Canvas analytics
- canvas announcements - Manage Canvas announcements
- canvas api - Make raw API requests to Canvas
- canvas assignment-groups - Manage Canvas assignment groups
- canvas assignments - Manage Canvas assignments
- canvas auth - Manage authentication with Canvas
- canvas blueprint - Manage blueprint courses
- canvas cache - Manage Canvas CLI cache
- canvas calendar - Manage Canvas calendar events
- canvas completion - Generate shell completion scripts
- canvas config - Manage Canvas CLI configuration
- canvas content-migrations - Manage content migrations
- canvas context - Manage working context (course, assignment, user IDs)
- canvas conversations - Manage Canvas conversations (inbox)
- canvas courses - Manage Canvas courses
- canvas discussions - Manage Canvas discussion topics
- canvas doctor - Run system diagnostics
- canvas enrollments - Manage Canvas enrollments
- canvas external-tools - Manage external tools (LTI)
- canvas files - Manage Canvas files
- canvas grades - Manage Canvas gradebook
- canvas groups - Manage Canvas groups
- canvas modules - Manage Canvas course modules
- canvas outcomes - Manage Canvas learning outcomes
- canvas overrides - Manage Canvas assignment overrides
- canvas pages - Manage Canvas wiki pages
- canvas peer-reviews - Manage peer reviews
- canvas planner - Manage Canvas planner items and notes
- canvas quizzes - Manage Canvas quizzes
- canvas repl - Start interactive REPL mode
- canvas roles - Manage account roles
- canvas rubrics - Manage Canvas rubrics
- canvas sections - Manage Canvas course sections
- canvas shell - Start interactive shell (REPL mode)
- canvas sis-imports - Manage SIS imports
- canvas submissions - Manage Canvas submissions
- canvas sync - Synchronize resources between Canvas instances
- canvas telemetry - Manage telemetry settings
- canvas update - Check for and install updates
- canvas users - Manage Canvas users
- canvas version - Display version information
- canvas webhook - Manage Canvas webhook listeners