@mo7yw4ng/openape 1.0.2 → 1.0.4

package/skills/openape/SKILL.md

@@ -1,331 +1,113 @@
 ---
 name: openape
-description: How to use OpenApe CLI — automate CYCU iLearning (Moodle) tasks including course management, video progress tracking, quizzes, materials, grades, forums, announcements, and calendar
+description: "CYCU iLearning (Moodle): Manage courses, videos, quizzes, materials, grades, forums, announcements, and calendar."
+metadata:
+  openclaw:
+    category: "education"
+    requires:
+      bins:
+        - openape
+    cliHelp: "openape --help"
 ---
 
-# OpenApe CLI
+# openape
 
-Use the `openape` command to access CYCU iLearning (Moodle) platform. OpenApe provides automation for course management, video progress completion, quiz tracking, material downloads, grade viewing, forum discussions, announcements, and calendar events.
-
-## Setup
-
-Install via npm:
-```bash
-npm install -g @mo7yw4ng/openape
-```
-
-Or run without installing:
-```bash
-npx @mo7yw4ng/openape --help
-```
-
-Or install via Deno/JSR:
-```bash
-deno install -A -g -n openape jsr:@openape/openape
-```
-
-If not authenticated, run:
-```bash
-openape login
-```
-A browser will open for Microsoft OAuth SSO. Complete MFA login manually — no username/password input needed in the terminal.
-
-Session is saved to `.auth/storage-state.json` and persists between runs. If session expires, run `openape login` again.
-
-## Discovering Commands
-
-Every command supports `--help` for full option details:
-```bash
-openape --help
-openape courses --help
-openape videos complete --help
-```
-
-Add `--output json` to any command for machine-readable output. Use `--output csv` for spreadsheet format, `--output table` for human-readable tables, or `--output silent` to suppress output.
-
-## Course Commands
-
-### Listing courses
-
-```bash
-# List in-progress courses (default)
-openape courses list
-
-# List all courses including past and future
-openape courses list --level all
-
-# List only past courses
-openape courses list --level past
-
-# List only future courses
-openape courses list --level future
-```
-
-Course levels: `in_progress` (default), `past`, `future`, `all`.
-
-### Course information
-
-```bash
-# Get detailed course information
-openape courses info <course-id>
-
-# Get course progress percentage
-openape courses progress <course-id>
-
-# Get course syllabus from CMAP (18-week schedule)
-openape courses syllabus <course-id>
-```
-
-## Video Commands
-
-### Listing videos
+> **PREREQUISITE:** Install and login first:
+>
+> ```bash
+> npm install -g @mo7yw4ng/openape
+> openape login
+> ```
 
 ```bash
-# List all videos in a course
-openape videos list <course-id>
-
-# List only incomplete videos (browser mode only)
-openape videos list <course-id> --incomplete-only
-```
-
-### Completing videos
-
-```bash
-# Complete all incomplete videos in a course
-openape videos complete <course-id>
-
-# Dry-run: discover videos without completing
-openape videos complete <course-id> --dry-run
-
-# Complete all incomplete videos across all courses
-openape videos complete-all
-
-# Dry-run all courses
-openape videos complete-all --dry-run
+openape <command> [subcommand] [args] [flags]
 ```
 
-**Note:** Video completion forges SuperVideo progress AJAX calls to simulate watching the entire video. The server accepts the progress but completion status may take time to update in the course state.
+## Commands
 
-### Downloading videos
+### courses — Course operations
 
-```bash
-# Download all videos from a course
-openape videos download <course-id>
+  - `list` — List enrolled courses. Flags: `--level in_progress|past|future|all`
+  - `info <course-id>` — Show detailed course information
+  - `progress <course-id>` — Show course completion progress
+  - `syllabus <course-id>` — Show course syllabus (from CMAP)
 
-# Download only incomplete videos
-openape videos download <course-id> --incomplete-only
+### videos — Video progress operations
 
-# Specify output directory (default: ./downloads/videos)
-openape videos download <course-id> --output-dir ./my-videos
-```
+  - `list <course-id>` — List videos in a course. Flags: `--incomplete-only`
+  - `complete <course-id>` — Complete all videos in a course
+  - `complete-all` — Complete all incomplete videos across all courses. Flags: `--dry-run`
+  - `download <course-id>` — Download videos from a course. Flags: `--output-dir <path>`
 
