@lukeguo12210/canvas-cli 0.0.1 → 0.0.2

package/skills/canvas-files/SKILL.md

@@ -15,12 +15,14 @@ Before using this skill, read `../canvas-shared/SKILL.md`.
 ## Commands
 
 ```bash
-canvas files list --course-id <course-id>
-canvas files show <file-id>
-canvas files download <file-id> --out <dir>
-canvas files download-linked --course-id <course-id> --out <dir>
-canvas folders list --course-id <course-id>
-canvas folders path --course-id <course-id> --path <path>
+canvas files list --course-id <course-id> --page-all --format json
+canvas files list --folder-id <folder-id> --page-all --format json
+canvas files list --group-id <group-id> --page-all --format json
+canvas files show <file-id> --format json
+canvas files download <file-id> --out <dir> --format json
+canvas files download-linked --course-id <course-id> --out <dir> --format json
+canvas folders list --course-id <course-id> --page-all --format json
+canvas folders path --course-id <course-id> --path <path> --format json
 ```
 
 ## Rules
@@ -30,3 +32,10 @@ canvas folders path --course-id <course-id> --path <path>
 - Preserve Canvas display names in metadata.
 - Record source API URL and source HTML URL in manifests.
 - Never write downloaded files outside the requested output directory.
+
+## Current Behavior
+
+- `files list` returns metadata only; it does not download bytes.
+- `files download` writes one file to the requested output directory.
+- `files download-linked` currently downloads file IDs discoverable from module file items and assignment attachments when Canvas exposes them.
+- Folder commands are separate top-level commands: use `canvas folders ...`, not `canvas files folders ...`.

package/skills/canvas-modules/SKILL.md

@@ -30,11 +30,11 @@ Common module item types:
 ## Commands
 
 ```bash
-canvas modules list --course-id <course-id>
-canvas modules list --course-id <course-id> --include items,content_details
-canvas modules items --course-id <course-id> --module-id <module-id>
-canvas modules item --course-id <course-id> --module-id <module-id> --item-id <item-id>
-canvas modules export --course-id <course-id> --module-id <module-id> --out <dir>
+canvas modules list --course-id <course-id> --page-all --format json
+canvas modules list --course-id <course-id> --include items,content_details --page-all --format json
+canvas modules items --course-id <course-id> --module-id <module-id> --page-all --format json
+canvas modules item --course-id <course-id> --module-id <module-id> --item-id <item-id> --format json
+canvas modules export --course-id <course-id> --module-id <module-id> --out <dir> --format json
 ```
 
 ## Notes

package/skills/canvas-pages/SKILL.md

@@ -0,0 +1,28 @@
+---
+name: canvas-pages
+version: 0.1.0
+description: "Canvas LMS pages: list course pages, inspect page HTML, and export visible pages for local review workflows."
+metadata:
+  requires:
+    bins: ["canvas"]
+  cliHelp: "canvas pages --help"
+---
+
+# canvas-pages
+
+Before using this skill, read `../canvas-shared/SKILL.md`.
+
+## Commands
+
+```bash
+canvas pages list --course-id <course-id> --page-all --format json
+canvas pages list --course-id <course-id> --search "syllabus" --format json
+canvas pages show --course-id <course-id> --page <page-url> --format json
+canvas pages export --course-id <course-id> --page <page-url> --out <dir> --format json
+```
+
+## Notes
+
+- Canvas page identifiers are usually URL slugs such as `syllabus`, not numeric IDs.
+- Page bodies are Canvas HTML. Preserve the original HTML in exports.
+- Locked pages should be reported as locked, not treated as fatal when traversing a whole course.

package/skills/canvas-review/SKILL.md

@@ -16,7 +16,7 @@ Before using this skill, read `../canvas-shared/SKILL.md`.
 
 Before creating a review pack:
 
-1. Inspect `canvas context show`.
+1. Inspect `canvas courses overview <course-id>`.
 2. Resolve the target course ID.
 3. Use `canvas review pack`.
 
