@runblackcat/sdk 0.1.0-alpha.44

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/README.md

@@ -0,0 +1,341 @@
+# blackcat
+
+A self-hosted [Firecracker](https://firecracker-microvm.github.io/) microVM fleet:
+multi-tenant sandboxes with snapshots, resumable workloads, and scale-to-zero.
+
+**Agnostic core, paved AWS path.** The core knows about Linux, not about any cloud. AWS is
+the one deployment path that comes fully assembled; everything else is possible with work.
+
+## Status: hosted development, pre-release
+
+The gateway, placer, node agent, guest, forkable checkpoint templates, durable
+processes, previews and the TypeScript SDK are implemented, and a hot claim from
+a checkpoint template restores in about 1.1 s on the development fleet. Nothing
+is shipped to customers or released as open source.
+
+What is missing before untrusted tenants can share workers is written down in
+[docs/SECURITY.md](docs/SECURITY.md); the ranked backlog is
+[docs/GROOMED.md](docs/GROOMED.md). Readiness levels and the product contract
+are in [docs/PRODUCT.md](docs/PRODUCT.md).
+
+## What it will do
+
+- **Sandbox API** — acquire an isolated microVM with retry-safe request identity
+  and a pinned immutable template version. Creation never blocks: the
+  request is admitted durably and answered at once, so a caller holds a claim
+  rather than a connection.
+- **Queue and backpressure** — a request the fleet has no room for waits durably
+  instead of failing, and is placed by a background drain as capacity arrives.
+  Queued work is charged against tenant quota exactly like running work, so the
+  quota is the backpressure limit and no second limiter exists.
+- **Demand-driven capacity** — the placer sizes the fleet from the backlog it
+  cannot place, through a provider seam, and retires idle workers back to zero.
+- **Forkable templates** — build a Docker image into a validated state, memory,
+  and disk checkpoint, then restore isolated writable clones with its declared
+  services already running. Sealed content-addressed chunks deduplicate within a
+  tenant and are fetched lazily into a bounded node cache.
+- **Snapshot / resume** — UFFD lazy paging, so a resumed sandbox pages memory in on demand
+  instead of waiting for a full restore.
+- **Scale to zero** — idle sandboxes snapshot to disk and release their RAM.
+  The next request resumes them when capacity is available.
+- **HTTP previews** — templates declare named ports; each sandbox gets its own
+  HTTPS hostname, with share-link or public access and optional custom domains.
+  See [HTTP previews and custom domains](docs/preview-domains.md).
+- **Multi-tenant** — tenants share hosts, isolated at the VM boundary by the Firecracker
+  jailer, seccomp, and explicit VM-to-VM network denial.
+
+## Design in one page
+
+| | |
+|---|---|
+| **Gateway** | Stateless. The single authenticated entry point; resolves sandbox→node and proxies. Scales horizontally. |
+| **Placer** | Single writer. Bin-packs by memory and vCPU, proposes placements, owns quotas, the queue and the node registry. Sole writer of substrate desired capacity. |
+| **Node agent** | One per host. Firecracker lifecycle, jailer, networking, UFFD handler. **Final authority on admission** — the placer proposes, the node accepts or rejects. |
+| **Guest agent** | Inside each sandbox, reached over vsock. Exec, file I/O, template-declared boot services. |
+| **Plugin supervisor (in development)** | Runs operator-installed, digest-pinned job-source plugins outside sandbox hosts. Each installation has its own identity, secret scope and sandbox grant. A small Rust SDK calls the scoped private API. |
+
+Nodes **self-register** with a join token — there is no host inventory file anywhere.
+Tenants are **API-managed rows**, not configuration, so an operator can provision
+and use one without restarting the service.
+
+No ZooKeeper, etcd, or Consul at any scale. Placement is sticky and sandboxes never move
+while running, so the problem partitions without consensus.
+
+## How it fits together
+
+```mermaid
+flowchart TB
+  CLI["blackcat-cli"]
+  SDK["TypeScript SDK"]
+
+  subgraph ctrl["Control host"]
+    direction LR
+    GW["blackcat-gateway<br/>auth · capabilities · routing<br/>listens :443"]
+    PL["blackcat-placer<br/>single writer · best-fit<br/>quotas · node registry"]
+    DB[("placer.sqlite")]
+    GW <-->|"Unix socket"| PL
+    PL --- DB
+  end
+
+  subgraph plugins["Plugin host — planned integration"]
+    SUP["Plugin supervisor<br/>digest-pinned images · per-install identity"]
+    subgraph PIN["Per-install isolated bridge — no direct route"]
+      GHPL["GitHub Actions connector<br/>poll queued jobs · request JIT runners"]
+      CPX["Connector proxy<br/>GitHub DNS rules · pinned control target"]
+      GHPL -.->|"HTTPS CONNECT only"| CPX
+    end
+    EXT["Dedicated outbound bridge<br/>proxy only"]
+    RPX["Runner proxy<br/>GitHub DNS rules · no control target"]
+    SUP --> GHPL
+    SUP --> CPX
+    CPX -.-> EXT
+  end
+
+  SEC[("Plugin secret store<br/>local encrypted or AWS Secrets Manager")]
+  GITHUB["GitHub Actions<br/>job queue · results"]
+
+  OS[("Opaque object store<br/>S3 or filesystem")]
+
+  subgraph nodehost["Node host — one per machine, N machines"]
+    AG["blackcat-agent<br/>listens :8081"]
+    UF["UFFD handler<br/>one process per restore"]
+    FC["Firecracker + jailer"]
+    GU["blackcat-guest<br/>PID 1 inside the VM"]
+    RUN["Ephemeral Actions runner<br/>nonroot guest process"]
+    AG -->|spawns| UF
+    AG --> FC
+    UF -.->|"page faults"| FC
+    FC -->|vsock| GU
+    GU -->|"nonroot boot service"| RUN
+  end
+
+  CLI -->|HTTPS| GW
+  SDK -->|HTTPS| GW
+  CLI -.->|"admin plugin API"| GW
+  PL -.->|"installation state"| SUP
+  SUP -.->|"scoped Blackcat API"| GW
+  SUP -.->|"per-install secret refs"| SEC
+  EXT -.->|"GitHub API via proxy"| GITHUB
+  EXT -.->|"pinned private API via proxy"| GW
+  RPX -.->|"GitHub runner traffic"| GITHUB
+  RUN -.->|"one job + result"| RPX
+  GW ---|"metadata + grants"| OS
+  AG <-->|"short-lived object grants"| OS
+  GW -->|"node TLS"| AG
+  PL -->|"node TLS · propose"| AG
+  AG -->|"HTTPS · register, heartbeat, objects"| GW
+```
+
+Dashed plugin links show the intended integration, not a deployed runner. The
+connector observes external jobs and asks Blackcat for a sandbox; the external
+source remains the job and result authority. Runner code executes only inside a
+sandbox, without the connector's private key or plugin service credential. See
+the [plugin system contract](docs/plugin-system.md) for the current boundary.
+
+**Creating a sandbox.** The gateway checks the caller's capability token and opens a
+durable acquisition receipt keyed by `(tenant, request_id)`, so a retry is the same
+lease rather than a second VM. The placer picks candidate nodes by best fit over free
+memory and vCPU — snapshot-cache affinity first — and **proposes** to each in turn. The
+node accepts or rejects; it is the final admission authority, not the placer. On
+acceptance the agent starts Firecracker under the jailer, and `blackcat-guest` boots as
+PID 1 and serves the vsock protocol. Until the sandbox reports `placed`, the API answers
+`202 pending` and it is not ready for commands.
+
+Three things the picture above is drawn carefully to show:
+
+- **The placer talks to nodes itself.** It is not hidden behind the gateway — it opens
+  its own node-TLS connections to propose placements.
+- **Nodes receive only object-scoped grants.** The control plane authorizes a
+  specific artifact operation and the node transfers sealed bytes directly.
+  Nodes never receive a general object-store or tenant credential.
+- **There are two TLS trust domains**, not one. Clients and agents reach the gateway
+  under the control-plane CA; the gateway and placer reach node agents under a separate
+  node CA issuing 24-hour leaves.
+
+Gateway and placer speak over a Unix socket, so they are co-located on one host by
+construction. Everything else is a network hop.
+
+## Capacity and observability
+
+Creation is admitted durably and answered immediately. A request the fleet cannot
+place becomes a **queued acquisition** — it keeps its sandbox identity and its
+quota charge, and a background drain places it as capacity appears. Callers poll
+the claim they already hold:
+
+```
+POST /v1/sandboxes {request_id,template,lease:{ttl_secs,renewable_for_secs}}
+                                            -> 202 {"request_id":…, "id":…, "state":"pending", "expires_at":…}
+GET  /v1/sandboxes/acquisitions/{id}       -> 202 pending … -> 200 {"state":"placed","node":…}
+POST /v1/sandboxes/{id}/renew {ttl_secs}   -> 200 {"expires_at":…, "renewable_until":…}
+```
+
+`request_id` is caller-supplied and is the idempotency boundary, so repeating a
+create is always safe: it returns the same claim rather than allocating a second
+sandbox.
+
+Backpressure uses separate tenant limits for running allocations and retained
+snapshots. Pending/resuming work reserves running capacity; hibernating and
+resuming transitions reserve both classes until they commit. A queued acquisition
+that waits past the queue deadline is torn down by the ordinary expiry reconciler.
+
+The placer sizes the fleet from that backlog through the `CapacityProvider`
+seam, and is the **only** writer of substrate desired capacity — it raises the
+count from unplaceable demand and lowers it only by retiring workers it has
+proven empty. An external autoscaling policy driving the same knob would fight
+it, so deployments should cap the fleet (a maximum size) rather than scale it.
+
+`GET /metrics` exposes Prometheus text to the **admin credential**. The series
+are fleet-wide and keyed by tenant, so unlike `/v1/fleet` — which serves an
+`INSPECT` holder its own rows only — there is no tenant-scoped view to hand out.
+`/livez` and `/readyz` stay unauthenticated because they disclose nothing.
+
+```
+blackcat_demand_unsatisfied{tenant="…"}          queued acquisitions
+blackcat_demand_oldest_age_seconds               longest current wait
+blackcat_capacity_target_nodes                   workers last asked for
+blackcat_nodes{health="healthy"}                 workers actually registered
+blackcat_placement_rejected_total{reason="…"}    no_capacity | quota
+```
+
+A fleet pinned at its ceiling shows up as `blackcat_capacity_target_nodes`
+persistently above `blackcat_nodes`.
+
+## Install (alpha)
+
+Identical on bare metal and on AWS:
+
+```bash
+blackcat init --bind 0.0.0.0:8080 --hostname control.example
+# init installs and starts blackcat-placer and blackcat-gateway
+
+# Copy /etc/blackcat/tls/ca.pem to each node. Join tokens are single-use, so
+# mint a distinct token with `blackcat join-token` for each node.
+blackcat join https://control.example:8080 \
+  --token <node-1-token> --ca-cert /path/to/ca.pem
+blackcat join https://control.example:8080 \
+  --token <node-2-token> --ca-cert /path/to/ca.pem
+
+# Fleet and workload operations use a tenant capability token, not the admin
+# credential. Create a tenant/API key and mint that token through the API.
+blackcat fleet status --control-plane https://control.example:8080 \
+  --ca-cert /path/to/ca.pem --token <capability-token>
+blackcat template create --control-plane https://control.example:8080 \
+  --ca-cert /path/to/ca.pem --token <capability-token> --name base \
+  --docker <image> --vcpus <n> --memory-mib <m>
+blackcat sandbox create --control-plane https://control.example:8080 \
+  --ca-cert /path/to/ca.pem --token <capability-token> --template <t> \
+  --request-id <stable-acquisition-id> --ttl-secs 3600 \
+  --renewable-for-secs 86400
+```
+
+Create request IDs identify logical acquisitions: reuse the ID and exact
+parameters after an interrupted request, never for a new VM. A `pending`
+receipt is not ready for commands. EXEC also requires an explicit positive
+`--timeout-ms` (or JSON `timeout_ms`); timeout does not undo effects that already
+happened. These breaking pre-trial contracts are being verified together; old
+embedded guests and callers must be rebuilt/updated, not silently accepted.
+
+AWS adds exactly two things: an AMI that registers itself using the EC2 instance identity
+document, and a `CapacityProvider` that wraps an ASG. If AWS ever needs a *different*
+path, the design has failed — there is a test for that.
+
+**Bare-metal prerequisites:** Linux with `/dev/kvm`, root for the node agent, a hardened
+host kernel, and an uncompressed guest `vmlinux` ≥ 5.18. Releases ship a known-good guest
+kernel, because otherwise a new user's first task is a kernel build.
+Control-plane `blackcat init` additionally requires systemd and Python 3 at
+`/usr/bin/python3`. Init checks the interpreter before changing host state and
+installs the shared bounded placer-listener gate for every gateway start.
+The gate establishes startup ordering, not catalog or workload readiness.
+Filesystem template nodes also need `e2fsprogs` (`mkfs.ext4` and `resize2fs`)
+and GNU `cp` with sparse/reflink support. A compact template is verified before
+its private sandbox copy is grown to the declared writable capacity; missing
+growth tooling is a launch error, not permission to boot a smaller disk.
+
+Generic plain-Linux installs use the default-feature `blackcat-agent-x86_64-musl`,
+`blackcat-gateway-x86_64-musl`, and `blackcat-placer-x86_64-musl` release artifacts.
+The AWS AMI uses the corresponding `-aws` variants.
+
+## Authentication modes
+
+Private/VPC installations keep the existing static authentication mode: an
+administrator creates tenant API keys, each with a fixed operation set, and
+those keys mint short-lived Blackcat capabilities within that set. Optional hosted access adds external
+OIDC login for people while retaining those same capabilities as the workload
+authorization boundary. OIDC is not required for a private cluster, and enabling
+it does not expose admin or node authority.
+
+The context/login/claim CLI and the exact trust, storage and public deployment
+boundaries are specified in
+[docs/public-access-auth.md](docs/public-access-auth.md). Public reachability is
+network policy, not an application `public` switch.
+For an identity provider that requires an exact pre-registered loopback
+redirect, use `blackcat login --callback-port PORT` and register
+`http://127.0.0.1:PORT/callback` on its public OIDC client. The default login
+continues to choose a free ephemeral port.
+Hosted CLI sessions use a revocable 12-hour access credential and a distinct
+30-day, non-extendable refresh credential. The CLI renews and rotates both
+automatically before commands; browser login is required again at the absolute
+deadline or after revocation. See
+[the session lifecycle and tradeoff](docs/hosted-session-renewal.md). The
+[disposable dev trial runbook](docs/history/hosted-auth-dev-e2e.md#manual-cli-login-to-claim-window)
+includes a macOS Docker harness for a manual login-to-claim test; it is not a
+production deployment recipe.
+
+For a native, globally usable `blackcat` command on Apple-silicon macOS or
+Linux x86-64/arm64, run `curl -fsSL https://runblackcat.dev/install.sh | sh`;
+see [CLI installation](docs/cli-install.md). The installer uses release
+checksums from the public
+[`blackcat-releases`](https://github.com/TreebeardHQ/blackcat-releases) mirror
+and needs neither Docker nor Rust on the client. The site itself lives in
+[`site/`](site/) and publishes an allowlisted subset of `docs/`.
+`blackcat template list` shows launchable templates to members without their
+source; `blackcat sandbox claim alpine-e2e-matched` resolves the latest version
+and pins its ID for safe retries. Intel Mac binaries are not published.
+
+## Documentation
+
+- **[docs/PRODUCT.md](docs/PRODUCT.md)** — the product contract and readiness levels.
+- **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** — processes, crates, trust domains, a sandbox's life.
+- **[docs/SECURITY.md](docs/SECURITY.md)** — isolation boundaries and known gaps.
+- **[docs/GROOMED.md](docs/GROOMED.md)** — the ranked backlog.
+- **[AGENTS.md](AGENTS.md)** — how to work in this repository.
+- **[docs/forkable-templates.md](docs/forkable-templates.md)**,
+  **[docs/preview-domains.md](docs/preview-domains.md)**,
+  **[docs/public-access-auth.md](docs/public-access-auth.md)** — feature contracts.
+- **docs/history/** — the original plan, the progress ledger, trial acceptance
+  records and measurements. Rationale lives there; it is not required reading.
+
+## Prior art worth knowing
+
+[e2b-dev/infra](https://github.com/e2b-dev/infra) (Apache-2.0) solves much of this and is
+worth borrowing from — its AWS support is beta and it requires operating Nomad + Consul,
+which is the gap blackcat targets. Firecracker's own UFFD reference handler, the
+[rust-vmm](https://github.com/rust-vmm) crates, and Cloud Hypervisor are the other sources.
+
+## Contributing
+
+While the service is pre-0.01, **commit straight to `main`** — no PR review cycle,
+no branch discipline. Use conventional commit titles (`feat:`, `fix:`, `docs:`,
+`refactor:`, `test:`, `chore:`), and verify in proportion to risk before pushing.
+
+```sh
+git add <paths>
+git commit -m "fix(gateway): ..."
+git push origin main
+```
+
+Open a PR only when you want hosted CI to check something you cannot check
+locally — the Rust toolchain is pinned in `rust-toolchain.toml`, so a container
+gets you the same compiler without installing one:
+
+```sh
+docker run --rm -v "$PWD":/w -w /w rust:1.85.1 \
+  sh -c "cargo fmt --check && cargo clippy --workspace --all-targets -- -D warnings && cargo test"
+```
+
+This will tighten up before a real release. See [AGENTS.md](AGENTS.md) for the
+security and provider-boundary rules that do *not* relax.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@runblackcat/sdk",
+  "version": "0.1.0-alpha.44",
+  "description": "TypeScript SDK for the Blackcat sandbox gateway",
+  "license": "Apache-2.0",
+  "repository": "https://github.com/TreebeardHQ/blackcat",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./sdk/dist/index.d.ts",
+      "import": "./sdk/dist/index.js",
+      "default": "./sdk/dist/index.js"
+    }
+  },
+  "files": ["sdk/dist", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "bun build sdk/src/index.ts --outdir sdk/dist --target node --format esm && tsc -p sdk/tsconfig.build.json",
+    "typecheck": "tsc -p sdk/tsconfig.json --noEmit",
+    "test": "bun test sdk/src/index.test.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "1.3.12",
+    "typescript": "6.0.3"
+  },
+  "engines": {
+    "bun": ">=1.1"
+  }
+}