@lukeguo12210/canvas-cli 0.0.1

package/LICENSE

@@ -0,0 +1,99 @@
+Business Source License 1.1
+
+License text copyright © 2024 MariaDB plc, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB plc.
+
+Licensor: Luke Guo
+
+Licensed Work: canvas-cli
+
+Additional Use Grant:
+
+You may make production use of the Licensed Work for personal, educational,
+research, academic, non-commercial, and internal evaluation purposes, provided
+your use does not include offering the Licensed Work to third parties as a
+commercial hosted service, managed service, paid integration, or competing
+product offering that exposes Canvas LMS automation, Canvas LMS agent access,
+Canvas LMS data export, or Canvas LMS workflow capabilities.
+
+For uses outside this Additional Use Grant, contact the Licensor for a separate
+commercial license.
+
+Change Date: 2030-05-29
+
+Change License: GNU Affero General Public License v3.0 or later
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited production
+use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph above
+terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of
+the Licensed Work, are subject to this License. This License applies separately
+for each version of the Licensed Work and the Change Date may vary for each
+version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or modified
+form from a third party, the terms and conditions set forth in this License
+apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other versions
+of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor
+or its affiliates (provided that you may use a trademark or logo of Licensor as
+expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN
+"AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS
+OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license your
+works, and to refer to it using the trademark "Business Source License", as
+long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License's text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally,
+please visit https://mariadb.com/bsl11/.

package/README.md

@@ -0,0 +1,216 @@
+# @lukeguo12210/canvas-cli
+
+[![License: BUSL-1.1](https://img.shields.io/badge/License-BUSL--1.1-yellow.svg)](LICENSE)
+
+Canvas CLI for technical students and AI agents.
+
+`@lukeguo12210/canvas-cli` turns Canvas LMS into a local, scriptable, agent-readable workspace. It is built for students who already live in terminals, editors, notebooks, and AI coding tools. Use the `canvas` command directly, or install the bundled skills so Codex, Claude Code, and other local agents can authenticate, understand your courses, pull materials, inspect upcoming work, and build review packs.
+
+[Install](#installation--quick-start) · [Agent Skills](#agent-skills) · [Auth](#authentication) · [Commands](#command-system) · [Security](#security--privacy) · [License](#license) · [Roadmap](#roadmap)
+
+## Why @lukeguo12210/canvas-cli?
+
+- **Built for technical students** — bring Canvas into your terminal, scripts, and local AI workflow.
+- **Agent-native design** — structured skills teach agents Canvas auth, pagination, course structure, and study workflows.
+- **Course context in minutes** — after login, the CLI gathers who you are, what courses you are taking, and where you are in the semester.
+- **Review-pack first** — export modules, pages, assignments, files, discussions, announcements, and calendar context into a structured local course folder.
+- **Canvas-native commands** — simple commands such as `canvas courses list`, `canvas modules list`, and `canvas review pack`.
+- **Local-first control** — personal access tokens stay local, and course exports are written to directories you choose.
+
+## Features
+
+| Category | Capabilities |
+| --- | --- |
+| Auth | Interactive `canvas auth login`, school picker, Canvas settings walkthrough, local PAT config |
+| Context | Post-login context bootstrap: user profile, active courses, planner, calendar, upcoming assignments, modules |
+| Courses | List, search, inspect, and summarize active courses |
+| Modules | Traverse modules and module items in Canvas order |
+| Pages | Fetch pages and export Canvas HTML to Markdown |
+| Files | List files/folders and download accessible course files safely |
+| Assignments | List assignments, due dates, descriptions, visible attachments, and assignment groups |
+| Calendar | Pull calendar, planner, and todo context for the semester |
+| Discussions | Inspect discussion prompts and announcements where visible |
+| Review Packs | Preserve Canvas course structure in an agent-readable local export |
+| Agent Skills | Lark-style skills for Codex, Claude Code, and other local agents |
+
+## Status
+
+Early scaffold.
+
+Implemented:
+
+- TypeScript/Node package scaffold.
+- `canvas --help` and `canvas version`.
+- Core runtime utilities for output envelopes, redaction, config paths, pagination, and Canvas GET requests.
+- Initial unit tests for the safety-critical runtime.
+- Engineering PRD and executable build plan.
+- Initial Lark-style skill bundle skeleton.
+
+Planned next:
+
+- `canvas auth login`.
+- Canvas school picker and PAT setup flow.
+- Post-login context bootstrap.
+- Course/resource commands.
+- Review packs.
+
+## Installation & Quick Start
+
+### Requirements
+
+- Node.js 20+
+- npm
+- A Canvas personal access token generated from your own Canvas account
+
+### Install
+
+```bash
+npm install -g @lukeguo12210/canvas-cli
+```
+
+### Use
+
+```bash
+# 1. Authenticate with your Canvas school
+canvas auth login
+
+# 2. Inspect the automatically gathered student context
+canvas context show
+
+# 3. List courses
+canvas courses list
+
+# 4. Build a local review pack
+canvas review pack --course-id <course-id> --out ./review/<course>
+```
+
+### Install Agent Skills
+
+```bash
+npx skills add @lukeguo12210/canvas-cli -g -y
+```
+
+## Agent Skills
+
+| Skill | Description |
+| --- | --- |
+| `canvas-shared` | Auth, token safety, output formats, pagination, raw API usage, common Canvas errors |
+| `canvas-courses` | Course discovery, course name disambiguation, tabs, and overview |
+| `canvas-modules` | Module traversal, module item resolution, Canvas course order |
+| `canvas-files` | File metadata, folders, linked files, safe downloads |
+| `canvas-assignments` | Assignments, due dates, descriptions, visible attachments |
+| `canvas-review` | Review-pack workflow that preserves Canvas course structure |
+
+Skills live in [`skills/`](skills/). Each domain skill points agents back to `canvas-shared` first, then gives quick decisions, command examples, Canvas concepts, common errors, and output expectations.
+
+## Authentication
+
+The MVP uses personal access tokens only.
+
+```bash
+canvas auth login
+```
+
+The login flow will:
+
+1. Ask for your school.
+2. Open your Canvas settings page.
+3. Guide you through creating a personal access token.
+4. Store the token locally.
+5. Run a lightweight context bootstrap.
+
+Personal access tokens are for local/self use. Do not paste tokens into hosted apps or share them with other users.
+
+## Command System
+
+`@lukeguo12210/canvas-cli` uses a simple Canvas-native command system.
+
+### Student Workflows
+
+```bash
+canvas context show
+canvas review pack --course-id <course-id> --out ./review/<course>
+canvas review search --path ./review/<course> --query "dynamic programming"
+```
+
+### Domain Commands
+
+```bash
+canvas courses list
+canvas courses search "algorithms"
+canvas modules list --course-id <course-id>
+canvas assignments list --course-id <course-id>
+canvas pages show --course-id <course-id> --page <url-or-id>
+canvas files download <file-id> --out ./files
+```
+
+### Raw Read-Only API
+
+```bash
+canvas api get /api/v1/courses
+canvas api get /api/v1/courses/<course-id>/modules --params '{"include":["items"]}'
+```
+
+MVP raw API access is GET-only.
+
+## Output Formats
+
+```bash
+--format json      # default, agent-friendly
+--format pretty    # human-readable
+--format table     # simple list output
+--format ndjson    # streaming/batch-friendly
+```
+
+## Security & Privacy
+
+- Tokens are local and must never be printed.
+- Logs and errors redact `Authorization`, `access_token`, `token`, and bearer values.
+- The MVP refuses Canvas write methods.
+- Review packs exclude grades, submissions, conversations, and group member lists by default.
+- Downloads are constrained to the requested output directory.
+- Pagination follows Canvas `Link` headers instead of guessing URLs.
+
+## License
+
+`@lukeguo12210/canvas-cli` is source-available under the Business Source License 1.1.
+
+Personal, educational, research, academic, non-commercial, and internal evaluation use is permitted. Commercial hosted services, managed services, paid integrations, or competing product offerings require a separate commercial license until the Change Date.
+
+Change Date: May 29, 2030.
+
+Change License: GNU Affero General Public License v3.0 or later.
+
+See [LICENSE](LICENSE).
+
+## Roadmap
+
+Near term:
+
+- Implement `canvas auth login`.
+- Add school registry and custom Canvas URL setup.
+- Add post-login context bootstrap.
+- Implement courses, tabs, modules, assignments, pages, and files.
+- Build `canvas review pack`.
+- Package skills for `npx skills add @lukeguo12210/canvas-cli -g -y`.
+
+Later:
+
+- Full student read surface: grades, submissions, quizzes, discussions, announcements, planner, groups, conversations.
+- Optional write-capable student workflows with explicit commands and dedicated skills.
+- Public npm release.
+
+## Development
+
+```bash
+npm install
+npm run typecheck
+npm run test
+npm run build
+```
+
+## Docs
+
+- [Engineering PRD](docs/engineering-prd.md)
+- [Executable Build Steps](docs/build-steps.md)
+- [Read-Only-First Plan](docs/read-only-first.md)

package/dist/bin/canvas.d.ts

@@ -0,0 +1,2 @@
+
+export {  }