@shoalrun/cli 1.0.0 → 1.1.0

package/agent-docs/content-delivery/sdk/content-link.md

@@ -0,0 +1,127 @@
+---
+id: reference.content-sdk.ContentLink
+title: ContentLink
+summary: Classified link and optional resource identity for application routing.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link
+---
+
+# ContentLink
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Type** `shoalrun.content.ContentLink`
+
+```typescript
+type ContentLink = {
+    key: string;
+    kind: 'resource' | 'canonical' | 'external' | 'asset';
+    href: string;
+    ref?: ContentRef;
+    fragment?: string;
+    query?: string;
+    asset?: string;
+};
+```
+
+Classified link and optional resource identity for application routing.
+
+## Fields
+
+| Name                                                                                                              | Type                                                                                        | Required / default | Description |
+| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| [`asset`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-asset)       | `string \| undefined`                                                                       | Optional           | —           |
+| [`fragment`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-fragment) | `string \| undefined`                                                                       | Optional           | —           |
+| [`href`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-href)         | `string`                                                                                    | Required           | —           |
+| [`key`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-key)           | `string`                                                                                    | Required           | —           |
+| [`kind`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-kind)         | `"resource" \| "canonical" \| "external" \| "asset"`                                        | Required           | —           |
+| [`query`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-query)       | `string \| undefined`                                                                       | Optional           | —           |
+| [`ref`](https://www.shoalrun.com/content-delivery/sdk/content-link.md#shoalrun-content-contentlink-ref)           | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md)` \| undefined` | Optional           | —           |
+
+## shoalrun.content.ContentLink.asset
+
+**Property** `shoalrun.content.ContentLink.asset`
+
+```typescript
+asset?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional
+
+## shoalrun.content.ContentLink.fragment
+
+**Property** `shoalrun.content.ContentLink.fragment`
+
+```typescript
+fragment?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional
+
+## shoalrun.content.ContentLink.href
+
+**Property** `shoalrun.content.ContentLink.href`
+
+```typescript
+href: string
+```
+
+**Type: **`string`
+
+Required
+
+## shoalrun.content.ContentLink.key
+
+**Property** `shoalrun.content.ContentLink.key`
+
+```typescript
+key: string
+```
+
+**Type: **`string`
+
+Required
+
+## shoalrun.content.ContentLink.kind
+
+**Property** `shoalrun.content.ContentLink.kind`
+
+```typescript
+kind: "resource" | "canonical" | "external" | "asset"
+```
+
+**Type: **`"resource" | "canonical" | "external" | "asset"`
+
+Required
+
+## shoalrun.content.ContentLink.query
+
+**Property** `shoalrun.content.ContentLink.query`
+
+```typescript
+query?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional
+
+## shoalrun.content.ContentLink.ref
+
+**Property** `shoalrun.content.ContentLink.ref`
+
+```typescript
+ref?: ContentRef | undefined
+```
+
+**Type: **[`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md)` | undefined`
+
+Optional

