@mirrowel/opencode-openshare 0.3.0-dev.5 → 0.3.0-dev.7

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.
Files changed (2) hide show
  1. package/README.md +21 -1
  2. package/package.json +3 -4
package/README.md CHANGED
@@ -1,8 +1,28 @@
1
1
  # Open(code)Share plugin (`@mirrowel/opencode-openshare`)
2
2
 
3
- The opencode side of [Open(code)Share](../README.md) — session sharing for
3
+ The opencode side of [Open(code)Share](../README.md) - session sharing for
4
4
  OpenCode v1 and v2, self-hosted on your own worker.
5
5
 
6
+ **This package is only the plugin.** It captures and uploads sessions, but a
7
+ share needs a backend to upload to. OpenShare ships as four parts that
8
+ version and release together:
9
+
10
+ | Part | What it does | Where to get it |
11
+ |---|---|---|
12
+ | **This plugin** | hooks into opencode, syncs sessions | this npm package |
13
+ | **Worker** | the Cloudflare backend - stores shares, serves the viewer | deploy from the repo: `share-worker/` (3-command setup, see the repo README) |
14
+ | **Server** | self-hosted alternative to the worker - one Bun process, SQLite, Docker image | repo `share-server/` |
15
+ | **Viewer** | the share page - ships inside the worker/server assets; nothing to install separately | repo `share-viewer/` (embedded automatically) |
16
+
17
+ The repo also builds **offline snapshots** - a single self-contained HTML
18
+ file of any share, generated by the viewer's download button or the
19
+ `osh-snapshot` CLI - so a shared link keeps working even with no backend at
20
+ all.
21
+
22
+ Everything lives in one repository: **https://github.com/Mirrowel/openshare**
23
+ (clone it, or browse the [README](https://github.com/Mirrowel/openshare#readme)
24
+ for the full picture - deployment, configuration, and the viewer tour).
25
+
6
26
  Every plugin config key, its file chain, and the cross-package config surface are inventoried in [../CONFIGURATION.md](../CONFIGURATION.md).
7
27
 
8
28
  ## Artifacts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mirrowel/opencode-openshare",
3
- "version": "0.3.0-dev.5",
3
+ "version": "0.3.0-dev.7",
4
4
  "type": "module",
5
5
  "description": "Open(code)Share — re:share: self-hosted session sharing for opencode. Server plugin (single file or package), optional TUI for interactive opt-in sharing.",
6
6
  "license": "MIT",
@@ -64,10 +64,9 @@
64
64
  "build:tui": "bun scripts/build-tui.mjs",
65
65
  "build:standalone": "bun scripts/build-standalone.mjs",
66
66
  "typecheck": "tsc --noEmit",
67
- "ci": "npm run release:intent:check && npm run ci:package",
67
+ "ci": "npm run ci:package",
68
68
  "ci:package": "npm run typecheck && npm run build && npm run pack:dry-run",
69
- "release:intent": "node scripts/set-release-intent.mjs",
70
- "release:intent:check": "node scripts/check-release-intent.mjs",
69
+ "prepare": "node ../.github/scripts/install-hooks.mjs",
71
70
  "pack:dry-run": "node scripts/pack-dry-run.mjs",
72
71
  "test:regression": "node scripts/regression-tests.mjs",
73
72
  "prepublishOnly": "npm run typecheck && npm run build",