@shoalrun/cli 0.1.0-beta.1 → 1.1.0

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

@@ -0,0 +1,43 @@
+---
+id: reference.content-sdk.ContentAsset
+title: ContentAsset
+summary: A content-addressed file with its declared media type.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-asset
+---
+
+# ContentAsset
+
+> 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.ContentAsset`
+
+```typescript
+type ContentAsset = ContentFile & {
+    mediaType: string;
+};
+```
+
+A content-addressed file with its declared media type.
+
+## Fields
+
+| Name                                                                                                                  | Type     | Required / default | Description |
+| --------------------------------------------------------------------------------------------------------------------- | -------- | ------------------ | ----------- |
+| [`mediaType`](https://www.shoalrun.com/content-delivery/sdk/content-asset.md#shoalrun-content-contentasset-mediatype) | `string` | Required           | —           |
+
+## shoalrun.content.ContentAsset.mediaType
+
+**Property** `shoalrun.content.ContentAsset.mediaType`
+
+```typescript
+mediaType: string
+```
+
+**Type: **`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-delivery-error/code.md

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

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

@@ -0,0 +1,53 @@
+---
+id: reference.content-sdk.ContentDeliveryError
+title: ContentDeliveryError
+summary: Delivery failure with a machine-readable code and a human-readable message.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-delivery-error
+---
+
+# ContentDeliveryError
+
+> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
+
+Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Content delivery > TypeScript symbols > ContentDeliveryError
+
+**Updated: 2026-11-07.**
+
+**Class** `shoalrun.content.ContentDeliveryError`
+
+```typescript
+class ContentDeliveryError extends Error
+```
+
+Delivery failure with a machine-readable code and a human-readable message.
+
+## Constructor
+
+```typescript
+new ContentDeliveryError(code: ContentErrorCode, message: string): ContentDeliveryError
+```
+
+**Bases: **`Error`
+
+## Fields
+
+| Name                                                                                                                         | Type                                                                                      | Required / default | Description |
+| ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| [`code`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-error.md#shoalrun-content-contentdeliveryerror-code) | [`ContentErrorCode`](https://www.shoalrun.com/content-delivery/sdk/content-error-code.md) | Required           | —           |
+
+## shoalrun.content.ContentDeliveryError.code
+
+**Property** `shoalrun.content.ContentDeliveryError.code`
+
+```typescript
+readonly code: ContentErrorCode
+```
+
+**Type: **[`ContentErrorCode`](https://www.shoalrun.com/content-delivery/sdk/content-error-code.md)
+
+Required

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

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentDeliveryLimits.manifestBytes
+title: manifestBytes
+summary: Maximum manifest or REST inventory bytes. Defaults to 5,000,000.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-delivery-limits/manifest-bytes
+---
+
+# manifestBytes
+
+> 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.ContentDeliveryLimits.manifestBytes`
+
+```typescript
+manifestBytes?: number | undefined
+```
+
+Maximum manifest or REST inventory bytes. Defaults to 5,000,000.
+
+**Type: **`number | undefined`
+
+Optional

package/agent-docs/content-delivery/sdk/content-delivery-limits/resource-bytes.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentDeliveryLimits.resourceBytes
+title: resourceBytes
+summary: Maximum bytes for an individual representation. Defaults to 8,000,000.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-delivery-limits/resource-bytes
+---
+
+# resourceBytes
+
+> 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.ContentDeliveryLimits.resourceBytes`
+
+```typescript
+resourceBytes?: number | undefined
+```
+
+Maximum bytes for an individual representation. Defaults to 8,000,000.
+
+**Type: **`number | undefined`
+
+Optional

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

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentDeliveryLimits.resources
+title: resources
+summary: Maximum resource count in the inventory. Defaults to 10,000.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-delivery-limits/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.ContentDeliveryLimits.resources`
+
+```typescript
+resources?: number | undefined
+```
+
+Maximum resource count in the inventory. Defaults to 10,000.
+
+**Type: **`number | undefined`
+
+Optional

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

@@ -0,0 +1,77 @@
+---
+id: reference.content-sdk.ContentDeliveryLimits
+title: ContentDeliveryLimits
+summary: Positive safe-integer bounds applied when opening and reading content.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-delivery-limits
+---
+
+# ContentDeliveryLimits
+
+> 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.ContentDeliveryLimits`
+
+```typescript
+type ContentDeliveryLimits = {
+    manifestBytes?: number;
+    resourceBytes?: number;
+    resources?: number;
+};
+```
+
+Positive safe-integer bounds applied when opening and reading content.
+
+## Fields
+
+| Name                                                                                                                                             | Type                  | Required / default | Description                                                            |
+| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------- | ------------------ | ---------------------------------------------------------------------- |
+| [`manifestBytes`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md#shoalrun-content-contentdeliverylimits-manifestbytes) | `number \| undefined` | Optional           | Maximum manifest or REST inventory bytes. Defaults to 5,000,000.       |
+| [`resourceBytes`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md#shoalrun-content-contentdeliverylimits-resourcebytes) | `number \| undefined` | Optional           | Maximum bytes for an individual representation. Defaults to 8,000,000. |
+| [`resources`](https://www.shoalrun.com/content-delivery/sdk/content-delivery-limits.md#shoalrun-content-contentdeliverylimits-resources)         | `number \| undefined` | Optional           | Maximum resource count in the inventory. Defaults to 10,000.           |
+
+## shoalrun.content.ContentDeliveryLimits.manifestBytes
+
+**Property** `shoalrun.content.ContentDeliveryLimits.manifestBytes`
+
+```typescript
+manifestBytes?: number | undefined
+```
+
+Maximum manifest or REST inventory bytes. Defaults to 5,000,000.
+
+**Type: **`number | undefined`
+
+Optional
+
+## shoalrun.content.ContentDeliveryLimits.resourceBytes
+
+**Property** `shoalrun.content.ContentDeliveryLimits.resourceBytes`
+
+```typescript
+resourceBytes?: number | undefined
+```
+
+Maximum bytes for an individual representation. Defaults to 8,000,000.
+
+**Type: **`number | undefined`
+
+Optional
+
+## shoalrun.content.ContentDeliveryLimits.resources
+
+**Property** `shoalrun.content.ContentDeliveryLimits.resources`
+
+```typescript
+resources?: number | undefined
+```
+
+Maximum resource count in the inventory. Defaults to 10,000.
+
+**Type: **`number | undefined`
+
+Optional

package/agent-docs/content-delivery/sdk/content-error-code.md

@@ -0,0 +1,23 @@
+---
+id: reference.content-sdk.ContentErrorCode
+title: ContentErrorCode
+summary: Stable error categories raised by content-source validation and reads.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-error-code
+---
+
+# ContentErrorCode
+
+> 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.ContentErrorCode`
+
+```typescript
+type ContentErrorCode = 'invalid_manifest' | 'not_found' | 'unsupported_format' | 'stale_revision' | 'network_error' | 'invalid_content' | 'disposed';
+```
+
+Stable error categories raised by content-source validation and reads.

package/agent-docs/content-delivery/sdk/content-file/bytes.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentFile.bytes
+title: bytes
+summary: "property: shoalrun.content.ContentFile.bytes"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-file/bytes
+---
+
+# bytes
+
+> 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.ContentFile.bytes`
+
+```typescript
+bytes: number
+```
+
+**Type: **`number`
+
+Required

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentFile.digest
+title: digest
+summary: "property: shoalrun.content.ContentFile.digest"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-file/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.ContentFile.digest`
+
+```typescript
+digest: string
+```
+
+**Type: **`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-file/path.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentFile.path
+title: path
+summary: "property: shoalrun.content.ContentFile.path"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-file/path
+---
+
+# path
+
+> 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.ContentFile.path`
+
+```typescript
+path: string
+```
+
+**Type: **`string`
+
+Required

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

@@ -0,0 +1,71 @@
+---
+id: reference.content-sdk.ContentFile
+title: ContentFile
+summary: Export-relative file path, byte length, and SHA-256 digest.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-file
+---
+
+# ContentFile
+
+> 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.ContentFile`
+
+```typescript
+type ContentFile = {
+    path: string;
+    bytes: number;
+    digest: string;
+};
+```
+
+Export-relative file path, byte length, and SHA-256 digest.
+
+## Fields
+
+| Name                                                                                                          | Type     | Required / default | Description |
+| ------------------------------------------------------------------------------------------------------------- | -------- | ------------------ | ----------- |
+| [`bytes`](https://www.shoalrun.com/content-delivery/sdk/content-file.md#shoalrun-content-contentfile-bytes)   | `number` | Required           | —           |
+| [`digest`](https://www.shoalrun.com/content-delivery/sdk/content-file.md#shoalrun-content-contentfile-digest) | `string` | Required           | —           |
+| [`path`](https://www.shoalrun.com/content-delivery/sdk/content-file.md#shoalrun-content-contentfile-path)     | `string` | Required           | —           |
+
+## shoalrun.content.ContentFile.bytes
+
+**Property** `shoalrun.content.ContentFile.bytes`
+
+```typescript
+bytes: number
+```
+
+**Type: **`number`
+
+Required
+
+## shoalrun.content.ContentFile.digest
+
+**Property** `shoalrun.content.ContentFile.digest`
+
+```typescript
+digest: string
+```
+
+**Type: **`string`
+
+Required
+
+## shoalrun.content.ContentFile.path
+
+**Property** `shoalrun.content.ContentFile.path`
+
+```typescript
+path: string
+```
+
+**Type: **`string`
+
+Required

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

@@ -0,0 +1,23 @@
+---
+id: reference.content-sdk.ContentFormat
+title: ContentFormat
+summary: Portable representations a content client can request.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-format
+---
+
+# ContentFormat
+
+> 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.ContentFormat`
+
+```typescript
+type ContentFormat = 'html' | 'markdown';
+```
+
+Portable representations a content client can request.

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.asset
+title: asset
+summary: "property: shoalrun.content.ContentLink.asset"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/asset
+---
+
+# asset
+
+> 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.ContentLink.asset`
+
+```typescript
+asset?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.fragment
+title: fragment
+summary: "property: shoalrun.content.ContentLink.fragment"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/fragment
+---
+
+# fragment
+
+> 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.ContentLink.fragment`
+
+```typescript
+fragment?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.href
+title: href
+summary: "property: shoalrun.content.ContentLink.href"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/href
+---
+
+# href
+
+> 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.ContentLink.href`
+
+```typescript
+href: string
+```
+
+**Type: **`string`
+
+Required

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.key
+title: key
+summary: "property: shoalrun.content.ContentLink.key"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/key
+---
+
+# key
+
+> 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.ContentLink.key`
+
+```typescript
+key: string
+```
+
+**Type: **`string`
+
+Required

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.kind
+title: kind
+summary: "property: shoalrun.content.ContentLink.kind"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/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.ContentLink.kind`
+
+```typescript
+kind: "resource" | "canonical" | "external" | "asset"
+```
+
+**Type: **`"resource" | "canonical" | "external" | "asset"`
+
+Required

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.query
+title: query
+summary: "property: shoalrun.content.ContentLink.query"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/query
+---
+
+# query
+
+> 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.ContentLink.query`
+
+```typescript
+query?: string | undefined
+```
+
+**Type: **`string | undefined`
+
+Optional

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentLink.ref
+title: ref
+summary: "property: shoalrun.content.ContentLink.ref"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-link/ref
+---
+
+# ref
+
+> 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.ContentLink.ref`
+
+```typescript
+ref?: ContentRef | undefined
+```
+
+**Type: **[`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md)` | undefined`
+
+Optional