ronin-skillforce 0.0.0-stage → 0.2.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+All notable changes to **ronin-skillforce** are documented here. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0-beta.0] — 2026-11-15
+
+### Changed
+
+- **License: Apache-2.0** from this release (was MIT). Adds a `NOTICE` file with attribution,
+  third-party licences and a trademark note. Version 0.1.0 and all `course-professor` releases stay MIT.
+
+
+### Added
+
+- `skillforce studio --autostart on|off` starts Professor Studio at login on macOS through a
+  LaunchAgent (`com.ronin-skillforce.studio`), pins the ports the first time so the URL and pairing
+  URL stop changing, and refuses to install from an npx cache (use a global install).
+- `skillforce studio --status` reports whether Studio runs, its URL and pairing URL, the autostart
+  state and the log path (`${PROFESSOR_HOME:-~/.professor}/logs/studio.log`). `--stop` stops it —
+  through launchd when the login item is installed, otherwise through the pid in
+  `${PROFESSOR_HOME:-~/.professor}/studio.json` — and never signals a process that is not Studio.
+- `skillforce studio --strict-port` fails instead of moving to another port when one is busy.
+
+### Changed
+
+- Courses live only in `learning/<slug>/`. The legacy `courses/` location is no longer read:
+  `professor:capstone` and `professor:syllabus` now find every course created since 0.1.0, and the
+  CLI and PreCompact hook look in `learning/` only. If you still have a pre-0.1.0 `courses/<slug>/`
+  folder, move it to `learning/<slug>/` by hand — nothing is migrated automatically.
+
+### Fixed
+
+- New programming courses are created on an **orphan** branch: `learning/<slug>/` holds only course
+  files, never a copy of your project, and shares no history with it.
+- `professor:archive` keeps everything: the whole course is copied to `.course_archive/<slug>/`
+  (never overwritten), course commits stay on branch `archive/<slug>`, and nothing is removed before
+  the copy is verified (`skillforce archive`).
+- `professor:done` no longer loops: Coach asks you to say "confirm"; the section verdict is recorded
+  with `skillforce verdict` in the format the CLI reads, and the capstone status line now updates.
+- `professor:hint` and `professor:stuck` refuse during the capstone phase; `professor:next` resumes
+  an in-progress section instead of skipping it.
+- Re-running `setup` now refreshes the files the plugin installed (a changed file is kept once as
+  `.bak`); Gemini CLI, OpenCode and Cursor get current instructions, an inline Coach flow, and
+  Gemini commands receive their arguments.
+- `skillforce studio` polls and prints `http://127.0.0.1:<port>` instead of `http://localhost:<port>`,
+  matching the loopback bind. On macOS `localhost` resolves to `::1` first, so a health poll could
+  reach another dev server holding `[::1]:3000` and fail with "did not become healthy … (HTTP 404)".
+- `skillforce studio` checks both loopback families before starting. A busy default port moves to the
+  next free one with a notice, a busy `--port` / `--api-port` fails with a message naming the port and
+  the flag to change, and a health answer that is not Studio says another app is on that port.
+- `skillforce web` prints its UI URL on `127.0.0.1` (legacy Vite dev is unchanged).
+
+## [0.1.0] — 2026-11-14
+
+First release under the new name. Earlier versions were published as `course-professor`
+(1.x, now deprecated on npm); their history is in
+[`docs/history/CHANGELOG-course-professor.md`](docs/history/CHANGELOG-course-professor.md).
+This release also ships everything listed there under `[Unreleased]` (for example `web` now serves
+Studio only).
+
+### Changed
+
+- Package renamed to `ronin-skillforce`; the CLI command is `skillforce`
+  (`npx ronin-skillforce <command>`). `course-professor` and `professor` still work as aliases.
+- Version reset to `0.1.0`.
+
+### Added
+
+- `skillforce create <slug> --kind <kind>` / `skillforce save <slug>` — programming courses are
+  verified git worktrees on `learning/<slug>`, rolled back on failure, and committed as you go.
+- `skillforce context [slug] --json` / `skillforce trail <slug> --stdin` — Coach gets the real course
+  instead of guessing paths, and every review round is kept in `LEARNING-LOG.md`.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,19 @@
+Ronin SkillForce
+Copyright 2026 Tuấn Khuất (ronnie)
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+Versions 0.1.0 and earlier, and all versions published as `course-professor`,
+were released under the MIT License.
+
+"Ronin SkillForce" and "SkillForce" are names of the project owner. The
+Apache License does not grant permission to use these names, logos or other
+trademarks, except as required for describing the origin of the work.
+
+Third-party software
+--------------------
+The built Studio app (studio/dist) bundles third-party packages under their
+own licenses, including:
+  - elkjs (Eclipse Public License 2.0), used unmodified through Mermaid
+    https://github.com/kieler/elkjs
+All other runtime dependencies are under permissive licenses (MIT, ISC,
+BSD-2/3-Clause, Apache-2.0, 0BSD, CC0-1.0, Unlicense, Python-2.0).

package/README.md

