Command Reference

This section contains auto-generated documentation for all Canvas CLI commands.

Available Commands

Command	Description
canvas	Root command
canvas accounts	Account management
canvas admins	Account administrator management
canvas analytics	Canvas analytics
canvas announcements	Announcement management
canvas api	Raw API requests
canvas assignment-groups	Assignment group management
canvas assignments	Assignment management
canvas auth	Authentication commands
canvas blueprint	Blueprint course management
canvas cache	Cache management
canvas calendar	Calendar management
canvas config	Configuration management
canvas content-migrations	Content migration management
canvas conversations	Conversations (inbox) management
canvas courses	Course management
canvas discussions	Discussion management
canvas enrollments	Enrollment management
canvas external-tools	External tools (LTI) management
canvas files	File management
canvas grades	Gradebook management
canvas groups	Group management
canvas modules	Module management
canvas outcomes	Learning outcomes management
canvas overrides	Assignment override management
canvas pages	Page management
canvas peer-reviews	Peer review management
canvas planner	Planner management
canvas quizzes	Quiz management
canvas roles	Account role management
canvas rubrics	Rubric management
canvas sections	Course section management
canvas sis-imports	SIS import management
canvas submissions	Submission management
canvas sync	Course synchronization
canvas users	User management
canvas webhook	Webhook server

Global Flags

All commands support the following global flags:

Flag	Description
--config	Config file path (default: $HOME/.canvas-cli/config.yaml)
--instance	Canvas instance URL (overrides config)
-o, --output	Output format: table, json, yaml, csv
-v, --verbose	Enable verbose output
--as-user	Masquerade as another user (admin feature)
--no-cache	Disable caching of API responses

Usage Pattern

canvas <resource> <action> [flags]

For example:

canvas courses list                           # List all courses
canvas assignments get 123 --course-id 456    # Get assignment details
canvas submissions grade 789 --score 95       # Grade a submission