@streamfox/create-streamfox-plugin 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 stream-fox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# create-streamfox-plugin
+
+CLI scaffolder for StreamFox plugin projects.
+
+Generated projects target the current `@streamfox/plugin-sdk` contract:
+
+- unified stream transport model (`supportedTransports` + `stream.transport`)
+- optional installer config with `configurationRequired`
+- serve integration URLs (`url`, `installURL`, `launchURL`)
+
+## Install
+
+```bash
+npm i -g @streamfox/create-streamfox-plugin
+```
+
+The installed command stays:
+
+```bash
+create-streamfox-plugin
+```
+
+## Usage
+
+Interactive:
+
+```bash
+npx @streamfox/create-streamfox-plugin
+```
+
+Or after global install:
+
+```bash
+create-streamfox-plugin
+```
+
+Non-interactive:
+
+```bash
+create-streamfox-plugin my-plugin --yes
+```
+
+## CLI Options
+
+| Option                   | Type          | Default                | Notes                                                                    |
+| ------------------------ | ------------- | ---------------------- | ------------------------------------------------------------------------ |
+| `[directory]`            | positional    | `my-media-plugin`      | Output directory.                                                        |
+| `--ts`                   | flag          | `true` (unless `--js`) | Generate TypeScript template.                                            |
+| `--js`                   | flag          | no                     | Generate JavaScript template.                                            |
+| `--preset <preset>`      | enum          | `meta`                 | One of: `catalog`, `meta`, `stream`, `subtitles`, `plugin_catalog`.      |
+| `--capabilities <a,b,c>` | csv enum list | none                   | Adds extra capabilities on top of preset.                                |
+| `--advanced`             | flag          | `false`                | Generate richer examples (torrent/usenet/archive/trailers/distribution). |
+| `--sdk-version <range>`  | string        | `^0.2.0`               | Dependency range for `@streamfox/plugin-sdk`.                            |
+| `--yes`                  | flag          | `false`                | Skip prompts and use provided/default values.                            |
+| `-v, --version`          | flag          | no                     | Display the current CLI version.                                         |
+
+## Examples
+
+Create subtitles preset with advanced examples:
+
+```bash
+create-streamfox-plugin streamfox-opensubs \
+  --ts \
+  --preset subtitles \
+  --capabilities meta,stream \
+  --advanced \
+  --sdk-version ^0.2.0 \
+  --yes
+```
+
+## What Gets Generated
+
+- `src/plugin.(ts|js)` with selected capabilities and handlers
+- `src/server.(ts|js)` that calls `serve(...)` and prints:
+  - manifest URL
+  - install deeplink URL
+  - launch URL
+- `test/plugin.test.(ts|js)` smoke test (`/manifest`, `/studio-config`)
+- `README.md`, `package.json`, `.prettierrc.json`, `.prettierignore`, and (for TS) `tsconfig.json`
+
+## Development
+
+```bash
+npm install
+npm run format
+npm run build
+npm test
+```
+
+Local manual test:
+
+```bash
+npm link
+create-streamfox-plugin demo-plugin --yes
+```