@forgezero/agent 0.1.99 → 0.1.101

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
@@ -11,7 +11,7 @@ The node agent deploys on a compute; tenant mode also holds one complete project
11
11
 
12
12
  ## Package overview
13
13
 
14
- Every managed compute. It owns node identity, attestation and repository pipelines. An SNP compute may hold its assigned whole project across environments in RAM after current attestation. Ordinary compute is API-only unless an administrator explicitly records the versioned non-TEE risk acceptance for that concrete machine. Platform mode never replicates realm-wide API authority beside the process that already holds unlocked realm seeds. Supported runtimes: bun, node. Package root: @forgezero/agent. The sections below show the actual named imports emitted by each declaration entry point; wildcard imports are intentionally not used in the documentation.
14
+ Every managed compute. It owns node identity, attestation and repository pipelines. An SNP compute may hold its assigned whole project across environments in RAM after current attestation. Ordinary compute is API-only unless an administrator explicitly records the versioned non-TEE risk acceptance for that concrete machine. Platform mode never replicates realm-wide API authority beside the process that already holds unlocked realm seeds. Supported runtimes: bun, node. Package root: @forgezero/agent. Consumer documentation is curated with each module's explicit public flag; the complete internal/export inventory remains in the typed SSOT and declaration files.
15
15
 
16
16
  ```text
17
17
  bun add -g @forgezero/agent
@@ -29,1124 +29,37 @@ The five packages are installation boundaries. Choose a package by who installs
29
29
  | @forgezero/runtime | Portable runtime primitives for queries, jobs, events, schemas and finance. | bun, node | [Open](https://www.forgezero.net/docs/runtime) |
30
30
  | @forgezero/agent | Operator CLI and managed-node agent for bootstrap, deploy and lifecycle. | bun, node | [Open](https://www.forgezero.net/docs/agent) |
31
31
 
32
- ## @forgezero/agent public imports and commands
32
+ ## @forgezero/agent supported imports and commands
33
33
 
34
- Every row links to the detailed explanation and named-import/example area below. This table and those details are generated from the package inventory and emitted declarations.
34
+ These are supported consumer entry points, not every internal module shipped for ForgeZero managed installation. Each row links to its task-oriented usage.
35
35
 
36
36
  | public entry | short description | runtime | details |
37
37
  |---|---|---|---|
38
- | fz | The operator command: keys, status, genesis, unlock, run, and agent install. | Bun/Node host | [Reference + usage](#fz) |
39
- | fz run | The fallback for software that cannot read the local socket: start a process with scoped vault values in its environment. | Bun/Node host | [Reference + usage](#fz-run) |
40
- | fz agent install | Provision the same hardened agent service locally that the platform provisions remotely. | Bun/Node host | [Reference + usage](#fz-agent-install) |
41
- | fz-agent | The service entry point. Identity and private Git material arrive only as systemd credentials. A platform bootstrap may use a statically configured local control socket; an enrolled tenant guest builds each deployment manager from its signed server claim and reads all commands from the checked-out .fz definition. The signed enrolment binding constructs the exact project scope. Vault synchronization succeeds only when the API sees current SNP evidence or an audited versioned non-TEE acceptance; ordinary compute otherwise remains API-only and a revocation clears its resident cache. | Bun/Node host | [Reference + usage](#fz-agent) |
42
- | fz-agent (socket) | identity, sign, attest, get, sync and held — the whole interface an application sees. | Bun/Node host | [Reference + usage](#fz-agent-socket) |
43
- | @forgezero/agent/migration-pull | PQ-authenticated outbound lifecycle claims with fenced renewal, awaited async execution, idempotent acknowledgement and bounded shutdown drain. The executor reports local facts only. | Bun/Node host | [Reference + usage](#forgezero-agent-migration-pull) |
44
- | @forgezero/agent/lifecycle-helper | The root-owned fixed-operation boundary for migration work. Signed controller claims can request only private reachability probes, local health checks, or stops of units named in a root-owned profile; they cannot carry commands. | Bun/Node host | [Reference + usage](#forgezero-agent-lifecycle-helper) |
45
- | @forgezero/agent/provision | The install plan as data, with no transport — so `fz` running locally and the platform running over SSH provision an identical machine. | Bun/Node host | [Reference + usage](#forgezero-agent-provision) |
46
- | @forgezero/agent/platform-genesis | Offline authority adapter for the brief pre-API period. It validates exactly three reviewed generic guest requests and converts them to the same Metal claims the live API issues; environment and product tier are not provisioning inputs. | Bun/Node host | [Reference + usage](#forgezero-agent-platform-genesis) |
47
- | @forgezero/agent/subscribe | Realtime scope sync over a WebSocket, with the poll kept underneath it: the poll is what establishes freshness, and a change it finds that the socket never sent is proof the socket is lying. | Bun/Node host | [Reference + usage](#forgezero-agent-subscribe) |
48
- | @forgezero/agent/ssh-listen | The socket SSH_AUTH_SOCK points at. The protocol handler had nowhere to speak — an agent protocol with no socket is a parser. The containing directory is 0700 before anything binds, because the socket’s own mode is only corrected after it already exists. | Bun/Node host | [Reference + usage](#forgezero-agent-ssh-listen) |
49
- | @forgezero/agent/ssh-server | Serve the SSH agent protocol so SSH_AUTH_SOCK points at the vault — two operations implemented, and ADD_IDENTITY refused so no process can inject a key ssh would offer to every host. | Bun/Node host | [Reference + usage](#forgezero-agent-ssh-server) |
50
- | @forgezero/agent/pipeline | CI/CD on the compute: secrets reach the step that named them and nothing else, attestation gates the run, and a required attestation that fails is a refusal rather than a downgrade. | Bun/Node host | [Reference + usage](#forgezero-agent-pipeline) |
51
- | @forgezero/agent/agent-heartbeat | Signed node health publication with bounded renewal and shutdown withdrawal. | Bun/Node host | [Reference + usage](#forgezero-agent-agent-heartbeat) |
52
- | @forgezero/agent/agent-update | Verified Agent update planning against the platform release coordinate. | Bun/Node host | [Reference + usage](#forgezero-agent-agent-update) |
53
- | @forgezero/agent/agent-update-helper | Root-owned fixed update operations with registry origin and integrity validation. | Bun/Node host | [Reference + usage](#forgezero-agent-agent-update-helper) |
54
- | @forgezero/agent/bootstrap | Typed one-time platform bootstrap and internal API-driven enrolled-compute activation contracts. | Bun/Node host | [Reference + usage](#forgezero-agent-bootstrap) |
55
- | @forgezero/agent/bootstrap-bundle | Owner-only exact-revision Git bundle and SHA-256 manifest for credential-free release generation one. | Bun/Node host | [Reference + usage](#forgezero-agent-bootstrap-bundle) |
56
- | @forgezero/agent/operator-bootstrap | Pinned-host operator transport that stages owner-only handoffs and invokes the same typed platform bootstrap through the caller-approved SSH agent. | Bun/Node host | [Reference + usage](#forgezero-agent-operator-bootstrap) |
57
- | @forgezero/agent/host-maintenance | Closed host maintenance plans for staging transaction rehearsal and fleet-fenced schema consolidation through fixed transient systemd units. | Bun/Node host | [Reference + usage](#forgezero-agent-host-maintenance) |
58
- | @forgezero/agent/capacity-calibration | One-time target-local safe-concurrency calibration with private evidence. | Bun/Node host | [Reference + usage](#forgezero-agent-capacity-calibration) |
59
- | @forgezero/agent/cloudflare-bootstrap | Attended two-token Cloudflare Tunnel/DNS reconciliation and per-node connector/KV runtime handoff for existing KV resources. | Bun/Node host | [Reference + usage](#forgezero-agent-cloudflare-bootstrap) |
60
- | @forgezero/agent/cloudflare-edge | Strict Cloudflare REST operations used by the attended bootstrap controller. | Bun/Node host | [Reference + usage](#forgezero-agent-cloudflare-edge) |
61
- | @forgezero/agent/mesh-connector | Fixed Cloudflare Mesh/WARP connector enrollment using only the unit-loaded connector credential. | Bun/Node host | [Reference + usage](#forgezero-agent-mesh-connector) |
62
- | @forgezero/agent/compute | Compute claim, renewal, execution and completion client contracts. | Bun/Node host | [Reference + usage](#forgezero-agent-compute) |
63
- | @forgezero/agent/credential-schema | Canonical systemd credential names and validation shared by bootstrap and services. | Bun/Node host | [Reference + usage](#forgezero-agent-credential-schema) |
64
- | @forgezero/agent/definition | Legacy version 3 JSON deployment compatibility contract. | Bun/Node host | [Reference + usage](#forgezero-agent-definition) |
65
38
  | @forgezero/agent/deploy | Typed deployment authoring builders, built-in provider requirements and versioned action constructors. | Bun/Node host | [Reference + usage](#forgezero-agent-deploy) |
66
- | @forgezero/agent/deployment-targets | Bounded input resolution and stable compute-target assignment for typed plans; emits requirements and slots rather than physical hostnames. | Bun/Node host | [Reference + usage](#forgezero-agent-deployment-targets) |
67
- | @forgezero/agent/deployment-connectivity | Root-owned convergence of exact private routes, routed-port firewall rules and per-target Cloudflare Tunnel or Mesh connector capabilities without exposing the project management token to a compute. | Bun/Node host | [Reference + usage](#forgezero-agent-deployment-connectivity) |
68
- | @forgezero/agent/deployment-topology | Pure per-Metal relay election and hierarchical peer assignment: one or two Metals stay direct-private, while three or more grant Mesh/WARP only to relay and standby. | Bun/Node host | [Reference + usage](#forgezero-agent-deployment-topology) |
69
- | @forgezero/agent/deploy-plan | Runtime validation, canonicalization and semantic digest for inert deployment plans. | Bun/Node host | [Reference + usage](#forgezero-agent-deploy-plan) |
70
- | @forgezero/agent/deploy-plan-runner | Conditional DAG execution with bounded retry, compensation and failure policy over injected action handlers. | Bun/Node host | [Reference + usage](#forgezero-agent-deploy-plan-runner) |
71
- | @forgezero/agent/deploy-compiler | Explicit developer/CI compiler from forgezero.deploy.ts to canonical .fz/deploy.plan.json; never used to execute project TypeScript in production. | Bun/Node host | [Reference + usage](#forgezero-agent-deploy-compiler) |
72
- | @forgezero/agent/deploy-file | Read and validate a checked-out .fz deployment file without executing project input. | Bun/Node host | [Reference + usage](#forgezero-agent-deploy-file) |
73
- | @forgezero/agent/metal-bootstrap | Physical-metal bootstrap planning, application and status evidence. | Bun/Node host | [Reference + usage](#forgezero-agent-metal-bootstrap) |
74
- | @forgezero/agent/metal-provision | The single constrained compute materializer for platform genesis, platform scaling and tenant compute. It executes caller-supplied OS, CPU, memory, disk, bandwidth, network and confidentiality coordinates after capacity and image validation; it owns no environment or product-tier shape. | Bun/Node host | [Reference + usage](#forgezero-agent-metal-provision) |
75
- | @forgezero/agent/platform-bootstrap-runtime | Pure platform bootstrap validation, render and resumable phase-state contracts. | Bun/Node host | [Reference + usage](#forgezero-agent-platform-bootstrap-runtime) |
76
- | @forgezero/agent/project-context | Project identity and repository context validation for operator and managed runs. | Bun/Node host | [Reference + usage](#forgezero-agent-project-context) |
77
- | @forgezero/agent/provisioning-pull | Signed provisioning work claim, renewal, execution and acknowledgement. | Bun/Node host | [Reference + usage](#forgezero-agent-provisioning-pull) |
78
39
  | @forgezero/agent/schema/deploy-v3.json | Published JSON Schema for deployment definition version 3 with exact argv execution. | Bun/Node host | [Reference + usage](#forgezero-agent-schema-deploy-v3-json) |
79
- | @forgezero/agent/software | Exact managed-software inventory, requirement and evidence contracts. | Bun/Node host | [Reference + usage](#forgezero-agent-software) |
80
- | @forgezero/agent/software-helper | Root-owned fixed installation/update boundary for declared software. | Bun/Node host | [Reference + usage](#forgezero-agent-software-helper) |
81
- | @forgezero/agent/ubuntu | The closed guest-image view: pinned Ubuntu 26.04 LTS x64 supports ordinary or SEV-SNP compute, while pinned Ubuntu 24.04 LTS x64 is limited to ordinary non-confidential compute. Every other OS remains rejected until its own pinned strategy and acceptance evidence are added. | Bun/Node host | [Reference + usage](#forgezero-agent-ubuntu) |
82
- | fz-agent (replica) | The authorized project-scoped vault replica: resident in RAM, never on disk, invalidated by cursor rather than by timer, cleared when local authority is revoked, and refusing a read it can no longer vouch for. | Bun/Node host | [Reference + usage](#fz-agent-replica) |
83
40
 
84
41
  ## Commands
85
42
 
86
43
  bun add -g @forgezero/agent — Install the version-matched fz operator CLI and fz-agent daemon.
87
44
  fz deploy init — Create a typed forgezero.deploy.ts and its canonical inert execution plan.
88
- fz deploy init --runtime containerd --os ubuntu-24.04 --replicas 1 --cpu-cores 2 --memory-mib 2048 --storage-gib 20 --reuse require — Create one ordinary containerd/runc compute definition with exact reserved resources; existing eligible project capacity is required.
89
- fz deploy init --runtime kata-snp --os ubuntu-26.04 --replicas 1 --cpu-cores 2 --memory-mib 4096 --storage-gib 40 --reuse require — Create one Kata QEMU SEV-SNP definition on existing eligible capacity. Use reuse prefer only with the explicit provisioning and spend-ceiling flags shown by fz deploy init --help.
90
45
  fz deploy compile — Compile and validate TypeScript deployment intent into .fz/deploy.plan.json.
91
46
  fz deploy check — Refuse stale plans, unsafe provider/action coordinates and unresolved deployment blockers.
92
- fz bootstrap platform launch --profile development --apply — Run the one attended ForgeZero launch: public topology and bundle are derived; answer only email settings, hidden provider tokens and APPLY.
93
- fz bootstrap platform fleet apply --bootstrap-config /secure/forgezero/development/genesis/platform-fleet-remote.json — Resume or diagnose an already generated fleet plan; this is not the normal first-launch path.
94
- fz bootstrap platform --help — Inspect attended platform bootstrap inputs before applying them.
95
- fz bootstrap metal --help — Inspect the identity-only physical provisioner bootstrap.
96
- fz host transactions|schema-plan|schema-apply — Plan fixed supervised database maintenance; add --apply only after reviewing the exact argv and credential names.
97
- fz status — Read installed service and bootstrap evidence.
98
47
 
99
48
  ```text
