Canvas Skill
Use this skill to operate the canvas CLI and manage Canvas course content with Codex.
Core workflow
- •Identify course with
canvas coursesif needed. - •Pull only the target content (
canvas pull ...). - •Edit local files while preserving frontmatter IDs.
- •Preview with
canvas push ... --dry-run. - •Push real changes only after confirmation.
Key commands
bash
# Discovery canvas courses canvas modules "COURSE" canvas items "COURSE" "MODULE" canvas rubrics "COURSE" # Pull canvas pull "COURSE" -a "Assignment Name" canvas pull "COURSE" -p "Page Name" canvas pull "COURSE" -m "Module Name" canvas pull "COURSE" -d "Discussion Name" canvas pull "COURSE" --rubrics canvas pull "COURSE" -a "Assignment Name" --submissions ungraded --discussions # Push (safe sequence) canvas push -f "path/to/file.md" --dry-run canvas push -f "path/to/file.md" canvas push -m "ModuleName" --dry-run canvas push -m "ModuleName"
Guardrails
- •Always offer
--dry-runbefore any mutating command. - •Keep
canvas_idfields in frontmatter/YAML. - •Confirm before real push to production courses.
- •Prefer targeted updates (
--file) over broad pushes when feasible.
Local structure
- •Routing is controlled by
.canvas-config.yamlcourse_folders+default_folder. - •Standard course names become folders like
SP26-ENGL-101-codex-course. - •Pulled content typically lands in
assignments/,pages/,discussions/,rubrics/,submissions/.
Playbooks
Use references/faculty-playbooks.md for common faculty/staff tasks and prompt patterns.