-## Quiz Commands
+### quizzes — Quiz operations
 
-### Listing quizzes
+  - `list <course-id>` — List incomplete quizzes in a course
+  - `list-all` — List all incomplete quizzes across courses. Flags: `--level in_progress|all`
+  - `start <quiz-id>` — Start a new quiz attempt
+  - `info <attempt-id>` — Get quiz attempt data and questions. Flags: `--page <number>`
+  - `save <attempt-id> '<answers-json>'` — Save answers for a quiz attempt. JSON format: `[{"slot":1,"answer":"0"}]`. Multichoice: number, multichoices: `"0,2"`, shortanswer: text
 
-```bash
-# List quizzes in a specific course
-openape quizzes list <course-id>
+### materials — Material/resource operations
 
-# List all quizzes across all courses
-openape quizzes list-all
+  - `list-all` — List all materials across courses. Flags: `--level in_progress|all`
+  - `download <course-id>` — Download all materials from a course
+  - `download-all` — Download all materials from all courses. Flags: `--output-dir <path>`
+  - `complete <course-id>` — Mark all incomplete resources (non-video) as complete
+  - `complete-all` — Mark all incomplete resources across all in-progress courses
 
-# List only in-progress course quizzes
-openape quizzes list-all --level in_progress
-```
+### assignments — Assignment operations
 
-### Opening quizzes
+  - `list <course-id>` — List assignments in a course
+  - `list-all` — List all assignments across courses. Flags: `--level in_progress|all`
+  - `status <assignment-id>` — Check assignment submission status
+  - `submit <assignment-id>` — Submit an assignment. Flags: `--text <content>`, `--file-id <id>`
 
-```bash
-# Open a quiz URL in browser (manual mode)
-openape quizzes open <quiz-url>
-```
+### grades — Grade operations
 
-## Material Commands
+  - `summary` — Show grade summary across all courses
+  - `course <course-id>` — Show detailed grades for a course
 
-### Listing materials
+### forums — Forum operations
 
-```bash
-# List all materials/resources across all courses
-openape materials list-all
+  - `list` — List forums from in-progress courses. Flags: `--level in_progress|all`
+  - `list-all` — List all forums across all courses
+  - `discussions <forum-id>` — List discussions in a forum
+  - `posts <discussion-id>` — Show posts in a discussion
+  - `post <forum-id> <subject> <message>` — Post a new discussion. Flags: `--subscribe`, `--pin`
+  - `reply <post-id> <subject> <message>` — Reply to a discussion post. Flags: `--parent-id <id>`
+  - `delete <post-id>` — Delete a forum post or discussion
 
-# List materials from in-progress courses only
-openape materials list-all --level in_progress
-```
-
-Materials include resources (PDFs, documents) and URLs (external links).
+### announcements — Announcement operations
 
-### Downloading materials
+  - `list-all` — List all announcements across courses. Flags: `--unread-only`
+  - `read <announcement-id>` — Read a specific announcement (full content)
 
-```bash
-# Download all materials from a specific course
-openape materials download <course-id>
+### calendar — Calendar operations
 
-# Download all materials from all in-progress courses
-openape materials download-all
+  - `events` — List calendar events. Flags: `--course-id <id>`, `--events-after <date>`, `--events-before <date>`
+  - `export` — Export calendar events to file. Flags: `--format json|ics`, `--output <file>`
 
-# Download from all courses (including past)
-openape materials download-all --level all
+### upload — File upload
 
-# Specify output directory (default: ./downloads)
-openape materials download-all --output-dir ./my-materials
-```
+  - `file <file-path>` — Upload a file to Moodle draft area
 
-## Grade Commands
+### skills — Skill management
 