100
49
  bun add -g @forgezero/agent
101
50
  fz deploy init
102
- fz deploy init --runtime containerd --os ubuntu-24.04 --replicas 1 --cpu-cores 2 --memory-mib 2048 --storage-gib 20 --reuse require
103
- fz deploy init --runtime kata-snp --os ubuntu-26.04 --replicas 1 --cpu-cores 2 --memory-mib 4096 --storage-gib 40 --reuse require
104
51
  fz deploy compile
105
52
  fz deploy check
106
- fz bootstrap platform launch --profile development --apply
107
- fz bootstrap platform fleet apply --bootstrap-config /secure/forgezero/development/genesis/platform-fleet-remote.json
108
- fz bootstrap platform --help
109
- fz bootstrap metal --help
110
- fz host transactions|schema-plan|schema-apply
111
- fz status
112
- ```
113
-
114
- <a id="fz"></a>
115
- ## fz
116
-
117
- The operator command: keys, status, genesis, unlock, run, and agent install. This entry requires a Bun/Node host runtime. Run the command with `--help` before applying it.
118
-
119
- ```text
120
- fz --help
121
- ```
122
-
123
- ## fz — Keep project truth synchronized
124
-
125
- One versioned ForgeZero manifest generates thin AI-tool adapters and CI rejects drift.
126
-
127
- ```text
128
- fz project init
129
- fz project sync
130
- fz project check
131
- ```
132
-
133
- <a id="fz-run"></a>
134
- ## fz run
135
-
136
- The fallback for software that cannot read the local socket: start a process with scoped vault values in its environment. This entry requires a Bun/Node host runtime. Run the command with `--help` before applying it.
137
-
138
- ```text
139
- fz run --help
140
- ```
141
-
142
- ## fz run — Inspect before use
143
-
144
- This is a command entry. Read its typed option contract before an operation; apply-capable commands remain plans unless their explicit apply flag is supplied.
145
-
146
- ```text
147
- fz run --help
148
- ```
149
-
150
- <a id="fz-agent-install"></a>
151
- ## fz agent install
152
-
153
- Provision the same hardened agent service locally that the platform provisions remotely. This entry requires a Bun/Node host runtime. Run the command with `--help` before applying it.
154
-
155
- ```text
156
- fz agent install --help
157
- ```
158
-
159
- ## fz agent install — Inspect before use
160
-
161
- This is a command entry. Read its typed option contract before an operation; apply-capable commands remain plans unless their explicit apply flag is supplied.
162
-
163
- ```text
164
- fz agent install --help
165
- ```
166
-
167
- <a id="fz-agent"></a>
168
- ## fz-agent
169
-
170
- The service entry point. Identity and private Git material arrive only as systemd credentials. A platform bootstrap may use a statically configured local control socket; an enrolled tenant guest builds each deployment manager from its signed server claim and reads all commands from the checked-out .fz definition. The signed enrolment binding constructs the exact project scope. Vault synchronization succeeds only when the API sees current SNP evidence or an audited versioned non-TEE acceptance; ordinary compute otherwise remains API-only and a revocation clears its resident cache. This entry requires a Bun/Node host runtime. Run the command with `--help` before applying it.
171
-
172
- ```text
173
- fz-agent --help
174
- ```
175
-
176
- ## fz-agent — Inspect before use
177
-
178
- This is a command entry. Read its typed option contract before an operation; apply-capable commands remain plans unless their explicit apply flag is supplied.
179
-
180
- ```text
181
- fz-agent --help
182
- ```
183
-
184
- <a id="fz-agent-socket"></a>
185
- ## fz-agent (socket)
186
-
187
- identity, sign, attest, get, sync and held — the whole interface an application sees. This entry requires a Bun/Node host runtime. This is a managed runtime interface label, not an import or standalone executable.
188
-
189
- ```text
190
- fz-agent (socket)
191
- # Accessed through the installed Agent boundary.
192
- ```
193
-
194
- ## fz-agent (socket) — Outbound control boundary
195
-
196
- The Metal Agent initiates outbound signed HTTPS for orchestration. Applications use the project-scoped local Unix socket; the platform never opens an inbound shell control plane.
197
-
198
- ```text
199
- metal/compute Agent -> outbound signed HTTPS -> platform API
200
- application -> local Unix socket -> project-scoped Vault replica
201
- ```
202
-
203
- <a id="forgezero-agent-migration-pull"></a>
204
- ## @forgezero/agent/migration-pull
205
-
206
- PQ-authenticated outbound lifecycle claims with fenced renewal, awaited async execution, idempotent acknowledgement and bounded shutdown drain. The executor reports local facts only. This entry exposes 2 named value exports and 7 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
207
-
208
- ```text
209
- import {
210
- pullMigrationOnce,
211
- startMigrationPull,
212
- } from '@forgezero/agent/migration-pull';
213
-
214
- import type {
215
- MigrationAction,
216
- MigrationEvidence,
217
- MigrationEvidenceProfile,
218
- MigrationNetwork,
219
- MigrationPullOptions,
220
- MigrationPullResult,
221
- RemoteMigrationClaim,
222
- } from '@forgezero/agent/migration-pull';
223
- ```
224
-
225
- ## @forgezero/agent/migration-pull — Use this entry point
226
-
227
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
228
-
229
- ```text
230
- import {
231
- pullMigrationOnce,
232
- } from '@forgezero/agent/migration-pull';
233
-
234
- export const selectedCapability = pullMigrationOnce;
235
- ```
236
-
237
- <a id="forgezero-agent-lifecycle-helper"></a>
238
- ## @forgezero/agent/lifecycle-helper
239
-
240
- The root-owned fixed-operation boundary for migration work. Signed controller claims can request only private reachability probes, local health checks, or stops of units named in a root-owned profile; they cannot carry commands. This entry exposes 7 named value exports and 3 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
241
-
242
- ```text
243
- import {
244
- DEFAULT_LIFECYCLE_HELPER_SOCKET,
245
- executeLifecycleAction,
246
- loadLifecycleProfile,
247
- requestLifecycleAction,
248
- spawnLifecycleCommand,
249
- startLifecycleHelper,
250
- validateLifecycleProfile,
251
- } from '@forgezero/agent/lifecycle-helper';
252
-
253
- import type {
254
- LifecycleCommandResult,
255
- LifecycleExec,
256
- LifecycleProfile,
257
- } from '@forgezero/agent/lifecycle-helper';
258
- ```
259
-
260
- ## @forgezero/agent/lifecycle-helper — Use this entry point
261
-
262
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
263
-
264
- ```text
265
- import {
266
- DEFAULT_LIFECYCLE_HELPER_SOCKET,
267
- } from '@forgezero/agent/lifecycle-helper';
268
-
269
- export const selectedCapability = DEFAULT_LIFECYCLE_HELPER_SOCKET;
270
- ```
271
-
272
- <a id="forgezero-agent-provision"></a>
273
- ## @forgezero/agent/provision
274
-
275
- The install plan as data, with no transport — so `fz` running locally and the platform running over SSH provision an identical machine. This entry exposes 38 named value exports and 11 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
276
-
277
- ```text
278
- import {
279
- AGENT_CANDIDATE_UNIT_PATH,
280
- AGENT_EGRESS_UNIT_PATH,
281
- AGENT_SOCKET_PROXY_UNIT_PATH,
282
- AGENT_SOCKET_UNIT_PATH,
283
- APPLICATION_RUNTIME_USER,
284
- CAPABILITY_CHECKS,
285
- DEFAULT_RUNNER_PUBLIC_TCP_PORTS,
286
- DEPLOYMENT_GROUP,
287
- DEPLOYMENT_RUNNER_SOCKET,
288
- DEPLOYMENT_RUNNER_UNIT_PATH,
289
- DEPLOYMENT_RUNNER_USER,
290
- ENROLMENT_UNIT_PATH,
291
- LIFECYCLE_GROUP,
292
- LIFECYCLE_HELPER_SOCKET,
293
- LIFECYCLE_HELPER_UNIT_PATH,
294
- UNIT_PATH,
295
- VAULT_GROUP,
296
- WARP_CONFIG_UNIT_PATH,
297
- WARP_SERVICE_DROP_IN_PATH,
298
- agentBackendSocketPath,
299
- agentCandidateSocketPath,
300
- agentCandidateUnit,
301
- agentEgressUnit,
302
- agentEnrolmentUnit,
303
- agentRoutingSocketPath,
304
- agentSocketProxyUnit,
305
- agentSocketUnit,
306
- agentUnit,
307
- agentUpdateHelperUnit,
308
- atLeast,
309
- deploymentRunnerUnit,
310
- lifecycleHelperUnit,
311
- modeFor,
312
- planProvision,
313
- reasonFor,
314
- softwareHelperUnit,
315
- warpConfigUnit,
316
- warpServiceDropIn,
317
- } from '@forgezero/agent/provision';
318
-
319
- import type {
320
- AgentMode,
321
- Capabilities,
322
- CapabilityId,
323
- CapabilityOperation,
324
- Check,
325
- DirectorySpec,
326
- FixedHostCommand,
327
- ProvisionOperation,
328
- ProvisionPlan,
329
- Step,
330
- UnitOptions,
331
- } from '@forgezero/agent/provision';
332
- ```
333
-
334
- ## @forgezero/agent/provision — Use this entry point
335
-
336
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
337
-
338
- ```text
339
- import {
340
- AGENT_CANDIDATE_UNIT_PATH,
341
- } from '@forgezero/agent/provision';
342
-
343
- export const selectedCapability = AGENT_CANDIDATE_UNIT_PATH;
344
- ```
345
-
346
- <a id="forgezero-agent-platform-genesis"></a>
347
- ## @forgezero/agent/platform-genesis
348
-
349
- Offline authority adapter for the brief pre-API period. It validates exactly three reviewed generic guest requests and converts them to the same Metal claims the live API issues; environment and product tier are not provisioning inputs. This entry exposes 4 named value exports and 1 named type export. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
350
-
351
- ```text
352
- import {
353
- platformCommunityRehearsalClaims,
354
- platformCommunityRehearsalDeletionClaims,
355
- platformGenesisClaims,
356
- validatePlatformGenesisGuests,
357
- } from '@forgezero/agent/platform-genesis';
358
-
359
- import type {
360
- PlatformGenesisGuest,
361
- } from '@forgezero/agent/platform-genesis';
362
- ```
363
-
364
- ## @forgezero/agent/platform-genesis — Use this entry point
365
-
366
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
367
-
368
- ```text
369
- import {
370
- platformCommunityRehearsalClaims,
371
- } from '@forgezero/agent/platform-genesis';
372
-
373
- export const selectedCapability = platformCommunityRehearsalClaims;
374
- ```
375
-
376
- <a id="forgezero-agent-subscribe"></a>
377
- ## @forgezero/agent/subscribe
378
-
379
- Realtime scope sync over a WebSocket, with the poll kept underneath it: the poll is what establishes freshness, and a change it finds that the socket never sent is proof the socket is lying. This entry exposes 2 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
380
-
381
- ```text
382
- import {
383
- backoffMs,
384
- subscribe,
385
- } from '@forgezero/agent/subscribe';
386
-
387
- import type {
388
- ChangeFrame,
389
- SocketLike,
390
- SubscribeOptions,
391
- Subscriber,
392
- } from '@forgezero/agent/subscribe';
393
- ```
394
-
395
- ## @forgezero/agent/subscribe — Use this entry point
396
-
397
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
398
-
399
- ```text
400
- import {
401
- backoffMs,
402
- } from '@forgezero/agent/subscribe';
403
-
404
- export const selectedCapability = backoffMs;
405
- ```
406
-
407
- <a id="forgezero-agent-ssh-listen"></a>
408
- ## @forgezero/agent/ssh-listen
409
-
410
- The socket SSH_AUTH_SOCK points at. The protocol handler had nowhere to speak — an agent protocol with no socket is a parser. The containing directory is 0700 before anything binds, because the socket’s own mode is only corrected after it already exists. This entry exposes 2 named value exports and 1 named type export. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
411
-
412
- ```text
413
- import {
414
- MAX_MESSAGE_BYTES,
415
- startSshAgent,
416
- } from '@forgezero/agent/ssh-listen';
417
-
418
- import type {
419
- SshListenOptions,
420
- } from '@forgezero/agent/ssh-listen';
421
- ```
422
-
423
- ## @forgezero/agent/ssh-listen — Use this entry point
424
-
425
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
426
-
427
- ```text
428
- import {
429
- MAX_MESSAGE_BYTES,
430
- } from '@forgezero/agent/ssh-listen';
431
-
432
- export const selectedCapability = MAX_MESSAGE_BYTES;
433
- ```
434
-
435
- <a id="forgezero-agent-ssh-server"></a>
436
- ## @forgezero/agent/ssh-server
437
-
438
- Serve the SSH agent protocol so SSH_AUTH_SOCK points at the vault — two operations implemented, and ADD_IDENTITY refused so no process can inject a key ssh would offer to every host. This entry exposes 10 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
439
-
440
- ```text
441
- import {
442
- MAX_MESSAGE_BYTES,
443
- SSH_AGENT_FAILURE,
444
- SSH_AGENT_IDENTITIES_ANSWER,
445
- SSH_AGENT_SIGN_RESPONSE,
446
- SSH_AGENT_SUCCESS,
447
- SshAgentError,
448
- describeIdentities,
449
- frame,
450
- handleMessage,
451
- readMessage,
452
- } from '@forgezero/agent/ssh-server';
453
-
454
- import type {
455
- AgentBackend,
456
- AgentIdentity,
457
- } from '@forgezero/agent/ssh-server';
458
- ```
459
-
460
- ## @forgezero/agent/ssh-server — Use this entry point
461
-
462
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
463
-
464
- ```text
465
- import {
466
- MAX_MESSAGE_BYTES,
467
- } from '@forgezero/agent/ssh-server';
468
-
469
- export const selectedCapability = MAX_MESSAGE_BYTES;
470
- ```
471
-
472
- <a id="forgezero-agent-pipeline"></a>
473
- ## @forgezero/agent/pipeline
474
-
475
- CI/CD on the compute: secrets reach the step that named them and nothing else, attestation gates the run, and a required attestation that fails is a refusal rather than a downgrade. This entry exposes 3 named value exports and 6 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
476
-
477
- ```text
478
- import {
479
- PipelineError,
480
- redact,
481
- runPipeline,
482
- } from '@forgezero/agent/pipeline';
483
-
484
- import type {
485
- Pipeline,
486
- PipelineStep,
487
- RunOptions,
488
- RunResult,
489
- StepOutcome,
490
- StepResult,
491
- } from '@forgezero/agent/pipeline';
492
- ```
493
-
494
- ## @forgezero/agent/pipeline — Use this entry point
495
-
496
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
497
-
498
- ```text
499
- import {
500
- PipelineError,
501
- } from '@forgezero/agent/pipeline';
502
-
503
- export const selectedCapability = PipelineError;
504
- ```
505
-
506
- <a id="forgezero-agent-agent-heartbeat"></a>
507
- ## @forgezero/agent/agent-heartbeat
508
-
509
- Signed node health publication with bounded renewal and shutdown withdrawal. This entry exposes 3 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
510
-
511
- ```text
512
- import {
513
- heartbeatAgentOnce,
514
- observeAgentHost,
515
- startAgentHeartbeat,
516
- } from '@forgezero/agent/agent-heartbeat';
517
-
518
- import type {
519
- AgentHeartbeatOptions,
520
- AgentHeartbeatResponse,
521
- AgentHostMetrics,
522
- AgentObservation,
523
- } from '@forgezero/agent/agent-heartbeat';
524
- ```
525
-
526
- ## @forgezero/agent/agent-heartbeat — Use this entry point
527
-
528
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
529
-
530
- ```text
531
- import {
532
- heartbeatAgentOnce,
533
- } from '@forgezero/agent/agent-heartbeat';
534
-
535
- export const selectedCapability = heartbeatAgentOnce;
536
- ```
537
-
538
- <a id="forgezero-agent-agent-update"></a>
539
- ## @forgezero/agent/agent-update
540
-
541
- Verified Agent update planning against the platform release coordinate. This entry exposes 11 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
542
-
543
- ```text
544
- import {
545
- DEFAULT_AGENT_CANDIDATE_LINK,
546
- DEFAULT_AGENT_RELEASE_ROOT,
547
- DEFAULT_AGENT_UPDATE_SOCKET,
548
- MAX_AGENT_TARBALL_BYTES,
549
- clearAgentCandidate,
550
- compareVersions,
551
- restoreAgentRelease,
552
- selectAgentCandidate,
553
- selectAgentRelease,
554
- stageAgentRelease,
555
- validateAgentRelease,
556
- } from '@forgezero/agent/agent-update';
557
-
558
- import type {
559
- AgentRelease,
560
- StagedAgentRelease,
561
- UpdateCommand,
562
- UpdateCommandResult,
563
- } from '@forgezero/agent/agent-update';
564
- ```
565
-
566
- ## @forgezero/agent/agent-update — Use this entry point
567
-
568
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
569
-
570
- ```text
571
- import {
572
- DEFAULT_AGENT_CANDIDATE_LINK,
573
- } from '@forgezero/agent/agent-update';
574
-
575
- export const selectedCapability = DEFAULT_AGENT_CANDIDATE_LINK;
576
- ```
577
-
578
- <a id="forgezero-agent-agent-update-helper"></a>
579
- ## @forgezero/agent/agent-update-helper
580
-
581
- Root-owned fixed update operations with registry origin and integrity validation. This entry exposes 10 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
582
-
583
- ```text
584
- import {
585
- AGENT_UPDATE_GROUP,
586
- AGENT_UPDATE_HELPER_UNIT_PATH,
587
- AGENT_UPDATE_JOURNAL,
588
- AGENT_UPDATE_RECEIPT,
589
- activateAgentRelease,
590
- probeAgentSocket,
591
- readAgentUpdateReceipt,
592
- recoverInterruptedAgentUpdate,
593
- requestAgentUpdate,
594
- startAgentUpdateHelper,
595
- } from '@forgezero/agent/agent-update-helper';
596
-
597
- import type {
598
- AgentUpdateOutcome,
599
- AgentUpdateReceipt,
600
- AgentUpdateRequest,
601
- AgentUpdateResponse,
602
- } from '@forgezero/agent/agent-update-helper';
603
- ```
604
-
605
- ## @forgezero/agent/agent-update-helper — Use this entry point
606
-
607
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
608
-
609
- ```text
610
- import {
611
- AGENT_UPDATE_GROUP,
612
- } from '@forgezero/agent/agent-update-helper';
613
-
614
- export const selectedCapability = AGENT_UPDATE_GROUP;
615
- ```
616
-
617
- <a id="forgezero-agent-bootstrap"></a>
618
- ## @forgezero/agent/bootstrap
619
-
620
- Typed one-time platform bootstrap and internal API-driven enrolled-compute activation contracts. This entry exposes 13 named value exports and 18 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
621
-
622
- ```text
623
- import {
624
- BOOTSTRAP_STATE_PATH,
625
- PLATFORM_BOOTSTRAP_PROFILES,
626
- applyBootstrap,
627
- bootstrapIdentityDigest,
628
- bootstrapStatus,
629
- localBootstrapHost,
630
- planBootstrap,
631
- planBootstrapAgentInstall,
632
- readBootstrapConfig,
633
- resolveInstalledBootstrapKind,
634
- validateBootstrapConfig,
635
- validateEnrolledComputeBootstrapSecrets,
636
- validatePlatformBootstrapSecrets,
637
- } from '@forgezero/agent/bootstrap';
638
-
639
- import type {
640
- BootstrapAgentInstallPhase,
641
- BootstrapConfig,
642
- BootstrapEnvironment,
643
- BootstrapHost,
644
- BootstrapPlan,
645
- BootstrapResult,
646
- BootstrapSecrets,
647
- BootstrapStatus,
648
- BootstrapStep,
649
- DatabaseAgencyParticipation,
650
- DatabaseBootstrapRole,
651
- EnrolledComputeActivationConfig,
652
- EnrolledComputeBootstrapSecrets,
653
- InstalledBootstrapKind,
654
- PlatformBootstrapConfig,
655
- PlatformBootstrapProfile,
656
- PlatformBootstrapSecrets,
657
- PlatformEnrolmentSource,
658
- } from '@forgezero/agent/bootstrap';
659
- ```
660
-
661
- ## @forgezero/agent/bootstrap — Use this entry point
662
-
663
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
664
-
665
- ```text
666
- import {
667
- BOOTSTRAP_STATE_PATH,
668
- } from '@forgezero/agent/bootstrap';
669
-
670
- export const selectedCapability = BOOTSTRAP_STATE_PATH;
671
- ```
672
-
673
- <a id="forgezero-agent-bootstrap-bundle"></a>
674
- ## @forgezero/agent/bootstrap-bundle
675
-
676
- Owner-only exact-revision Git bundle and SHA-256 manifest for credential-free release generation one. This entry exposes 8 named value exports and 5 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
677
-
678
- ```text
679
- import {
680
- BOOTSTRAP_BUNDLE_FORMAT,
681
- BOOTSTRAP_BUNDLE_KIND,
682
- MAX_BOOTSTRAP_BUNDLE_BYTES,
683
- bootstrapBundleBranch,
684
- buildBootstrapBundle,
685
- parseBootstrapBundleManifest,
686
- readBootstrapBundle,
687
- sha256File,
688
- } from '@forgezero/agent/bootstrap-bundle';
689
-
690
- import type {
691
- BootstrapBundleBuildInput,
692
- BootstrapBundleBuildResult,
693
- BootstrapBundleCommand,
694
- BootstrapBundleCommandResult,
695
- BootstrapBundleManifest,
696
- } from '@forgezero/agent/bootstrap-bundle';
697
- ```
698
-
699
- ## @forgezero/agent/bootstrap-bundle — Build release generation one without a deploy key
700
-
701
- The builder refuses tracked drift, resolves one exact commit, creates an owner-only Git bundle and writes a byte-count/SHA-256 manifest. Bootstrap consumes the artifact after activation.
702
-
703
- ```text
704
- import {
705
- buildBootstrapBundle,
706
- readBootstrapBundle,
707
- } from '@forgezero/agent/bootstrap-bundle';
708
-
709
- const built = await buildBootstrapBundle({
710
- repositoryRoot: '/work/forgezero-api', branch: 'main',
711
- outputPath: '/secure/forgezero/production/api.bundle'
712
- });
713
- await readBootstrapBundle(built.bundlePath, built.manifestPath);
714
- ```
715
-
716
- <a id="forgezero-agent-operator-bootstrap"></a>
717
- ## @forgezero/agent/operator-bootstrap
718
-
719
- Pinned-host operator transport that stages owner-only handoffs and invokes the same typed platform bootstrap through the caller-approved SSH agent. This entry exposes 24 named value exports and 17 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
720
-
721
- ```text
722
- import {
723
- applyOperatorMetalBootstrap,
724
- applyOperatorPlatformBootstrap,
725
- applyOperatorPlatformFleetBootstrap,
726
- collectOperatorGuestHostKeys,
727
- createOperatorSshHop,
728
- operatorMetalClusterBootstrapCode,
729
- operatorPackagedAgentPath,
730
- operatorPackagedFzCliPath,
731
- operatorPackagedGitSshPath,
732
- operatorPlatformFleetCoordinates,
733
- planOperatorMetalBootstrap,
734
- planOperatorPlatformBootstrap,
735
- planOperatorPlatformFleetBootstrap,
736
- readOperatorGuestHostKeyEvidence,
737
- readOperatorMetalBootstrapRequest,
738
- readOperatorPlatformBootstrapFleetRequest,
739
- readOperatorPlatformBootstrapRequest,
740
- redactOperatorSecretDiagnostic,
741
- verifyOperatorPlatformFleet,
742
- withOperatorGuestTransport,
743
- writeOperatorGuestHostKeyEvidence,
744
- writeOperatorMetalBootstrapRequest,
745
- writeOperatorPlatformBootstrapFleetRequest,
746
- writeOperatorPlatformBootstrapRequest,
747
- } from '@forgezero/agent/operator-bootstrap';
748
-
749
- import type {
750
- OperatorCommand,
751
- OperatorCommandResult,
752
- OperatorGuestHostKeyEvidence,
753
- OperatorGuestTransport,
754
- OperatorMetalBootstrapMode,
755
- OperatorMetalBootstrapPlan,
756
- OperatorMetalBootstrapRequest,
757
- OperatorPlatformBootstrapFleetOutcome,
758
- OperatorPlatformBootstrapFleetPlan,
759
- OperatorPlatformBootstrapFleetRequest,
760
- OperatorPlatformBootstrapFleetResult,
761
- OperatorPlatformBootstrapMode,
762
- OperatorPlatformBootstrapOptions,
763
- OperatorPlatformBootstrapPlan,
764
- OperatorPlatformBootstrapRequest,
765
- OperatorPlatformFleetCoordinates,
766
- OperatorSshHop,
767
- } from '@forgezero/agent/operator-bootstrap';
768
- ```
769
-
770
- ## @forgezero/agent/operator-bootstrap — Launch the platform from an operator laptop
771
-
772
- The selected ForgeZero profile and pinned Metal evidence derive every public coordinate. The CLI builds the clean API bundle, retains cluster material only as an owner-host encrypted systemd credential for safe resume, deploys all three computes, seals hidden credentials, seeds inventory and prints the invitation. Low-level file commands are reserved for resume and repair.
773
-
774
- ```text
775
- # The command prints the derived plan before its final APPLY confirmation:
776
- fz bootstrap platform launch --profile development --apply
777
- ```
778
-
779
- <a id="forgezero-agent-host-maintenance"></a>
780
- ## @forgezero/agent/host-maintenance
781
-
782
- Closed host maintenance plans for staging transaction rehearsal and fleet-fenced schema consolidation through fixed transient systemd units. This entry exposes 2 named value exports and 5 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
783
-
784
- ```text
785
- import {
786
- applyHostMaintenance,
787
- planHostMaintenance,
788
- } from '@forgezero/agent/host-maintenance';
789
-
790
- import type {
791
- HostMaintenanceOperation,
792
- HostMaintenancePlan,
793
- HostMaintenanceRequest,
794
- HostMaintenanceResult,
795
- HostMaintenanceRuntime,
796
- } from '@forgezero/agent/host-maintenance';
797
- ```
798
-
799
- ## @forgezero/agent/host-maintenance — Plan a fixed supervised host operation
800
-
801
- The library discovers only a trusted blue/green slot, attaches fixed credential names and returns exact argv as reviewable data. The public fz host commands use the same operation and require root only for apply.
802
-
803
- ```text
804
- import {
805
- planHostMaintenance,
806
- } from '@forgezero/agent/host-maintenance';
807
-
808
- const plan = planHostMaintenance({ operation: 'schema-plan' });
809
- console.log(plan.argv);
810
- ```
811
-
812
- <a id="forgezero-agent-capacity-calibration"></a>
813
- ## @forgezero/agent/capacity-calibration
814
-
815
- One-time target-local safe-concurrency calibration with private evidence. This entry exposes 3 named value exports and 5 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
816
-
817
- ```text
818
- import {
819
- calibrateHttpConcurrency,
820
- localCalibrationEndpoint,
821
- validateCapacityCalibrationOptions,
822
- } from '@forgezero/agent/capacity-calibration';
823
-
824
- import type {
825
- CapacityCalibration,
826
- CapacityCalibrationOptions,
827
- CapacityStage,
828
- HostCapacitySample,
829
- ValidatedCapacityCalibrationOptions,
830
- } from '@forgezero/agent/capacity-calibration';
831
- ```
832
-
833
- ## @forgezero/agent/capacity-calibration — Use this entry point
834
-
835
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
836
-
837
- ```text
838
- import {
839
- calibrateHttpConcurrency,
840
- } from '@forgezero/agent/capacity-calibration';
841
-
842
- export const selectedCapability = calibrateHttpConcurrency;
843
- ```
844
-
845
- <a id="forgezero-agent-cloudflare-bootstrap"></a>
846
- ## @forgezero/agent/cloudflare-bootstrap
847
-
848
- Attended two-token Cloudflare Tunnel/DNS reconciliation and per-node connector/KV runtime handoff for existing KV resources. This entry exposes 14 named value exports and 17 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
849
-
850
- ```text
851
- import {
852
- applyCloudflareBootstrap,
853
- cloudflareHostHandoffPath,
854
- deriveCloudflareRealtimeSecrets,
855
- finalizeCloudflareBootstrapAcceptance,
856
- planCloudflareBootstrap,
857
- readCloudflareBootstrapAcceptanceEvidence,
858
- readCloudflareConnectorHandoff,
859
- readCloudflareHostHandoff,
860
- runAttendedCloudflareBootstrap,
861
- validateCloudflareBootstrapCoordinates,
862
- validateCloudflareBootstrapTokens,
863
- validateCloudflareBootstrapTopology,
864
- verifyCloudflareBootstrapAcceptance,
865
- writeOwnerBootstrapOutput,
866
- } from '@forgezero/agent/cloudflare-bootstrap';
867
-
868
- import type {
869
- AttendedCloudflareBootstrapRequest,
870
- CloudflareBootstrapAcceptanceEvidence,
871
- CloudflareBootstrapAcceptedNode,
872
- CloudflareBootstrapCoordinates,
873
- CloudflareBootstrapDependencies,
874
- CloudflareBootstrapEvidence,
875
- CloudflareBootstrapFinalizeRequest,
876
- CloudflareBootstrapNodeCoordinates,
877
- CloudflareBootstrapOutput,
878
- CloudflareBootstrapPhaseRunner,
879
- CloudflareBootstrapPlan,
880
- CloudflareBootstrapTokens,
881
- CloudflareBootstrapTopology,
882
- CloudflareConnectorHandoff,
883
- CloudflareHostHandoff,
884
- CloudflareMeshCoordinates,
885
- CloudflareRealtimeCoordinates,
886
- } from '@forgezero/agent/cloudflare-bootstrap';
887
- ```
888
-
889
- ## @forgezero/agent/cloudflare-bootstrap — Use this entry point
890
-
891
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
892
-
893
- ```text
894
- import {
895
- applyCloudflareBootstrap,
896
- } from '@forgezero/agent/cloudflare-bootstrap';
897
-
898
- export const selectedCapability = applyCloudflareBootstrap;
899
- ```
900
-
901
- <a id="forgezero-agent-cloudflare-edge"></a>
902
- ## @forgezero/agent/cloudflare-edge
903
-
904
- Strict Cloudflare REST operations used by the attended bootstrap controller. This entry exposes 14 named value exports and 8 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
905
-
906
- ```text
907
- import {
908
- configureCloudflareEdge,
909
- configureCloudflareRealtimeSecrets,
910
- discoverCloudflareBootstrapResources,
911
- ensureCloudflareMeshConnector,
912
- ensureCloudflarePrivateDatabaseRoute,
913
- ensureCloudflarePrivateRoute,
914
- ensureCloudflareTunnel,
915
- ensureCloudflareWarpDatabaseInclude,
916
- ensureCloudflareWarpNetworkIncludes,
917
- removeCloudflarePrivateDatabaseRoute,
918
- removeCloudflarePrivateRoute,
919
- removeCloudflareWarpDatabaseInclude,
920
- retrieveCloudflareConnectorTokens,
921
- verifyCloudflareWorkerDurableObjects,
922
- } from '@forgezero/agent/cloudflare-edge';
923
-
924
- import type {
925
- CloudflareBootstrapDiscovery,
926
- CloudflareDurableObjectNamespace,
927
- CloudflareEdgeConfig,
928
- CloudflareMeshConnector,
929
- CloudflarePrivateRoute,
930
- CloudflarePrivateRouteConfig,
931
- CloudflareTunnel,
932
- CloudflareWarpIncludeConfig,
933
- } from '@forgezero/agent/cloudflare-edge';
934
- ```
935
-
936
- ## @forgezero/agent/cloudflare-edge — Use this entry point
937
-
938
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
939
-
940
- ```text
941
- import {
942
- configureCloudflareEdge,
943
- } from '@forgezero/agent/cloudflare-edge';
944
-
945
- export const selectedCapability = configureCloudflareEdge;
946
- ```
947
-
948
- <a id="forgezero-agent-mesh-connector"></a>
949
- ## @forgezero/agent/mesh-connector
950
-
951
- Fixed Cloudflare Mesh/WARP connector enrollment using only the unit-loaded connector credential. This entry exposes 2 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
952
-
953
- ```text
954
- import {
955
- configureMeshConnector,
956
- readMeshConnectorCredential,
957
- } from '@forgezero/agent/mesh-connector';
958
-
959
- import type {
960
- MeshConnectorCommandResult,
961
- MeshConnectorExec,
962
- } from '@forgezero/agent/mesh-connector';
963
- ```
964
-
965
- ## @forgezero/agent/mesh-connector — Use this entry point
966
-
967
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
968
-
969
- ```text
970
- import {
971
- configureMeshConnector,
972
- } from '@forgezero/agent/mesh-connector';
973
-
974
- export const selectedCapability = configureMeshConnector;
975
- ```
976
-
977
- <a id="forgezero-agent-compute"></a>
978
- ## @forgezero/agent/compute
979
-
980
- Compute claim, renewal, execution and completion client contracts. This entry exposes 9 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
981
-
982
- ```text
983
- import {
984
- ComputeError,
985
- deviceInUse,
986
- guestUnit,
987
- parseCensus,
988
- qemuArgv,
989
- shapeEgressCommands,
990
- shapeEgressUnitDirectives,
991
- tapFor,
992
- unitName,
993
- } from '@forgezero/agent/compute';
994
-
995
- import type {
996
- GuestSpec,
997
- RunningGuest,
998
- } from '@forgezero/agent/compute';
999
- ```
1000
-
1001
- ## @forgezero/agent/compute — Use this entry point
1002
-
1003
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1004
-
1005
- ```text
1006
- import {
1007
- ComputeError,
1008
- } from '@forgezero/agent/compute';
1009
-
1010
- export const selectedCapability = ComputeError;
1011
- ```
1012
-
1013
- <a id="forgezero-agent-credential-schema"></a>
1014
- ## @forgezero/agent/credential-schema
1015
-
1016
- Canonical systemd credential names and validation shared by bootstrap and services. This entry exposes 7 named value exports and 3 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1017
-
1018
- ```text
1019
- import {
1020
- AGENT_CREDENTIAL_LOCATIONS,
1021
- AGENT_CREDENTIAL_POLICY,
1022
- CLOUDFLARE_CREDENTIAL_NAMES,
1023
- CLOUDFLARE_CREDENTIAL_SCHEMA,
1024
- METAL_SYSTEMD_CREDENTIALS,
1025
- credentialBinding,
1026
- deploymentCredentialSchema,
1027
- } from '@forgezero/agent/credential-schema';
1028
-
1029
- import type {
1030
- AgentCredentialLocation,
1031
- DeploymentCredentialBinding,
1032
- DeploymentCredentialSchema,
1033
- } from '@forgezero/agent/credential-schema';
1034
- ```
1035
-
1036
- ## @forgezero/agent/credential-schema — Use this entry point
1037
-
1038
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1039
-
1040
- ```text
1041
- import {
1042
- AGENT_CREDENTIAL_LOCATIONS,
1043
- } from '@forgezero/agent/credential-schema';
1044
-
1045
- export const selectedCapability = AGENT_CREDENTIAL_LOCATIONS;
1046
- ```
1047
-
1048
- <a id="forgezero-agent-definition"></a>
1049
- ## @forgezero/agent/definition
1050
-
1051
- Legacy version 3 JSON deployment compatibility contract. This entry exposes 6 named value exports and 5 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1052
-
1053
- ```text
1054
- import {
1055
- DEPLOY_SCHEMA_URL,
1056
- DefinitionError,
1057
- PIPELINE_VERSION,
1058
- parseDeployDefinition,
1059
- phasePipeline,
1060
- validateDeploymentService,
1061
- } from '@forgezero/agent/definition';
1062
-
1063
- import type {
1064
- DeployDefinition,
1065
- DeployStep,
1066
- DeploymentPortAllocation,
1067
- DeploymentService,
1068
- PipelineProfile,
1069
- } from '@forgezero/agent/definition';
1070
- ```
1071
-
1072
- ## @forgezero/agent/definition — Use this entry point
1073
-
1074
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1075
-
1076
- ```text
1077
- import {
1078
- DEPLOY_SCHEMA_URL,
1079
- } from '@forgezero/agent/definition';
1080
-
1081
- export const selectedCapability = DEPLOY_SCHEMA_URL;
1082
53
  ```
1083
54
 
1084
55
  <a id="forgezero-agent-deploy"></a>
1085
56
  ## @forgezero/agent/deploy
1086
57
 
1087
- Typed deployment authoring builders, built-in provider requirements and versioned action constructors. This entry exposes 14 named value exports and 42 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
58
+ Typed deployment authoring builders, built-in provider requirements and versioned action constructors. This is a supported entry point. Import only the named values used by the adjacent task example; the declaration file remains the complete API reference.
1088
59
 
1089
60
  ```text
