Skip to content

Home

Canvas CLI

A powerful command-line interface for Canvas LMS

Go Version License Release

Features

  • 80% API Coverage - 876 of Canvas's 1086 documented endpoints, spec-verified in CI against the official Canvas API spec
  • Multiple Output Formats - Table, JSON, YAML, and CSV output
  • Bulk Operations - Grade submissions in bulk from CSV files
  • Course Synchronization - Sync content between Canvas instances
  • Intelligent Caching - Fast responses with automatic cache invalidation
  • Secure Authentication - OAuth 2.0 with PKCE flow (confidential or secret-less public clients), tokens stored in your system keyring
  • MCP Integration - Use Canvas CLI as an MCP server for AI coding assistants
  • AI Agent Skill - Bundled skill that teaches Claude Code, Cursor, and other agents how to drive the CLI
  • Agent Safety - canvas agent guard generates safety config so AI agents can read freely but need approval to write
  • Docker Image - Distroless image on GHCR for containerized and CI usage
  • Signed Releases - cosign-signed checksums and SBOMs on every release

Quick Start

brew tap jjuanrivvera/canvas-cli
brew install canvas-cli

go install github.com/jjuanrivvera/canvas-cli/cmd/canvas@latest

docker run --rm ghcr.io/jjuanrivvera/canvas-cli:latest version

Download the latest release from GitHub Releases. Checksums are signed with cosign — see Installation for verification steps.

Then authenticate with Canvas:

canvas auth login

Example Usage

# List your courses
canvas courses list

# List assignments for a course
canvas assignments list --course-id 123

# Grade a submission
canvas submissions grade --course-id 123 --assignment-id 456 --user-id 789 --score 95

# Bulk grade from CSV
canvas submissions bulk-grade --course-id 123 --csv-file grades.csv

# Export data as JSON
canvas users list --course-id 123 --output json

Documentation

  • Getting Started

    Install Canvas CLI and authenticate with your Canvas instance

    Installation

  • User Guide

    Learn how to configure and use Canvas CLI effectively

    User Guide

  • Command Reference

    Complete reference for all available commands

    Commands

  • Tutorials

    Step-by-step guides for common workflows

    Tutorials

  • AI Agent Skill

    Teach Claude Code, Cursor, and other AI agents to drive Canvas CLI

    Agent Skill

  • Agent Safety

    Generate guardrails so AI agents can read Canvas freely but need approval to write

    Agent Safety

Support

License

Canvas CLI is released under the MIT License.