package/agent-docs/content-delivery/sdk/content-manifest/assets.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.assets
+title: assets
+summary: "property: shoalrun.content.ContentManifest.assets"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/assets
+---
+
+# assets
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.assets`
+
+```typescript
+assets: ContentAsset[]
+```
+
+**Type: **[`ContentAsset`](https://www.shoalrun.com/content-delivery/sdk/content-asset.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/diagnostics.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.diagnostics
+title: diagnostics
+summary: "property: shoalrun.content.ContentManifest.diagnostics"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/diagnostics
+---
+
+# diagnostics
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.diagnostics`
+
+```typescript
+diagnostics: { code: string; documentId?: string; message: string; }[]
+```
+
+**Type: **`{ code: string; documentId?: string; message: string; }[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/digest.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.digest
+title: digest
+summary: "property: shoalrun.content.ContentManifest.digest"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/digest
+---
+
+# digest
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.digest`
+
+```typescript
+digest: string
+```
+
+**Type: **`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/files.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.files
+title: files
+summary: "property: shoalrun.content.ContentManifest.files"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/files
+---
+
+# files
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.files`
+
+```typescript
+files: ContentFile[]
+```
+
+**Type: **[`ContentFile`](https://www.shoalrun.com/content-delivery/sdk/content-file.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/kind.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.kind
+title: kind
+summary: "property: shoalrun.content.ContentManifest.kind"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/kind
+---
+
+# kind
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.kind`
+
+```typescript
+kind: "shoalrun-content-export"
+```
+
+**Type: **`"shoalrun-content-export"`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/public-base.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.publicBase
+title: publicBase
+summary: "property: shoalrun.content.ContentManifest.publicBase"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/public-base
+---
+
+# publicBase
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.publicBase`
+
+```typescript
+publicBase: string
+```
+
+**Type: **`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/publication.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.publication
+title: publication
+summary: "property: shoalrun.content.ContentManifest.publication"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/publication
+---
+
+# publication
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.publication`
+
+```typescript
+publication: ContentPublication
+```
+
+**Type: **[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/resources.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.resources
+title: resources
+summary: "property: shoalrun.content.ContentManifest.resources"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/resources
+---
+
+# resources
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.resources`
+
+```typescript
+resources: ContentResource[]
+```
+
+**Type: **[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/review.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.review
+title: review
+summary: "property: shoalrun.content.ContentManifest.review"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/review
+---
+
+# review
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.review`
+
+```typescript
+review: { status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }
+```
+
+**Type:&#x20;**`{ status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest/schema-version.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentManifest.schemaVersion
+title: schemaVersion
+summary: "property: shoalrun.content.ContentManifest.schemaVersion"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest/schema-version
+---
+
+# schemaVersion
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentManifest.schemaVersion`
+
+```typescript
+schemaVersion: 1 | 2
+```
+
+**Type: **`1 | 2`
+
+Required

package/agent-docs/content-delivery/sdk/content-manifest.md

@@ -0,0 +1,179 @@
+---
+id: reference.content-sdk.ContentManifest
+title: ContentManifest
+summary: One validated, content-addressed export inventory.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-manifest
+---
+
+# ContentManifest
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Type** `shoalrun.content.ContentManifest`
+
+```typescript
+type ContentManifest = {
+    schemaVersion: 1 | 2;
+    kind: 'shoalrun-content-export';
+    digest: string;
+    publicBase: string;
+    publication: ContentPublication;
+    review: {
+        status: 'ok' | 'required';
+        apis: Array<{
+            apiId: string;
+            digest: string;
+        }>;
+    };
+    resources: ContentResource[];
+    assets: ContentAsset[];
+    files: ContentFile[];
+    diagnostics: Array<{
+        code: string;
+        documentId?: string;
+        message: string;
+    }>;
+};
+```
+
+One validated, content-addressed export inventory.
+
+## Fields
+
+| Name                                                                                                                                | Type                                                                                         | Required / default | Description |
+| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| [`assets`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-assets)               | [`ContentAsset`](https://www.shoalrun.com/content-delivery/sdk/content-asset.md)`[]`         | Required           | —           |
+| [`diagnostics`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-diagnostics)     | `{ code: string; documentId?: string; message: string; }[]`                                  | Required           | —           |
+| [`digest`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-digest)               | `string`                                                                                     | Required           | —           |
+| [`files`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-files)                 | [`ContentFile`](https://www.shoalrun.com/content-delivery/sdk/content-file.md)`[]`           | Required           | —           |
+| [`kind`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-kind)                   | `"shoalrun-content-export"`                                                                  | Required           | —           |
+| [`publicBase`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-publicbase)       | `string`                                                                                     | Required           | —           |
+| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-publication)     | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md) | Required           | —           |
+| [`resources`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-resources)         | [`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md)`[]`   | Required           | —           |
+| [`review`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-review)               | `{ status: "ok" \| "required"; apis: Array<{ apiId: string; digest: string; }>; }`           | Required           | —           |
+| [`schemaVersion`](https://www.shoalrun.com/content-delivery/sdk/content-manifest.md#shoalrun-content-contentmanifest-schemaversion) | `1 \| 2`                                                                                     | Required           | —           |
+
+## shoalrun.content.ContentManifest.assets
+
+**Property** `shoalrun.content.ContentManifest.assets`
+
+```typescript
+assets: ContentAsset[]
+```
+
+**Type:&#x20;**[`ContentAsset`](https://www.shoalrun.com/content-delivery/sdk/content-asset.md)`[]`
+
+Required
+
+## shoalrun.content.ContentManifest.diagnostics
+
+**Property** `shoalrun.content.ContentManifest.diagnostics`
+
+```typescript
+diagnostics: { code: string; documentId?: string; message: string; }[]
+```
+
+**Type:&#x20;**`{ code: string; documentId?: string; message: string; }[]`
+
+Required
+
+## shoalrun.content.ContentManifest.digest
+
+**Property** `shoalrun.content.ContentManifest.digest`
+
+```typescript
+digest: string
+```
+
+**Type:&#x20;**`string`
+
+Required
+
+## shoalrun.content.ContentManifest.files
+
+**Property** `shoalrun.content.ContentManifest.files`
+
+```typescript
+files: ContentFile[]
+```
+
+**Type:&#x20;**[`ContentFile`](https://www.shoalrun.com/content-delivery/sdk/content-file.md)`[]`
+
+Required
+
+## shoalrun.content.ContentManifest.kind
+
+**Property** `shoalrun.content.ContentManifest.kind`
+
+```typescript
+kind: "shoalrun-content-export"
+```
+
+**Type:&#x20;**`"shoalrun-content-export"`
+
+Required
+
+## shoalrun.content.ContentManifest.publicBase
+
+**Property** `shoalrun.content.ContentManifest.publicBase`
+
+```typescript
+publicBase: string
+```
+
+**Type:&#x20;**`string`
+
+Required
+
+## shoalrun.content.ContentManifest.publication
+
+**Property** `shoalrun.content.ContentManifest.publication`
+
+```typescript
+publication: ContentPublication
+```
+
+**Type:&#x20;**[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)
+
+Required
+
+## shoalrun.content.ContentManifest.resources
+
+**Property** `shoalrun.content.ContentManifest.resources`
+
+```typescript
+resources: ContentResource[]
+```
+
+**Type:&#x20;**[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md)`[]`
+
+Required
+
+## shoalrun.content.ContentManifest.review
+
+**Property** `shoalrun.content.ContentManifest.review`
+
+```typescript
+review: { status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }
+```
+
+**Type:&#x20;**`{ status: "ok" | "required"; apis: Array<{ apiId: string; digest: string; }>; }`
+
+Required
+
+## shoalrun.content.ContentManifest.schemaVersion
+
+**Property** `shoalrun.content.ContentManifest.schemaVersion`
+
+```typescript
+schemaVersion: 1 | 2
+```
+
+**Type:&#x20;**`1 | 2`
+
+Required

package/agent-docs/content-delivery/sdk/content-mount/anchors.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentMount.anchors
+title: anchors
+summary: Anchors after instance-specific ID rewriting.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-mount/anchors
+---
+
+# anchors
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentMount.anchors`
+
+```typescript
+anchors: readonly ContentAnchor[]
+```
+
+Anchors after instance-specific ID rewriting.
+
+**Type: **`readonly `[`ContentAnchor`](https://www.shoalrun.com/content-delivery/sdk/content-anchor.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-mount/links.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentMount.links
+title: links
+summary: Typed links, including rewritten local fragments for this instance.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-mount/links
+---
+
+# links
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Property** `shoalrun.content.ContentMount.links`
+
+```typescript
+links: readonly ContentLink[]
+```
+
+Typed links, including rewritten local fragments for this instance.
+
+**Type: **`readonly `[`ContentLink`](https://www.shoalrun.com/content-delivery/sdk/content-link.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-mount/unmount.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentMount.unmount
+title: unmount
+summary: Remove nodes that still belong to this mount.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-mount/unmount
+---
+
+# unmount
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+**Updated: 2026-09-27.**
+
+**Method** `shoalrun.content.ContentMount.unmount`
+
+```typescript
+unmount(): void
+```
+
+Remove nodes that still belong to this mount.
+
+## Returns
+
+`void`