1090
61
  import {
1091
62
  actions,
1092
- application,
1093
- conditions,
1094
- credential,
1095
- database,
1096
- defineDeployment,
1097
- input,
1098
- providers,
1099
- ref,
1100
- requirement,
1101
- stage,
1102
- step,
1103
- target,
1104
- workflow,
1105
- } from '@forgezero/agent/deploy';
1106
-
1107
- import type {
1108
- ApplicationComponent,
1109
- ApplicationRuntime,
1110
- ArangoDbProviderConfig,
1111
- BunProviderConfig,
1112
- CloudflaredProviderConfig,
1113
- ComponentDefinition,
1114
- ComputeConnectivityDefinition,
1115
- ComputePoolDefinition,
1116
- ComputeTopologyDefinition,
1117
- Condition,
1118
- ConditionOperand,
1119
- ContainerdProviderConfig,
1120
- CredentialDefinition,
1121
- DatabaseComponent,
1122
- DeploymentSource,
1123
- DockerProviderConfig,
1124
- HealthDefinition,
1125
- InputDefinition,
1126
- IntegerValue,
1127
- JsonObject,
1128
- JsonPrimitive,
1129
- JsonValue,
1130
- KataProviderConfig,
1131
- NetworkDefinition,
1132
- NginxProviderConfig,
1133
- OpenSshProviderConfig,
1134
- RequirementDefinition,
1135
- ResolvableJsonObject,
1136
- ResolvableJsonValue,
1137
- ResourceDefinition,
1138
- RetryDefinition,
1139
- StageDefinition,
1140
- StepScope,
1141
- StorageMount,
1142
- StringValue,
1143
- SystemdProviderConfig,
1144
- TargetDefinition,
1145
- UfwProviderConfig,
1146
- ValueReference,
1147
- WarpProviderConfig,
1148
- WorkflowDefinition,
1149
- WorkflowStepDefinition,
1150
63
  } from '@forgezero/agent/deploy';