@@ -24,10 +24,7 @@ Before creating a review pack:
 
 ```bash
 canvas review pack --course-id <course-id> --out <dir>
-canvas review pack --course "<course name or code>" --out <dir>
-canvas review pack --course-id <course-id> --module <module-id-or-name> --out <dir>
-canvas review index --path <pack-dir>
-canvas review search --path <pack-dir> --query <query>
+canvas review pack --course-id <course-id> --out <dir> --include-all-files
 ```
 
 ## Review Pack Rules
@@ -38,3 +35,15 @@ canvas review search --path <pack-dir> --query <query>
 - Default excludes grades, submissions, conversations, and group member lists.
 - Record unavailable, locked, external, or skipped resources as warnings.
 - Always cite Canvas source URLs in `citations.json`.
+
+## Current Behavior
+
+The current pack command writes JSON files:
+
+- `manifest.json`
+- `course.json`
+- `modules.json`
+- `assignments.json`
+- `pages.json`
+
+It includes visible course metadata, tabs, modules, assignments, and pages. With `--include-all-files`, it also includes visible file metadata. It does not yet write `citations.json`, build a search index, or download all file bytes.

package/skills/canvas-shared/SKILL.md

@@ -12,6 +12,36 @@ metadata:
 
 Read this skill before using any other Canvas skill.
 
+## CLI Availability
+
+First try:
+
+```bash
+canvas auth status --format json
+```
+
+If the shell returns `command not found: canvas`, the CLI is not on `PATH`.
+
+Use this non-global fallback inside an agent session:
+
+```bash
+npm exec --yes --package @lukeguo12210/canvas-cli -- canvas auth status --format json
+```
+
+When using the fallback, replace the leading `canvas` in any command with:
+
+```bash
+npm exec --yes --package @lukeguo12210/canvas-cli -- canvas
+```
+
+For permanent install, tell the user:
+
+```bash
+npm install -g @lukeguo12210/canvas-cli
+```
+
+If global install fails with `EACCES` under `/usr/local`, do not use `sudo` or create symlinks in `/usr/local`. Ask the user to configure a user-level npm prefix, use a Node version manager, or continue with the `npm exec` fallback for this session.
+
 ## Current CLI Surface
 
 Implemented now:
@@ -26,13 +56,18 @@ Implemented now:
 - `canvas courses show <course-id>`
 - `canvas courses overview <course-id>`
 - `canvas tabs list --course-id <course-id>`
+- `canvas review pack`
+- `canvas api get`
+- `canvas modules list/items/item/export`
+- `canvas assignments list/show/export`
+- `canvas pages list/show/export`
+- `canvas files list/show/download/download-linked`
+- `canvas folders list/path`
 
 Planned but not implemented yet:
 
 - `canvas context show`
-- `canvas review pack`
-- `canvas api get`
-- modules, pages, files, assignments, grades, submissions, discussions, calendar, groups, conversations
+- grades, submissions, discussions, calendar, groups, conversations
 
 ## Core Rules
 
@@ -79,4 +114,5 @@ Do not include those in review packs unless the user explicitly asks.
 canvas auth status --format json
 canvas courses list --active --page-all --format json
 canvas courses search "course name" --format json
+canvas courses overview <course-id> --format json
 ```

package/skills/canvas-shared/references/auth.md

@@ -10,6 +10,15 @@ canvas config show --format json
 canvas me --format json
 ```
 
+If `canvas` is not on `PATH`, use the npm exec fallback:
+
+```bash
+npm exec --yes --package @lukeguo12210/canvas-cli -- canvas auth status --format json
+npm exec --yes --package @lukeguo12210/canvas-cli -- canvas auth login
+```
+
+Do not attempt `sudo npm install -g` from inside an agent session. Prefer the fallback above or ask the user to fix their npm global prefix.
+
 ## Login Flow
 
 `canvas auth login` is interactive.