Getting Started

Welcome to Canvas CLI! This guide will help you get up and running quickly.

Overview

Canvas CLI is a command-line interface for interacting with Canvas LMS. It provides comprehensive access to Canvas API features including:

• Course management
• Assignment and submission handling
• User management
• Module and page management
• File operations
• Calendar and planner integration

Quick Setup

1. Install Canvas CLI using your preferred method
2. Authenticate with your Canvas instance
3. Start using commands to interact with Canvas

Next Steps

• Installation

  ---

  Multiple installation methods including Homebrew, Go, and binary downloads

  Install now

• Authentication

  ---

  Set up OAuth authentication with your Canvas instance

  Authenticate

• Quick Start

  ---

  Get started with common commands in 5 minutes

  Quick start

Requirements

• Go 1.21+ (if installing from source)
• Canvas LMS account with API access
• API Token or OAuth credentials