1151
64
  ```
1152
65
 
@@ -1243,455 +156,6 @@ export default defineDeployment({
1243
156
  });
1244
157
  ```
1245
158
 
1246
- <a id="forgezero-agent-deployment-targets"></a>
1247
- ## @forgezero/agent/deployment-targets
1248
-
1249
- Bounded input resolution and stable compute-target assignment for typed plans; emits requirements and slots rather than physical hostnames. This entry exposes 3 named value exports and 0 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1250
-
1251
- ```text
1252
- import {
1253
- DeploymentInputError,
1254
- resolveDeploymentInputs,
1255
- resolveDeploymentTargets,
1256
- } from '@forgezero/agent/deployment-targets';
1257
- ```
1258
-
1259
- ## @forgezero/agent/deployment-targets — Use this entry point
1260
-
1261
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1262
-
1263
- ```text
1264
- import {
1265
- DeploymentInputError,
1266
- } from '@forgezero/agent/deployment-targets';
1267
-
1268
- export const selectedCapability = DeploymentInputError;
1269
- ```
1270
-
1271
- <a id="forgezero-agent-deployment-connectivity"></a>
1272
- ## @forgezero/agent/deployment-connectivity
1273
-
1274
- Root-owned convergence of exact private routes, routed-port firewall rules and per-target Cloudflare Tunnel or Mesh connector capabilities without exposing the project management token to a compute. This entry exposes 1 named value export and 6 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1275
-
1276
- ```text
1277
- import {
1278
- applyDeploymentConnectivity,
1279
- } from '@forgezero/agent/deployment-connectivity';
1280
-
1281
- import type {
1282
- DeploymentConnectivityCapabilities,
1283
- DeploymentConnectivityEvidence,
1284
- DeploymentConnectivityHost,
1285
- DeploymentConnectivityIntent,
1286
- DeploymentConnectivityRequest,
1287
- DeploymentConnectivityTopology,
1288
- } from '@forgezero/agent/deployment-connectivity';
1289
- ```
1290
-
1291
- ## @forgezero/agent/deployment-connectivity — Use this entry point
1292
-
1293
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1294
-
1295
- ```text
1296
- import {
1297
- applyDeploymentConnectivity,
1298
- } from '@forgezero/agent/deployment-connectivity';
1299
-
1300
- export const selectedCapability = applyDeploymentConnectivity;
1301
- ```
1302
-
1303
- <a id="forgezero-agent-deployment-topology"></a>
1304
- ## @forgezero/agent/deployment-topology
1305
-
1306
- Pure per-Metal relay election and hierarchical peer assignment: one or two Metals stay direct-private, while three or more grant Mesh/WARP only to relay and standby. This entry exposes 2 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1307
-
1308
- ```text
1309
- import {
1310
- DeploymentTopologyError,
1311
- planDeploymentTopology,
1312
- } from '@forgezero/agent/deployment-topology';
1313
-
1314
- import type {
1315
- DeploymentTopologyAssignment,
1316
- DeploymentTopologyPlacement,
1317
- DeploymentTopologyRole,
1318
- DeploymentTopologyTransport,
1319
- } from '@forgezero/agent/deployment-topology';
1320
- ```
1321
-
1322
- ## @forgezero/agent/deployment-topology — Use this entry point
1323
-
1324
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1325
-
1326
- ```text
1327
- import {
1328
- DeploymentTopologyError,
1329
- } from '@forgezero/agent/deployment-topology';
1330
-
1331
- export const selectedCapability = DeploymentTopologyError;
1332
- ```
1333
-
1334
- <a id="forgezero-agent-deploy-plan"></a>
1335
- ## @forgezero/agent/deploy-plan
1336
-
1337
- Runtime validation, canonicalization and semantic digest for inert deployment plans. This entry exposes 8 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1338
-
1339
- ```text
1340
- import {
1341
- DEPLOY_PLAN_FORMAT,
1342
- DEPLOY_PLAN_VERSION,
1343
- DeploymentPlanError,
1344
- canonicalJson,
1345
- compileDeployment,
1346
- deploymentPlanDigest,
1347
- deploymentSourceDigest,
1348
- parseDeploymentPlan,
1349
- } from '@forgezero/agent/deploy-plan';
1350
-
1351
- import type {
1352
- DeploymentPlan,
1353
- PlannedStage,
1354
- PlannedStep,
1355
- PlannedWorkflow,
1356
- } from '@forgezero/agent/deploy-plan';
1357
- ```
1358
-
1359
- ## @forgezero/agent/deploy-plan — Use this entry point
1360
-
1361
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1362
-
1363
- ```text
1364
- import {
1365
- DEPLOY_PLAN_FORMAT,
1366
- } from '@forgezero/agent/deploy-plan';
1367
-
1368
- export const selectedCapability = DEPLOY_PLAN_FORMAT;
1369
- ```
1370
-
1371
- <a id="forgezero-agent-deploy-plan-runner"></a>
1372
- ## @forgezero/agent/deploy-plan-runner
1373
-
1374
- Conditional DAG execution with bounded retry, compensation and failure policy over injected action handlers. This entry exposes 3 named value exports and 8 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1375
-
1376
- ```text
1377
- import {
1378
- DeploymentActionError,
1379
- evaluateCondition,
1380
- runDeploymentPlan,
1381
- } from '@forgezero/agent/deploy-plan-runner';
1382
-
1383
- import type {
1384
- ActionContext,
1385
- ActionExecutionResult,
1386
- ActionFailureKind,
1387
- ActionHandler,
1388
- PlanRunResult,
1389
- PlanStepStatus,
1390
- RunDeploymentPlanOptions,
1391
- StepExecutionRecord,
1392
- } from '@forgezero/agent/deploy-plan-runner';
1393
- ```
1394
-
1395
- ## @forgezero/agent/deploy-plan-runner — Extend the plan with a namespaced action
1396
-
1397
- Public projects can define a versioned action coordinate and install an exact handler. Built-in forgezero.* coordinates stay closed; unknown built-ins fail validation.
1398
-
1399
- ```text
1400
- import {
1401
- actions,
1402
- } from '@forgezero/agent/deploy';
1403
- import {
1404
- runDeploymentPlan,
1405
- } from '@forgezero/agent/deploy-plan-runner';
1406
-
1407
- const notify = actions.extension('example.notifications/publish@1', { channel: 'deployments' }, {
1408
- scope: { kind: 'release-executor' },
1409
- retry: { attempts: 3, backoff: { kind: 'exponential', initialMs: 250, maximumMs: 5000 }, retryOn: ['network'] }
1410
- });
1411
-
1412
- await runDeploymentPlan({
1413
- plan, workflow: 'deploy', inputs: {},
1414
- actions: { 'example.notifications/publish@1': async ({ resolved }) => ({ changed: true, evidence: resolved }) }
1415
- });
1416
- ```
1417
-
1418
- <a id="forgezero-agent-deploy-compiler"></a>
1419
- ## @forgezero/agent/deploy-compiler
1420
-
1421
- Explicit developer/CI compiler from forgezero.deploy.ts to canonical .fz/deploy.plan.json; never used to execute project TypeScript in production. This entry exposes 7 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1422
-
1423
- ```text
1424
- import {
1425
- DEPLOY_PLAN_FILE,
1426
- DEPLOY_SOURCE_FILE,
1427
- compileDeploymentProject,
1428
- defaultTypeScriptDeployment,
1429
- initializeTypeScriptDeployment,
1430
- inspectCompiledDeployment,
1431
- loadDeploymentSource,
1432
- } from '@forgezero/agent/deploy-compiler';
1433
-
1434
- import type {
1435
- DeploymentCompilation,
1436
- DeploymentInitOptions,
1437
- DeploymentInitProvisioning,
1438
- DeploymentInitRuntime,
1439
- } from '@forgezero/agent/deploy-compiler';
1440
- ```
1441
-
1442
- ## @forgezero/agent/deploy-compiler — Use this entry point
1443
-
1444
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1445
-
1446
- ```text
1447
- import {
1448
- DEPLOY_PLAN_FILE,
1449
- } from '@forgezero/agent/deploy-compiler';
1450
-
1451
- export const selectedCapability = DEPLOY_PLAN_FILE;
1452
- ```
1453
-
1454
- <a id="forgezero-agent-deploy-file"></a>
1455
- ## @forgezero/agent/deploy-file
1456
-
1457
- Read and validate a checked-out .fz deployment file without executing project input. This entry exposes 7 named value exports and 2 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1458
-
1459
- ```text
1460
- import {
1461
- DEPLOY_FILE,
1462
- DEPLOY_SCHEMA_URL,
1463
- DEPLOY_TODO_PREFIX,
1464
- defaultDeployFile,
1465
- deployDefinitionDigest,
1466
- initializeDeployFile,
1467
- inspectDeployFile,
1468
- } from '@forgezero/agent/deploy-file';
1469
-
1470
- import type {
1471
- DeployFileSummary,
1472
- InitializedDeployFile,
1473
- } from '@forgezero/agent/deploy-file';
1474
- ```
1475
-
1476
- ## @forgezero/agent/deploy-file — Use this entry point
1477
-
1478
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1479
-
1480
- ```text
1481
- import {
1482
- DEPLOY_FILE,
1483
- } from '@forgezero/agent/deploy-file';
1484
-
1485
- export const selectedCapability = DEPLOY_FILE;
1486
- ```
1487
-
1488
- <a id="forgezero-agent-metal-bootstrap"></a>
1489
- ## @forgezero/agent/metal-bootstrap
1490
-
1491
- Physical-metal bootstrap planning, application and status evidence. This entry exposes 10 named value exports and 7 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1492
-
1493
- ```text
1494
- import {
1495
- METAL_BOOTSTRAP_STATE_PATH,
1496
- MetalBootstrapError,
1497
- applyMetalBootstrap,
1498
- metalBootstrapStatus,
1499
- normalizeMetalPublicIdentity,
1500
- planMetalBootstrap,
1501
- readMetalBootstrapConfig,
1502
- renderMetalUnits,
1503
- validateMetalBootstrapConfig,
1504
- validateOwnerOnlyPath,
1505
- } from '@forgezero/agent/metal-bootstrap';
1506
-
1507
- import type {
1508
- MetalBootstrapApplyOptions,
1509
- MetalBootstrapConfig,
1510
- MetalBootstrapExec,
1511
- MetalBootstrapPlan,
1512
- MetalBootstrapResult,
1513
- MetalBootstrapStatus,
1514
- MetalBootstrapValidationOptions,
1515
- } from '@forgezero/agent/metal-bootstrap';
1516
- ```
1517
-
1518
- ## @forgezero/agent/metal-bootstrap — Use this entry point
1519
-
1520
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1521
-
1522
- ```text
1523
- import {
1524
- METAL_BOOTSTRAP_STATE_PATH,
1525
- } from '@forgezero/agent/metal-bootstrap';
1526
-
1527
- export const selectedCapability = METAL_BOOTSTRAP_STATE_PATH;
1528
- ```
1529
-
1530
- <a id="forgezero-agent-metal-provision"></a>
1531
- ## @forgezero/agent/metal-provision
1532
-
1533
- The single constrained compute materializer for platform genesis, platform scaling and tenant compute. It executes caller-supplied OS, CPU, memory, disk, bandwidth, network and confidentiality coordinates after capacity and image validation; it owns no environment or product-tier shape. This entry exposes 11 named value exports and 7 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1534
-
1535
- ```text
1536
- import {
1537
- MetalProvisionError,
1538
- allocateAddress,
1539
- allocateCpuPool,
1540
- cloudInit,
1541
- guestBootstrapOperations,
1542
- guestNameFor,
1543
- macForAddress,
1544
- provisionMetalGuest,
1545
- removeMetalGuest,
1546
- tapNameFor,
1547
- validateMetalProfile,
1548
- } from '@forgezero/agent/metal-provision';
1549
-
1550
- import type {
1551
- GuestManifest,
1552
- MetalCommandResult,
1553
- MetalCpuAllocation,
1554
- MetalCpuPool,
1555
- MetalExec,
1556
- MetalImage,
1557
- MetalProvisionProfile,
1558
- } from '@forgezero/agent/metal-provision';
1559
- ```
1560
-
1561
- ## @forgezero/agent/metal-provision — Use this entry point
1562
-
1563
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1564
-
1565
- ```text
1566
- import {
1567
- MetalProvisionError,
1568
- } from '@forgezero/agent/metal-provision';
1569
-
1570
- export const selectedCapability = MetalProvisionError;
1571
- ```
1572
-
1573
- <a id="forgezero-agent-platform-bootstrap-runtime"></a>
1574
- ## @forgezero/agent/platform-bootstrap-runtime
1575
-
1576
- Pure platform bootstrap validation, render and resumable phase-state contracts. This entry exposes 11 named value exports and 14 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1577
-
1578
- ```text
1579
- import {
1580
- activatePlatformRelease,
1581
- assertReleaseLinksContained,
1582
- planLocalOtlpProof,
1583
- planPlatformActivation,
1584
- platformApiCredentialSpecs,
1585
- renderPlatformActivationFiles,
1586
- renderPlatformApiUnits,
1587
- renderPlatformNginx,
1588
- renderPlatformSharedEnvironment,
1589
- validatePlatformInitialInventory,
1590
- validatePlatformSharedEnvironment,
1591
- } from '@forgezero/agent/platform-bootstrap-runtime';
1592
-
1593
- import type {
1594
- ActivationBoundary,
1595
- ApiRuntimeRenderOptions,
1596
- ApiSlot,
1597
- LocalOtlpProofPlan,
1598
- PlatformActivationCommandResult,
1599
- PlatformActivationConfig,
1600
- PlatformActivationExec,
1601
- PlatformBootstrapEmail,
1602
- PlatformDatabaseRole,
1603
- PlatformInitialInventory,
1604
- PlatformInitialInventoryCompute,
1605
- PlatformSharedEnvironment,
1606
- PlatformSoftwareProfile,
1607
- SystemdCredentialSpec,
1608
- } from '@forgezero/agent/platform-bootstrap-runtime';
1609
- ```
1610
-
1611
- ## @forgezero/agent/platform-bootstrap-runtime — Use this entry point
1612
-
1613
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1614
-
1615
- ```text
1616
- import {
1617
- activatePlatformRelease,
1618
- } from '@forgezero/agent/platform-bootstrap-runtime';
1619
-
1620
- export const selectedCapability = activatePlatformRelease;
1621
- ```
1622
-
1623
- <a id="forgezero-agent-project-context"></a>
1624
- ## @forgezero/agent/project-context
1625
-
1626
- Project identity and repository context validation for operator and managed runs. This entry exposes 9 named value exports and 4 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1627
-
1628
- ```text
1629
- import {
1630
- PROJECT_CONTEXT_VERSION,
1631
- ProjectContextError,
1632
- checkProjectContext,
1633
- defaultProjectContext,
1634
- initializeProjectContext,
1635
- parseProjectContext,
1636
- projectContextFiles,
1637
- renderProjectContext,
1638
- syncProjectContext,
1639
- } from '@forgezero/agent/project-context';
1640
-
1641
- import type {
1642
- ContextCheck,
1643
- ContextFile,
1644
- ProjectContextManifest,
1645
- ProjectTruthSource,
1646
- } from '@forgezero/agent/project-context';
1647
- ```
1648
-
1649
- ## @forgezero/agent/project-context — Use this entry point
1650
-
1651
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1652
-
1653
- ```text
1654
- import {
1655
- PROJECT_CONTEXT_VERSION,
1656
- } from '@forgezero/agent/project-context';
1657
-
1658
- export const selectedCapability = PROJECT_CONTEXT_VERSION;
1659
- ```
1660
-
1661
- <a id="forgezero-agent-provisioning-pull"></a>
1662
- ## @forgezero/agent/provisioning-pull
1663
-
1664
- Signed provisioning work claim, renewal, execution and acknowledgement. This entry exposes 2 named value exports and 7 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1665
-
1666
- ```text
1667
- import {
1668
- pullProvisioningOnce,
1669
- startProvisioningPull,
1670
- } from '@forgezero/agent/provisioning-pull';
1671
-
1672
- import type {
1673
- CreateRemoteProvisionClaim,
1674
- GuestAccess,
1675
- ProvisionPullResult,
1676
- ProvisionResult,
1677
- ProvisionRunner,
1678
- ProvisioningPullOptions,
1679
- RemoteProvisionClaim,
1680
- } from '@forgezero/agent/provisioning-pull';
1681
- ```
1682
-
1683
- ## @forgezero/agent/provisioning-pull — Use this entry point
1684
-
1685
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1686
-
1687
- ```text
1688
- import {
1689
- pullProvisioningOnce,
1690
- } from '@forgezero/agent/provisioning-pull';
1691
-
1692
- export const selectedCapability = pullProvisioningOnce;
1693
- ```
1694
-
1695
159
  <a id="forgezero-agent-schema-deploy-v3-json"></a>
