superbee 0.2.1 → 0.3.0-pre.1

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/README.md CHANGED
@@ -42,18 +42,36 @@ Skill, an instruction file your agent loads, that teaches it how to use the tool
42
42
 
43
43
  ## Install
44
44
 
45
- Requires Node.js 20 or newer on macOS, Linux, or Windows. Native Windows is supported; you do not
46
- need WSL or Docker.
45
+ Requires Node.js 20 or newer on macOS and Linux. Native Windows is not supported by this package.
47
46
 
48
47
  ```sh
49
48
  npm install -g superbee
50
49
  ```
51
50
 
52
- Stable releases publish on npm's `latest` tag and prereleases on `next`.
51
+ Stable releases publish on npm's `latest` tag and prereleases on `next`. To try the prerelease:
53
52
 
54
- On Windows, Superbee keeps its private per-user state, such as the workspace catalog and remote
55
- credentials, under `%LOCALAPPDATA%\Superbee`. npm installs `superbee.cmd` alongside the `superbee`
56
- command; if PowerShell's execution policy blocks the `.ps1` wrapper, call `superbee.cmd` instead.
53
+ ```sh
54
+ npm install -g superbee@next
55
+ ```
56
+
57
+ Windows adapters and the `superbee-windows` executable live in a separate repository and are
58
+ not included in `superbee`. Most Windows users should run Superbee in WSL2, where npm sees a
59
+ Linux platform and the normal installation applies. An experimental, unsupported native Windows
60
+ build is available as open source, with build-from-source instructions: https://github.com/Holaxis-ai/superbee-windows-cli
61
+
62
+ ### Upgrading an existing Windows installation
63
+
64
+ The first release containing the Windows extraction removes native Windows support from this
65
+ package. Its npm `os` metadata permits only `darwin` and `linux`, so a Windows upgrade to an affected
66
+ version is rejected with `EBADPLATFORM`. This applies to existing prerelease users too. Forcing the
67
+ installation does not restore support: the executable refuses commands on unsupported hosts
68
+ before running them (the bare `--version` flag can still identify the installed build).
69
+
70
+ There is no supported Windows replacement on npm. The alternatives are WSL2 or the experimental
71
+ build from source at https://github.com/Holaxis-ai/superbee-windows-cli; neither carries a
72
+ first-party support promise for native Windows. An older installed version is not converted or
73
+ removed by this source change, and existing bundle files are not migrated by it. Review the affected release's notes before changing an existing
74
+ Windows installation. macOS/Linux users can continue using the normal installation and setup flow.
57
75
 
58
76
  Run `superbee version --check` to compare your install with the current stable release.
59
77
 
@@ -103,7 +121,7 @@ run `npm uninstall -g @holaxis/aslite`. Existing `.agentstate-lite/` bundles and
103
121
  ## Learn more
104
122
 
105
123
  The [repository](https://github.com/Holaxis-ai/superbee) holds the source, the
106
- [CLI contract](https://github.com/Holaxis-ai/superbee/blob/main/packages/cli/AXI-CONTRACT.md),
124
+ [CLI contract](https://github.com/Holaxis-ai/superbee/blob/main/packages/superbee/AXI-CONTRACT.md),
107
125
  and the [wire protocol](https://github.com/Holaxis-ai/superbee/blob/main/docs/WIRE-PROTOCOL.md).
108
126
 
109
127
  ## License
package/SKILL.md CHANGED
@@ -97,4 +97,4 @@ preserves a workspace for explicit selection; it never makes that workspace the
97
97
  If home or SessionStart reports `skill_update`, run its exact scope-specific command, restart the
98
98
  host, and continue; Superbee never rewrites an installed Skill automatically.
99
99
 
100
- <!-- GENERATED by packages/cli/scripts/gen-skill.mjs — do not edit by hand. -->
100
+ <!-- GENERATED by packages/superbee/scripts/gen-skill.mjs — do not edit by hand. -->
@@ -1,8 +1,17 @@
1
+ import { type BridgeHostKind } from "@superbee/view-runtime/bridge";
1
2
  import { PUBLICATION_BRIDGE_V0, type PublicationBridgeAdmissionV1, type PublicationBridgeV1, type PublicationSnapshotHandleV1 } from "./types.js";
2
3
  export interface CreatePublicationBridgeOptionsV1 {
3
4
  protocol: typeof PUBLICATION_BRIDGE_V0;
4
5
  snapshot: PublicationSnapshotHandleV1;
5
6
  admittedView: PublicationBridgeAdmissionV1;
7
+ /**
8
+ * The embedding host's identity for `hello.host`. Capabilities default to what this static
9
+ * bridge answers itself; a snapshot pushes no deltas, so `subscribe-deltas` is never declared.
10
+ */
11
+ host?: {
12
+ kind?: BridgeHostKind;
13
+ capabilities?: readonly string[];
14
+ };
6
15
  }
7
16
  /** Create the canonical read-only View bridge over one immutable publication snapshot. */
8
17
  export declare function createPublicationBridge(options: CreatePublicationBridgeOptionsV1): PublicationBridgeV1;
@@ -1,4 +1,8 @@
1
+ import type { FilesystemHostPolicy } from "@superbee/core/filesystem";
1
2
  import { type CapturePublicationSnapshotOptionsV1, type PublicationSnapshotHandleV1 } from "./types.js";
3
+ export interface CapturePublicationRuntimeOptions {
4
+ readonly filesystemHostPolicy?: FilesystemHostPolicy;
5
+ }
2
6
  /** Capture one coherent immutable filesystem publication snapshot. */
3
- export declare function capturePublicationSnapshot(options: CapturePublicationSnapshotOptionsV1): Promise<PublicationSnapshotHandleV1>;
7
+ export declare function capturePublicationSnapshot(options: CapturePublicationSnapshotOptionsV1, runtimeOptions?: CapturePublicationRuntimeOptions): Promise<PublicationSnapshotHandleV1>;
4
8
  //# sourceMappingURL=capture.d.ts.map
@@ -4,4 +4,5 @@ export { PublicationError, isPublicationError } from "./errors.js";
4
4
  export type { PublicationErrorCodeV1, PublicationErrorOptions } from "./errors.js";
5
5
  export { PUBLICATION_SNAPSHOT_SCHEMA_V1 } from "./schema.js";
6
6
  export { PUBLICATION_BRIDGE_V0, PUBLICATION_SNAPSHOT_V1, type CapturePublicationSnapshotOptionsV1, type PublicationBridgeAdmissionV1, type PublicationBridgeOutcomeV1, type PublicationBridgeV1, type PublicationJsonValue, type PublicationObjectRefV1, type PublicationSnapshotHandleV1, type PublicationSnapshotV1, } from "./types.js";
7
+ export type { CapturePublicationRuntimeOptions } from "./capture.js";
7
8
  //# sourceMappingURL=index.d.ts.map