broader-vids 0.1.0 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 antidemosthenes
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 antidemosthenes
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,114 +1,133 @@
1
- # Broader Vids
2
-
3
- Broader Vids provides an alternative recommendation algorithm for YouTube and Bilibili.
4
- It combines your interests, exploration of unfamiliar topics, video quality, and feedback.
5
-
6
- **The plugin learns from your dashboard ratings and calibrates its internal scoring model weights to your preferences.**
7
- You can manually exclude creators and tags from future rounds.
8
- Each complete round recommends ten videos per selected platform.
9
-
10
- The plugin runs locally through Codex CLI or Codex in the ChatGPT desktop app.
11
- Recommendations appear in chat. A local dashboard provides ratings, exclusions, and preferences.
12
-
13
- ## Install the plugin
14
-
15
- Requirements: Windows, PowerShell, Node.js 20 or later with npm, UV, and Codex CLI authenticated with ChatGPT.
16
- Installation and recommendations require internet access.
17
- Choose one installation method. Neither method requires a checkout, build, or local folder selection.
18
-
19
- ### From GitHub in the ChatGPT desktop app
20
-
21
- 1. Open the plugin marketplace controls in Codex.
22
- 2. Select **Add marketplace** and its repository or Git URL option.
23
- 3. Enter `https://github.com/antidemosthenes/broader-vids`.
24
- 4. Add or sync the marketplace.
25
- 5. Select **Broader Vids** and install it.
26
- 6. Start a new conversation.
27
-
28
- The GitHub repository supplies the catalog. Its plugin entry downloads the complete package from npm.
29
-
30
- ### From GitHub in Codex CLI
31
-
32
- Run these commands in PowerShell:
33
-
34
- ```powershell
35
- codex plugin marketplace add antidemosthenes/broader-vids --sparse .agents/plugins
36
- codex plugin add broader-vids@broader-vids
37
- ```
38
-
39
- Start a new conversation after installation.
40
-
41
- ### From npm
42
-
43
- Run this command in PowerShell:
44
-
45
- ```powershell
46
- npx --yes broader-vids@0.1.0 plugin install
47
- ```
48
-
49
- This command registers an npm-backed marketplace and installs the plugin through Codex.
50
- It installs the skills and dashboard, not only the terminal launcher.
51
- It does not require the GitHub catalog.
52
- Restart the desktop app or start a new Codex CLI conversation after installation.
53
-
54
- The app's Add marketplace field accepts repository URLs, not npm package names.
55
- Use the npm command above for that installation route.
56
- See the [official packaging guide](https://developers.openai.com/plugins/build/plugins) for supported plugin sources.
57
-
58
- ## Set up and request recommendations
59
-
60
- Use this procedure for either platform or both:
61
-
62
- 1. Start a new conversation. Invoke the setup skill from the table below.
63
- 2. Choose YouTube, Bilibili, or both.
64
- 3. Choose calibrated starter preferences, enter your interests, or import a preference file.
65
- 4. Complete the dependency and access checks. Setup gives repair steps for required failures.
66
- 5. Invoke the recommendation skill. Review the links and summaries in chat.
67
- 6. Open the dashboard to mark watched videos and rate their topic, subject, depth, and quality.
68
- 7. Request another round when you want more recommendations.
69
-
70
- Existing profiles can keep their saved preferences during setup.
71
- Saving ratings updates the local preference and quality models.
72
- Their learned weights affect screening and final ranking in later rounds.
73
- Creator and tag exclusions apply to the next new round.
74
- The dashboard **Preferences** page lets you edit interests and import or export preferences and learned weights.
75
- Before a new round, incomplete feedback prompts you to open the dashboard or continue.
76
-
77
- Both platforms support manual creator and tag exclusions.
78
- YouTube tag rules match available creator-supplied keyword tags, which differ from visible hashtags.
79
- Bilibili rules match its video tags.
80
- Search queries use English for YouTube and Simplified Chinese for Bilibili.
81
-
82
- | Action | Skill command | Purpose |
83
- | --- | --- | --- |
84
- | Setup | `$broader-vids-setup` | Choose platforms and preferences, install required tools, and check access. |
85
- | Recommendations | `$broader-vids` | Request a round for your saved platforms. |
86
- | Dashboard | `$broader-vids-dashboard` | Rate videos, manage exclusions, and edit preferences. |
87
- | Reset | `$broader-vids-reset` | Preview removal of preferences, weights, ratings, and histories while keeping tools and sign-in. |
88
- | Clean | `$broader-vids-clean` | Preview removal of all managed local data, including tools and sign-in. |
89
-
90
- Use the command names shown by your host's skill menu.
91
- Some hosts add the plugin namespace, such as `$broader-vids:broader-vids-dashboard`.
92
- You can also ask: “Use Broader Vids to recommend videos” or “Use Broader Vids to open my dashboard.”
93
- Reset and Clean require confirmation. Neither action uninstalls the plugin.
94
-
95
- ## Bilibili access and exclusions
96
-
97
- Bilibili requires manual sign-in for full-video evidence.
98
- Setup opens a separate browser window.
99
- Keep that window open after sign-in and return to chat to report completion.
100
- The plugin verifies the session and closes the window.
101
- You can switch accounts later from the dashboard.
102
-
103
- Bilibili imports your account blacklist after verified sign-in and before new rounds.
104
- Imported creator exclusions combine with your manual exclusions.
105
- A failed sync preserves the last complete copy.
106
- Use **Sync blacklist** in the dashboard to retry.
107
-
108
- The default 视频翻译 tag exclusion can be removed in the dashboard.
109
-
110
- See the [workflow](docs/WORKFLOW.md) for recommendation steps and the [scoring guide](docs/SCORING.md) for ranking and learning.
111
- The [reference](docs/REFERENCE.md) covers terminal commands, troubleshooting, local builds, and maintenance.
112
- The [architecture](docs/ARCHITECTURE.md) describes the launcher, engine, and local storage.
113
-
114
- License: [MIT](LICENSE).
1
+ # Broader Vids
2
+
3
+ Broader Vids provides an alternative recommendation algorithm for YouTube and Bilibili.
4
+ It combines your interests, exploration of unfamiliar topics, video quality, and feedback.
5
+
6
+ **The plugin learns from your dashboard ratings and calibrates its internal scoring model weights to your preferences.**
7
+ You can manually exclude creators and tags from future rounds.
8
+ Each complete round recommends ten videos per selected platform.
9
+
10
+ The plugin runs locally through Codex CLI or Codex in the ChatGPT desktop app.
11
+ Recommendations appear in chat. A local dashboard provides ratings, exclusions, and preferences.
12
+
13
+ ## Install the plugin
14
+
15
+ Requirements: Windows, PowerShell, Node.js 20 or later with npm, UV, and Codex CLI authenticated with ChatGPT.
16
+ Installation and recommendations require internet access.
17
+ Choose one installation method. Neither method requires a checkout, build, or local folder selection.
18
+
19
+ ### From GitHub in the ChatGPT desktop app
20
+
21
+ 1. Open the plugin marketplace controls in Codex.
22
+ 2. Select **Add marketplace** and its repository or Git URL option.
23
+ 3. Enter `https://github.com/antidemosthenes/broader-vids`.
24
+ 4. Add or sync the marketplace.
25
+ 5. Select **Broader Vids** and install it.
26
+ 6. Start a new conversation.
27
+
28
+ The GitHub repository supplies the catalog. Its plugin entry downloads the complete package from npm.
29
+
30
+ ### From GitHub in Codex CLI
31
+
32
+ Run these commands in PowerShell:
33
+
34
+ ```powershell
35
+ codex plugin marketplace add antidemosthenes/broader-vids --sparse .agents/plugins
36
+ codex plugin add broader-vids@broader-vids
37
+ ```
38
+
39
+ Start a new conversation after installation.
40
+
41
+ ### From npm
42
+
43
+ Run this command in PowerShell:
44
+
45
+ ```powershell
46
+ npx --yes broader-vids@latest plugin install
47
+ ```
48
+
49
+ This command registers an npm-backed marketplace and installs the plugin through Codex.
50
+ It installs the skills and dashboard, not only the terminal launcher.
51
+ It does not require the GitHub catalog.
52
+ Restart the desktop app or start a new Codex CLI conversation after installation.
53
+
54
+ The app's Add marketplace field accepts repository URLs, not npm package names.
55
+ Use the npm command above for that installation route.
56
+ See the [official packaging guide](https://developers.openai.com/plugins/build/plugins) for supported plugin sources.
57
+
58
+ ## Update the plugin
59
+
60
+ For a GitHub installation, refresh its marketplace and install the current release:
61
+
62
+ ```powershell
63
+ codex plugin marketplace upgrade broader-vids
64
+ codex plugin add broader-vids@broader-vids
65
+ ```
66
+
67
+ For an npm installation, repeat the installation command:
68
+
69
+ ```powershell
70
+ npx --yes broader-vids@latest plugin install
71
+ ```
72
+
73
+ In the desktop app, refresh the marketplace and select the current Broader Vids release.
74
+ If the app provides no update action, use the terminal commands for your installation method.
75
+ Start a new conversation and run setup after an update.
76
+ Setup installs the matching engine and preserves your saved profile.
77
+ Finish active recommendations and close the dashboard before updating.
78
+
79
+ ## Set up and request recommendations
80
+
81
+ Use this procedure for either platform or both:
82
+
83
+ 1. Start a new conversation. Invoke the setup skill from the table below.
84
+ 2. Choose YouTube, Bilibili, or both.
85
+ 3. Choose calibrated starter preferences, enter your interests, or import a preference file.
86
+ 4. Complete the dependency and access checks. Setup gives repair steps for required failures.
87
+ 5. Invoke the recommendation skill. Review the links and summaries in chat.
88
+ 6. Open the dashboard to mark watched videos and rate their topic, subject, depth, and quality.
89
+ 7. Request another round when you want more recommendations.
90
+
91
+ Existing profiles can keep their saved preferences during setup.
92
+ Saving ratings updates the local preference and quality models.
93
+ Their learned weights affect screening and final ranking in later rounds.
94
+ Creator and tag exclusions apply to the next new round.
95
+ The dashboard **Preferences** page lets you edit interests and import or export preferences and learned weights.
96
+ Before a new round, incomplete feedback prompts you to open the dashboard or continue.
97
+
98
+ Both platforms support manual creator and tag exclusions.
99
+ YouTube tag rules match available creator-supplied keyword tags, which differ from visible hashtags.
100
+ Bilibili rules match its video tags.
101
+ Search queries use English for YouTube and Simplified Chinese for Bilibili.
102
+
103
+ | Action | Skill command | Purpose |
104
+ | --- | --- | --- |
105
+ | Setup | `$broader-vids-setup` | Choose platforms and preferences, install required tools, and check access. |
106
+ | Recommendations | `$broader-vids` | Request a round for your saved platforms. |
107
+ | Dashboard | `$broader-vids-dashboard` | Rate videos, manage exclusions, and edit preferences. |
108
+ | Reset | `$broader-vids-reset` | Preview removal of preferences, weights, ratings, and histories while keeping tools and sign-in. |
109
+ | Clean | `$broader-vids-clean` | Preview removal of all managed local data, including tools and sign-in. |
110
+
111
+ Use the command names shown by your host's skill menu.
112
+ Some hosts add the plugin namespace, such as `$broader-vids:broader-vids-dashboard`.
113
+ You can also ask: “Use Broader Vids to recommend videos” or “Use Broader Vids to open my dashboard.”
114
+ Reset and Clean require confirmation. Neither action uninstalls the plugin.
115
+
116
+ ## Bilibili access and exclusions
117
+
118
+ Bilibili requires manual sign-in for full-video evidence.
119
+ Setup opens a separate browser window.
120
+ Keep that window open after sign-in and return to chat to report completion.
121
+ The plugin verifies the session and closes the window.
122
+ You can switch accounts later from the dashboard.
123
+
124
+ Bilibili imports your account blacklist after verified sign-in and before new rounds.
125
+ Imported creator exclusions combine with your manual exclusions.
126
+ A failed sync preserves the last complete copy.
127
+ Use **Sync blacklist** in the dashboard to retry.
128
+
129
+ See the [workflow](docs/WORKFLOW.md) for recommendation steps and the [scoring guide](docs/SCORING.md) for ranking and learning.
130
+ The [reference](docs/REFERENCE.md) covers terminal commands, troubleshooting, local builds, and maintenance.
131
+ The [architecture](docs/ARCHITECTURE.md) describes the launcher, engine, and local storage.
132
+
133
+ License: [MIT](LICENSE).