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")
--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 account-analytics - View Canvas account-level analytics
- canvas account-calendars - Manage Canvas account calendars
- canvas account-content-migrations - Manage account-level content migrations
- canvas account-ext-tools-favorites - Manage account external tool (LTI) favorites
- canvas account-features - Manage Canvas account feature flags and settings
- canvas account-logins - Manage Canvas account logins
- canvas account-notifications - Manage Canvas account notifications
- canvas account-reports - Manage Canvas account reports
- canvas accounts - Manage Canvas accounts
- canvas admins - Manage account administrators
- canvas agent - Helpers for running canvas under an AI agent
- canvas alias - Manage command aliases
- canvas analytics - View Canvas analytics
- canvas announcements - Manage Canvas announcements
- canvas api - Make raw API requests to Canvas
- canvas appointment-groups - Manage Canvas appointment groups
- canvas assignment-groups - Manage Canvas assignment groups
- canvas assignments - Manage Canvas assignments
- canvas audit - View Canvas audit logs
- canvas auth - Manage authentication with Canvas
- canvas auth-providers - Manage Canvas authentication providers
- canvas blackout-dates - Manage course blackout dates
- canvas blueprint - Manage blueprint courses
- canvas bookmarks - Manage Canvas bookmarks
- canvas brand - View Canvas brand/theme variables
- canvas cache - Manage Canvas CLI cache
- canvas calendar - Manage Canvas calendar events
- canvas collaborations - Manage Canvas collaborations
- canvas comm-channels - Manage communication channels
- canvas comm-messages - List Canvas communication messages
- canvas completion - Generate shell completion scripts
- canvas conferences - List Canvas web conferences
- canvas config - Manage Canvas CLI configuration
- canvas content-exports - Manage course content exports
- canvas content-migrations - Manage content migrations
- canvas content-shares - Manage content shares
- canvas context - Manage working context (course, assignment, user IDs)
- canvas conversations - Manage Canvas conversations (inbox)
- canvas course-extensions - Manage course extensions (quiz and assignment)
- canvas course-features - Manage course feature flags
- canvas course-nicknames - Manage course nicknames
- canvas course-pacing - Manage course pacing
- canvas course-settings - Manage course settings and utilities
- canvas courses - Manage Canvas courses
- canvas csp-settings - Manage Canvas Content Security Policy settings
- canvas developer-keys - Manage Canvas developer keys
- canvas discussions - Manage Canvas discussion topics
- canvas doctor - Run system diagnostics
- canvas enrollment-terms - Manage Canvas enrollment terms
- canvas enrollments - Manage Canvas enrollments
- canvas eportfolios - Manage Canvas ePortfolios
- canvas epub-exports - Manage Canvas ePub exports
- canvas error-reports - Submit Canvas error reports
- canvas external-tools - Manage external tools (LTI)
- canvas favorites - Manage Canvas favorites
- canvas files - Manage Canvas files
- canvas folders - Manage Canvas file folders
- canvas grades - Manage Canvas gradebook
- canvas grading-period-sets - Manage Canvas grading period sets and grading periods
- canvas grading-periods - Manage course grading periods
- canvas grading-standards - Manage course grading standards
- canvas groups - Manage Canvas groups
- canvas history - View Canvas user page-view history
- canvas jwts - Create and refresh Canvas JWTs
- canvas live-assessments - Manage course live assessments
- canvas mcp - MCP server management
- canvas media - Manage Canvas media objects and attachments
- canvas modules - Manage Canvas course modules
- canvas observees - Manage user observees and observers
- 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 polls - Manage Canvas polls
- canvas progress - Manage Canvas background job progress
- canvas quizzes - Manage Canvas quizzes
- canvas repl - Start interactive REPL mode
- canvas roles - Manage account roles
- canvas rubric-associations - Manage rubric associations and assessments
- canvas rubrics - Manage Canvas rubrics
- canvas sections - Manage Canvas course sections
- canvas sis-imports - Manage SIS imports
- canvas skills - Install this CLI's AI-agent skill into Claude, Cursor, and other agents
- canvas submissions - Manage Canvas submissions
- canvas sync - Synchronize resources between Canvas instances
- canvas telemetry - Manage telemetry settings
- canvas temporary-enrollment-pairings - Manage Canvas temporary enrollment pairings
- canvas update - Check for and install updates
- canvas user-features - Manage user feature flags
- canvas users - Manage Canvas users
- canvas version - Display version information
- canvas webhook - Manage Canvas webhook listeners