canvas-cli

README

Canvas CLI

A powerful command-line interface for Canvas LMS, built with Go.

Features

• Secure Authentication - OAuth 2.0 with PKCE, system keyring integration
• Multi-Instance - Manage multiple Canvas instances from one CLI
• Smart Rate Limiting - Adaptive throttling based on API quotas
• Multiple Outputs - Table, JSON, YAML, and CSV formats
• Interactive Mode - REPL shell with command history and completion

Architecture

graph TB
    subgraph CLI["CLI Layer"]
        CMD[Cobra Commands]
        REPL[Interactive REPL]
        OUT[Output Formatters]
    end

    subgraph Core["Core Services"]
        API[API Client]
        AUTH[OAuth + PKCE]
        CACHE[Smart Cache]
        BATCH[Batch Processor]
    end

    subgraph Storage["Storage Layer"]
        KEYRING[System Keyring]
        CONFIG[Config Manager]
        ENCRYPT[AES-256 Fallback]
    end

    CMD --> API
    REPL --> CMD
    CMD --> OUT
    API --> AUTH
    API --> CACHE
    API --> BATCH
    AUTH --> KEYRING
    AUTH --> ENCRYPT
    CONFIG --> Storage

    API <-->|REST| CANVAS[(Canvas LMS API)]

Quick Start

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

# Authenticate
canvas auth login https://your-school.instructure.com

# Start using
canvas courses list
canvas assignments list 12345
canvas shell  # Interactive mode

Command Overview

Category	Commands
Auth	login, logout, status
Courses	list, get, users
Assignments	list, get, create, update, bulk-update
Submissions	list, get, grade, bulk-grade
Users	me, list, get, create, update
Modules	list, get, create, update, delete, items
Pages	list, get, create, update, delete, front
Discussions	list, get, create, entries, post, reply
Announcements	list, get, create, update, delete
Calendar	list, get, create, update, delete
Planner	items, notes, complete, dismiss
Files	upload, download
Utilities	shell, doctor, webhook, version

Documentation

Guide	Description
Installation	Build from source, platform-specific setup
Authentication	OAuth setup, multi-instance, security
Commands	Complete reference with all flags
Examples	Workflows, automation, scripting
Architecture	Design decisions, internals

Configuration

# ~/.canvas-cli/config.yaml
default_instance: myschool
instances:
  myschool:
    url: https://myschool.instructure.com
    client_id: your-client-id
settings:
  default_output_format: table
  cache_enabled: true

See Authentication Guide for detailed setup.

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

MIT License

---

Built for the Canvas LMS community. Based on the Canvas REST API.