@@ -1,3 +1,259 @@
-# Temporary Holding Version
+# Ronin SkillForce
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**A Socratic learning coach for AI agents.** SkillForce teaches by asking questions instead of
+handing you answers. It runs inside **Claude Code**, **Gemini CLI**, **OpenCode** and **Cursor**,
+and comes with **Studio**, a local web app for lessons, quizzes, flashcards and hands-on exercises.
+
+```bash
+npx ronin-skillforce init      # set up your AI agent
+npx ronin-skillforce studio    # open Studio in your browser
+```
+
+> Formerly published as `course-professor` (now deprecated). The old `course-professor` command
+> still works as an alias.
+
+---
+
+## Why SkillForce
+
+Most AI assistants write the answer the moment you ask. SkillForce does the opposite: you think,
+you try, you get feedback as questions, and you keep what you learn.
+
+- **Socratic by design.** It never completes your exercises; it asks the next question instead.
+- **Any subject.** Each course has a kind: `programming`, `quantitative`, `conceptual` or `skill`.
+  Exercises match the kind: code with self-checks, problem sets, analysis prompts or drills.
+- **Grounded lectures.** Before each lecture it researches 3–6 sources and cites key claims. It
+  never invents links, and marks claims it could not source as unverified.
+- **Your progress stays on your machine.** Courses are plain Markdown files. Programming courses
+  are git worktrees on their own `learning/<slug>` branch, which starts with no history and none of
+  your project's files, so they never mix with your project.
+- **Remembers how you learn.** Coach keeps a trail of every review round, flags weak concepts and
+  builds spaced-repetition flashcards.
+
+---
+
+## Requirements
+
+- An AI agent: Claude Code, Gemini CLI, OpenCode or Cursor.
+- **Node.js 18+** for setup and the CLI; **Node 22.5+** for Studio, `review` and `import` (they use
+  the built-in `node:sqlite` module). Run `npx ronin-skillforce doctor` to check your setup.
+- **Git** for programming courses.
+
+---
+
+## Quick start
+
+### 1. Set up your agent
+
+```bash
+npx ronin-skillforce init              # auto-detect your agent
+npx ronin-skillforce setup claude      # or pick one: claude | cursor | opencode | gemini
+```
+
+Restart your agent, then start a course:
+
+```
+professor:new-topic
+```
+
+Professor asks a few questions about what you want to learn, proposes a syllabus and creates the
+course in `learning/<slug>/`. Then use `professor:next` for each lesson.
+
+### 2. Open Studio (optional)
+
+```bash
+npx ronin-skillforce studio            # starts the local server + Studio and pairs them
+```
+
+Studio is a browser app on your machine. Bring your own API key (Anthropic, any
+OpenAI-compatible endpoint, Ollama), or use the AI agent you already have through the local
+bridge, with no key needed. Your data goes to your browser (IndexedDB) or to a SQLite file at
+`~/.professor/professor.db`, whichever you choose.
+
+### Install globally (optional)
+
+```bash
+npm i -g ronin-skillforce              # then run `skillforce <command>`
+npm uninstall -g ronin-skillforce
+```
+
+Your courses (in `learning/`) and Studio's database live outside the package and are not removed
+when you uninstall.
+
+---
+
+## Agent commands
+
+Type these in your AI agent.
+
+| Command | What it does |
+|---|---|
+| `professor:new-topic` | Start a course: research, syllabus, course folder |
+| `professor:next` | Next lesson: grounded lecture and an exercise |
+| `professor:review` | Coach reviews your work, starting with your own self-assessment |
+| `professor:hint` | Hints in 3 layers: concept → tool/pattern → pseudo-code |
+| `professor:stuck` | Break a blocker into smaller steps, without the answer |
+| `professor:discuss` | Questions about the current concept |
+| `professor:quiz` | 5 questions at your level |
+| `professor:done` | Coach checks your understanding, then marks the section complete |
+| `professor:recall` / `professor:schedule` | Spaced-repetition drills and your review schedule |
+| `professor:progress` / `professor:syllabus` | Progress, streak and the full syllabus |
+| `professor:capstone` / `professor:capstone-review` | Final project brief and its review |
+| `professor:note` / `professor:export` | Notes, and export to Notion or Obsidian |
+| `professor:switch` / `professor:worktrees` / `professor:archive` | Manage several courses |
+
+Professor routes work to specialised agents: **Coach** (reviews and self-assessment),
+**Spotter** (mid-work check-ins), **Navigator** (how concepts connect) and **Researcher**
+(sources for lectures).
+
+---
+
+## CLI
+
+```bash
+npx ronin-skillforce <command>         # or `skillforce <command>` after a global install
+```
+
+| Command | What it does |
+|---|---|
+| `init`, `setup <agent>`, `list` | Set up the plugin for your agent |
+| `status [--json]` | Every course: kind, progress, current section, due flashcards, streak |
+| `next [slug]` | Current lesson summary and how to continue |
+| `check [slug]` | Run the active exercise's self-checks (never shows solutions) |
+| `doctor` | Check Node, git, agents, Ollama, ports and the database, with fix hints |
+| `studio [--no-open] [--port N --api-port N] [--status \| --stop \| --autostart on\|off]` | Start the local server and Studio, print a pairing URL, or check/stop the background copy |
+| `review [--limit N]` | Review due flashcards in the terminal (shared with Studio) |
+| `import [slug \| --all] [--dry-run]` | Import Markdown courses into Studio's database |
+| `create`, `save`, `context`, `trail` | Course steps the agent commands run for you |
+| `courses`, `search`, `install`, `update`, `installed`, `remove` | Community courses and skills (beta) |
+| `web` | Start only the bridge server (see below) |
+
+### Run Studio in the background (macOS)
+
+On macOS you can let Studio start at login instead of running `npx ronin-skillforce studio` yourself.
+Auto-start needs a global install, because a path in the npx cache can be deleted at any time:
+
+```bash
+npm i -g ronin-skillforce
+skillforce studio --autostart on       # installs the login item and prints the fixed URL
+```
+
+The LaunchAgent (`~/Library/LaunchAgents/com.ronin-skillforce.studio.plist`) pins the ports in use
+when you ran the command and starts Studio with `--strict-port`, so the URL and pairing URL stay the
+same at every login. If a pinned port is busy at login, Studio does not start: the reason is the last
+line of `~/.professor/logs/studio.log` (or `$PROFESSOR_HOME/logs/studio.log` when that is set).
+
+```bash
+skillforce studio --status             # running? URL, pairing URL, autostart, log path
+skillforce studio --stop               # stop it; never touches another app's process
+skillforce studio --autostart off      # remove the login item
+```
+
+Pick a specific port with `--autostart on --port 5190 --api-port 3005` (a busy port is refused, not
+silently changed). Re-run `--autostart on` after changing Node (nvm, a global upgrade) so the agent
+points at the new binary, and run `--autostart off` before uninstalling the package. Log out and back
+in once to see it start by itself; `--status` may say "not running" for a moment after login while
+Studio boots.
+
+### Starting the bridge manually
+
+`skillforce web` starts the Studio bridge server and serves the built Studio app from the
+same port (3000 by default). It does not build Studio: if `studio/dist` is missing the port answers
+with a 503 page. `web --production` refuses to start without a Studio build, and
+`web --rotate-token` prints a new pairing token. Most people should use `skillforce studio`
+instead.
+
+The bridge accepts only loopback clients and requires the pairing token, so keep the token private.
+The old web UI is **deprecated** and opt-in only (`web --legacy` or `PROFESSOR_LEGACY=1`); it will
+be removed.
+
+---
+
+## How courses are stored
+
+```
+learning/<slug>/
+├── COURSE.md         syllabus and progress (source of truth)
+├── LECTURE.md        current lesson; older lessons are kept in lectures/
+├── LEARNING-LOG.md   Coach review trail, attempts and section verdicts
+├── SCHEDULE.md       flashcards and spaced-repetition queue
+├── CAPSTONE.md       final project brief (never changes)
+├── NOTES.md          your notes
+└── exercises/
+```
+
+Everything is plain Markdown you can read, edit and commit. There is no lock-in.
+
+---
+
+## Export to Notion or Obsidian (optional)
+
+`professor:export` needs an MCP server in your project's `.mcp.json`. The core learning flow works
+without one.
+
+<details>
+<summary>Notion</summary>
+
+Create an integration at [notion.so/my-integrations](https://www.notion.so/my-integrations), copy
+its token, and connect it to the target page (`…` → **Connections**). Then:
+
+```json
+{
+  "mcpServers": {
+    "notion": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-notion"],
+      "env": { "NOTION_API_TOKEN": "your-notion-integration-token" }
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Obsidian</summary>
+
+Install and enable the **Local REST API** community plugin and copy its API key (default port
+27123). Then:
+
+```json
+{
+  "mcpServers": {
+    "obsidian": {
+      "command": "npx",
+      "args": ["-y", "mcp-obsidian"],
+      "env": {
+        "OBSIDIAN_API_KEY": "your-obsidian-rest-api-key",
+        "OBSIDIAN_HOST": "127.0.0.1",
+        "OBSIDIAN_PORT": "27123"
+      }
+    }
+  }
+}
+```
+
+</details>
+
+---
+
+## Security and privacy
+
+Studio runs as a browser app, a loopback bridge and a local code runner on your machine. API keys
+stay in your browser and are never included in backups. See [`SECURITY.md`](SECURITY.md) for what
+runs where and how to report a vulnerability.
+
+## Links
+
+- Changes: [`CHANGELOG.md`](CHANGELOG.md)
+- Studio details: [`studio/README.md`](studio/README.md)
+- Source and issues: [github.com/Thanhtuan96/course-builder](https://github.com/Thanhtuan96/course-builder)
+
+## License
+
+[Apache License 2.0](LICENSE) from version 0.2.0. See [`NOTICE`](NOTICE) for attribution and
+third-party licenses. Version 0.1.0 and every release published as `course-professor` were MIT.
+
+"Ronin SkillForce" and "SkillForce" are the project owner's names; the licence does not grant
+permission to use them for other products. Contributions are accepted under the terms in
+[`CONTRIBUTING.md`](CONTRIBUTING.md).