1696
160
  ## @forgezero/agent/schema/deploy-v3.json
1697
161
 
@@ -1713,131 +177,6 @@ const validate = new Ajv({ allErrors: true, strict: true }).compile(deploySchema
1713
177
  if (!validate(deploymentDefinition)) throw new Error(JSON.stringify(validate.errors));
1714
178
  ```
1715
179
 
1716
- <a id="forgezero-agent-software"></a>
1717
- ## @forgezero/agent/software
1718
-
1719
- Exact managed-software inventory, requirement and evidence contracts. This entry exposes 14 named value exports and 10 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1720
-
1721
- ```text
1722
- import {
1723
- BUILDKIT_VERSION,
1724
- BUN_RELEASE_SHA256,
1725
- KATA_CONTAINERS_VERSION,
1726
- NERDCTL_VERSION,
1727
- OS_CATALOG,
1728
- PINNED_BUN_VERSION,
1729
- SOFTWARE_CATALOG,
1730
- ensureSoftwareRequirements,
1731
- executeSoftwareOperation,
1732
- observeSoftwareHost,
1733
- runSoftwareCommand,
1734
- softwareDownloadCommand,
1735
- softwareSpawnFailure,
1736
- validateSoftwareRequirements,
1737
- } from '@forgezero/agent/software';
1738
-
1739
- import type {
1740
- CatalogStatus,
1741
- DeploymentChannel,
1742
- OsCatalogEntry,
1743
- SoftwareCatalogEntry,
1744
- SoftwareCommandResult,
1745
- SoftwareExec,
1746
- SoftwareId,
1747
- SoftwareObservation,
1748
- SoftwareOperation,
1749
- SoftwareRequirement,
1750
- } from '@forgezero/agent/software';
1751
- ```
1752
-
1753
- ## @forgezero/agent/software — Use this entry point
1754
-
1755
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1756
-
1757
- ```text
1758
- import {
1759
- BUILDKIT_VERSION,
1760
- } from '@forgezero/agent/software';
1761
-
1762
- export const selectedCapability = BUILDKIT_VERSION;
1763
- ```
1764
-
1765
- <a id="forgezero-agent-software-helper"></a>
1766
- ## @forgezero/agent/software-helper
1767
-
1768
- Root-owned fixed installation/update boundary for declared software. This entry exposes 9 named value exports and 0 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1769
-
1770
- ```text
1771
- import {
1772
- DEFAULT_SOFTWARE_HELPER_SOCKET,
1773
- SOFTWARE_HELPER_GROUP,
1774
- SOFTWARE_HELPER_UNIT_PATH,
1775
- requestContainerActivation,
1776
- requestContainerBuild,
1777
- requestDeploymentConnectivity,
1778
- requestServiceActivation,
1779
- requestSoftware,
1780
- startSoftwareHelper,
1781
- } from '@forgezero/agent/software-helper';
1782
- ```
1783
-
1784
- ## @forgezero/agent/software-helper — Use this entry point
1785
-
1786
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1787
-
1788
- ```text
1789
- import {
1790
- DEFAULT_SOFTWARE_HELPER_SOCKET,
1791
- } from '@forgezero/agent/software-helper';
1792
-
1793
- export const selectedCapability = DEFAULT_SOFTWARE_HELPER_SOCKET;
1794
- ```
1795
-
1796
- <a id="forgezero-agent-ubuntu"></a>
1797
- ## @forgezero/agent/ubuntu
1798
-
1799
- The closed guest-image view: pinned Ubuntu 26.04 LTS x64 supports ordinary or SEV-SNP compute, while pinned Ubuntu 24.04 LTS x64 is limited to ordinary non-confidential compute. Every other OS remains rejected until its own pinned strategy and acceptance evidence are added. This entry exposes 4 named value exports and 0 named type exports. The generated import block lists one name per line for scanning and copying; keep only the names used by your file.
1800
-
1801
- ```text
1802
- import {
1803
- SUPPORTED_GUEST_IMAGE,
1804
- SUPPORTED_GUEST_IMAGES,
1805
- assertSupportedGuestImage,
1806
- supportedGuestImage,
1807
- } from '@forgezero/agent/ubuntu';
1808
- ```
1809
-
1810
- ## @forgezero/agent/ubuntu — Use this entry point
1811
-
1812
- This minimal executable use imports one concrete value from this exact entry point without a wildcard or package-root detour. Keep the value or values the application actually needs; the full named inventory remains directly above it.
1813
-
1814
- ```text
1815
- import {
1816
- SUPPORTED_GUEST_IMAGE,
1817
- } from '@forgezero/agent/ubuntu';
1818
-
1819
- export const selectedCapability = SUPPORTED_GUEST_IMAGE;
1820
- ```
1821
-
1822
- <a id="fz-agent-replica"></a>
1823
- ## fz-agent (replica)
1824
-
1825
- The authorized project-scoped vault replica: resident in RAM, never on disk, invalidated by cursor rather than by timer, cleared when local authority is revoked, and refusing a read it can no longer vouch for. This is a managed runtime interface label, not an import or standalone executable.
1826
-
1827
- ```text
1828
- fz-agent (replica)
1829
- # Accessed through the installed Agent boundary.
1830
- ```
1831
-
1832
- ## fz-agent (replica) — Operational interface
1833
-
1834
- This inventory entry names an Agent-owned runtime interface, not an importable namespace or a command to paste. Applications reach it through the installed Agent and the documented Vault client.
1835
-
1836
- ```text
1837
- fz-agent (replica)
1838
- # Managed by the installed fz-agent service; no direct executable entry.
1839
- ```
1840
-
1841
180
  ## Install both machine commands
1842
181
 
1843
182
  One public package installs `fz` and `fz-agent` at the same version. `fz` breaks the bootstrap circle from an operator machine; `fz-agent` runs managed work. Keeping them together prevents a new bootstrap command from provisioning an old daemon protocol.