What is canvas-cli AGENTS.md?

Repository instructions for Canvas CLI, a Go command-line program that communicates with the Canvas learning-management system. They document its build, test, formatting, linting, installation, setup, and project structure.

Use them when building, testing, linting, formatting, installing, or preparing Git hooks for Canvas CLI.

They give coding agents the exact commands and checks expected in this repository. Pre-commit checks also help catch formatting problems, static-analysis warnings, test failures, and race conditions before a commit.

How jjuanrivvera/canvas-cli configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to jjuanrivvera/canvas-cli. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/jjuanrivvera/canvas-cli/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/jjuanrivvera/canvas-cli

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/jjuanrivvera/canvas-cli/agents-md/github.svg)](https://agentmods.dev/instructions/jjuanrivvera/canvas-cli/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/jjuanrivvera/canvas-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/jjuanrivvera/canvas-cli/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/jjuanrivvera/canvas-cli/agents-md"><img src="https://agentmods.dev/badge/instructions/jjuanrivvera/canvas-cli/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 2,825 This file is loaded in full into every session.

When invoked 2,825 The same file — it is already loaded in full.

Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.02825	$0.02825
Opus 5.5	$0.01130	$0.01130
Sonnet 5.5	$0.00565	$0.00565
Haiku 4.5	$0.00282	$0.00282

Measured 2mo ago against content hash f62f85df30af, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

canvas-cli AGENTS.md scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

dryrun/ → --dry-run curl rendering

AGENTS.md · 370 lines

How it starts

The opening of the file, as written. The whole thing — 370 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This file provides guidance to AI agents (Claude Code, Cursor, Copilot, etc.) when working with code in this repository.

Build & Development Commands

# Build
make build              # Build binary to bin/canvas
make dev                # Build with fmt and vet

# Test
make test               # Run all tests
make test-coverage      # Run tests with coverage report
go test -v ./internal/api/...  # Run specific package tests
go test -v -run TestName ./... # Run single test

# Lint & Format
make fmt                # Format code
make lint               # Run golangci-lint
make vet                # Run go vet

# Install
make install            # Install to /usr/local/bin
make uninstall          # Remove from /usr/local/bin

# Setup
make setup-hooks        # Install git pre-commit hooks

Pre-commit Hook

Run make setup-hooks to enable. Runs automatically on each commit:

gofmt - formatting check
golangci-lint - comprehensive linting (if installed)
go vet - static analysis
go test -short -race - quick test pass with race detector

Architecture

Canvas CLI is a Go CLI for Canvas LMS API, built with Cobra/Viper.

Project Structure

cmd/canvas/     → Entry point (main.go)
commands/       → Cobra command definitions (one file per resource)
  internal/
    options/    → Option structs for commands (eliminates global state)
    logging/    → Structured logging for commands
internal/
  api/          → Canvas API client + service layer (Client, *Service structs)
  auth/         → OAuth 2.0 + PKCE, token storage (keyring/encrypted file)
  config/       → Viper-based configuration management
  cache/        → Response caching with TTL
  batch/        → Concurrent batch operations (worker pool)
  diagnostics/  → canvas doctor checks
  dryrun/       → --dry-run curl rendering
  output/       → Formatters (table, JSON, YAML, CSV)
  progress/     → Progress indicators
  repl/         → Interactive shell
  shellparse/   → Shell-style argument parsing
  telemetry/    → Opt-in usage telemetry
  terminal/     → Terminal capabilities
  update/       → Self-update checks
  webhook/      → Webhook listener
testdata/spec/  → Committed Canvas API spec manifest
tools/          → Code generators (gendocs, speccheck)
.ai/            → Canvas LMS API documentation (gitignored)

Read the full file on GitHub · 370 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 370 lines · 2,825 tokens per session scan A f62f85df30af

Subscribe to this mod's changes

canvas-cli AGENTS.md is an instructions file published in the GitHub repository jjuanrivvera/canvas-cli (20 stars, last pushed yesterday), licensed MIT. It adds 2,825 tokens to every session, about $0.0113 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Go canvas-cli canvas-lms canvas-lms-api cli go

canvas-cli AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
canvas-cli AGENTS.mdjjuanrivvera/canvas-cli	Instructions file	20	yesterday	MIT	A	2,825	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

canvas-cli: Instructions file for Codex