-### Viewing grades
-
-```bash
-# Show grade summary across all courses
-openape grades summary
-
-# Show detailed grades for a specific course
-openape grades course <course-id>
-```
-
-## Forum Commands
-
-### Listing forums
-
-```bash
-# List forums from in-progress courses
-openape forums list
-
-# List all forums across all courses
-openape forums list-all
-
-# List forums from a specific course level
-openape forums list-all --level past
-```
-
-### Reading discussions
-
-```bash
-# List discussions in a forum (use cmid or instance ID)
-openape forums discussions <forum-id>
-
-# Show posts in a discussion
-openape forums posts <discussion-id>
-```
-
-## Announcement Commands
-
-### Listing announcements
-
-```bash
-# List all announcements across all courses
-openape announcements list-all
-
-# List only unread announcements
-openape announcements list-all --unread-only
-```
-
-### Reading announcements
-
-```bash
-# Read a specific announcement (shows full content)
-openape announcements read <announcement-id>
-```
-
-## Calendar Commands
-
-### Listing events
-
-```bash
-# List all calendar events
-openape calendar events
-
-# List events after a specific date
-openape calendar events --events-after 2026-03-01
-
-# List events before a specific date
-openape calendar events --events-before 2026-06-30
-
-# List events in a specific course
-openape calendar events --course-id <course-id>
-```
-
-### Exporting calendar
-
-```bash
-# Export calendar events to file
-openape calendar export
-
-# Specify output file (default: calendar_events.json)
-openape calendar export --output my-calendar.json
-
-# Export as ICS format for calendar apps
-openape calendar export --format ics --output my-calendar.ics
-```
+  - `install [platform]` — Install OpenApe skill to an agent platform (claude, codex, opencode)
+  - `show` — Print the raw SKILL.md content
 
 ## Output Formats
 
-All commands support `--output` option:
-- `json` (default) - Machine-readable JSON
-- `csv` - Comma-separated values for spreadsheets
-- `table` - Human-readable table format
-- `silent` - Suppress output (useful for automation)
-
-Global options:
-- `--verbose` - Enable debug logging
-- `--silent` - Suppress all log output (JSON only)
-- `--headed` - Run browser in visible mode (for debugging)
+All commands support `--output`: `json` (default), `csv`, `table`, `silent`
 
-## Example Workflows
-
-**Check daily progress:** See what's due and what's incomplete.
-```bash
-openape courses list --level in_progress
-openape videos list <course-id>
-openape quizzes list-all
-openape announcements list-all --unread-only
-```
-
-**Auto-complete videos:** Complete all incomplete videos across courses.
-```bash
-# First, dry-run to see what will be completed
-openape videos complete-all --dry-run
-
-# Then actually complete them
-openape videos complete-all
-```
+Global flags: `--verbose`, `--headed`, `--session <path>`
 
-**Download all materials:** Get all course materials for offline study.
-```bash
-openape materials download-all --output-dir ./semester-materials
-```
-
-**Check grades and progress:** See how you're doing in all courses.
-```bash
-openape grades summary
-openape courses progress <course-id>
-openape courses syllabus <course-id>
-```
-
-**Review discussions:** Catch up on forum activity.
-```bash
-openape forums list --level in_progress
-openape forums discussions <forum-id>
-openape forums posts <discussion-id>
-```
+## Discovering Commands
 
-**Plan your week:** Check upcoming events and deadlines.
 ```bash
-openape calendar events --events-after 2026-03-21 --events-before 2026-03-28
-openape calendar export --format ics --output week.ics
-```
+# Browse all commands
+openape --help
 
-**Bulk operations:** Complete videos and download materials across all courses.
-```bash
-openape videos complete-all
-openape materials download-all --level in_progress
+# Inspect a command's subcommands and options
+openape <command> --help
 ```
-
-## Tips
-
-- Use `--dry-run` with `videos complete` to preview what will be completed
-- Use `--level in_progress` (default) to focus on active courses
-- Use `--output json` for scripting and automation
-- Use `--output table` for human-readable output
-- Session persists after login, no need to re-authenticate
-- WS API mode is used by default for faster performance; browser mode is fallback