@shoalrun/cli 1.0.0 → 1.1.0

package/agent-docs/content-delivery/sdk/content-resource/title.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentResource.title
+title: title
+summary: Human-readable resource title.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-resource/title
+---
+
+# title
+
+> 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.ContentResource.title`
+
+```typescript
+title: string
+```
+
+Human-readable resource title.
+
+**Type: **`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-resource/type.md

@@ -0,0 +1,27 @@
+---
+id: reference.content-sdk.ContentResource.type
+title: type
+summary: Authored document type, or section/snippet for a selected resource.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-resource/type
+---
+
+# type
+
+> 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.ContentResource.type`
+
+```typescript
+type: string
+```
+
+Authored document type, or section/snippet for a selected resource.
+
+**Type: **`string`
+
+Required

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

@@ -0,0 +1,34 @@
+---
+id: reference.content-sdk.contentResourceKey
+title: contentResourceKey
+summary: "Public identity only: independent of publication, revision, and export
+  filenames."
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-resource-key
+---
+
+# contentResourceKey
+
+> 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.**
+
+**Function** `shoalrun.content.contentResourceKey`
+
+```typescript
+contentResourceKey(ref: ContentRef): string
+```
+
+Public identity only: independent of publication, revision, and export filenames.
+
+## Parameters
+
+| Parameter | Type / default                                                               | Description |
+| --------- | ---------------------------------------------------------------------------- | ----------- |
+| `ref`     | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md) | —           |
+
+## Returns
+
+`string`

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

@@ -0,0 +1,192 @@
+---
+id: reference.content-sdk.ContentResource
+title: ContentResource
+summary: Inventory entry describing one exported document, section, or snippet instance.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-resource
+---
+
+# ContentResource
+
+> 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 > ContentResource
+
+**Updated: 2026-09-27.**
+
+**Type** `shoalrun.content.ContentResource`
+
+```typescript
+type ContentResource = {
+    ref: ContentRef;
+    publication: ContentPublication;
+    title: string;
+    summary: string;
+    type: string;
+    canonicalUrl?: string;
+    source?: {
+        documentId?: string;
+        snippetId?: string;
+        valuesDigest?: string;
+    };
+    representations: Partial<Record<ContentFormat, ContentRepresentation>>;
+    assets: string[];
+    externalDependencies: Array<{
+        url: string;
+        kind: 'image';
+    }>;
+};
+```
+
+Inventory entry describing one exported document, section, or snippet instance.
+
+## Fields
+
+| Name                                                                                                                                              | Type                                                                                                                                                                                                          | Required / default | Description                                                           |
+| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | --------------------------------------------------------------------- |
+| [`assets`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-assets)                             | `string[]`                                                                                                                                                                                                    | Required           | —                                                                     |
+| [`canonicalUrl`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-canonicalurl)                 | `string \| undefined`                                                                                                                                                                                         | Optional           | —                                                                     |
+| [`externalDependencies`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-externaldependencies) | `{ url: string; kind: "image"; }[]`                                                                                                                                                                           | Required           | —                                                                     |
+| [`publication`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-publication)                   | [`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)                                                                                                                  | Required           | Exact product, channel, version, and documentation language.          |
+| [`ref`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-ref)                                   | [`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md)                                                                                                                                  | Required           | Stable identity used by ContentSnapshot.get.                          |
+| [`representations`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-representations)           | `Partial<Record<`[`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/content-format.md)`, `[`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/content-representation.md)`>>` | Required           | Available portable formats and their files, anchors, and typed links. |
+| [`source`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-source)                             | `{ documentId?: string; snippetId?: string; valuesDigest?: string; } \| undefined`                                                                                                                            | Optional           | —                                                                     |
+| [`summary`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-summary)                           | `string`                                                                                                                                                                                                      | Required           | Short explanation of the resource's purpose.                          |
+| [`title`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-title)                               | `string`                                                                                                                                                                                                      | Required           | Human-readable resource title.                                        |
+| [`type`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md#shoalrun-content-contentresource-type)                                 | `string`                                                                                                                                                                                                      | Required           | Authored document type, or section/snippet for a selected resource.   |
+
+## shoalrun.content.ContentResource.assets
+
+**Property** `shoalrun.content.ContentResource.assets`
+
+```typescript
+assets: string[]
+```
+
+**Type:&#x20;**`string[]`
+
+Required
+
+## shoalrun.content.ContentResource.canonicalUrl
+
+**Property** `shoalrun.content.ContentResource.canonicalUrl`
+
+```typescript
+canonicalUrl?: string | undefined
+```
+
+**Type:&#x20;**`string | undefined`
+
+Optional
+
+## shoalrun.content.ContentResource.externalDependencies
+
+**Property** `shoalrun.content.ContentResource.externalDependencies`
+
+```typescript
+externalDependencies: { url: string; kind: "image"; }[]
+```
+
+**Type:&#x20;**`{ url: string; kind: "image"; }[]`
+
+Required
+
+## shoalrun.content.ContentResource.publication
+
+**Property** `shoalrun.content.ContentResource.publication`
+
+```typescript
+publication: ContentPublication
+```
+
+Exact product, channel, version, and documentation language.
+
+**Type:&#x20;**[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)
+
+Required
+
+## shoalrun.content.ContentResource.ref
+
+**Property** `shoalrun.content.ContentResource.ref`
+
+```typescript
+ref: ContentRef
+```
+
+Stable identity used by ContentSnapshot.get.
+
+**Type:&#x20;**[`ContentRef`](https://www.shoalrun.com/content-delivery/sdk/content-ref.md)
+
+Required
+
+## shoalrun.content.ContentResource.representations
+
+**Property** `shoalrun.content.ContentResource.representations`
+
+```typescript
+representations: Partial<Record<ContentFormat, ContentRepresentation>>
+```
+
+Available portable formats and their files, anchors, and typed links.
+
+**Type:&#x20;**`Partial<Record<`[`ContentFormat`](https://www.shoalrun.com/content-delivery/sdk/content-format.md)`, `[`ContentRepresentation`](https://www.shoalrun.com/content-delivery/sdk/content-representation.md)`>>`
+
+Required
+
+## shoalrun.content.ContentResource.source
+
+**Property** `shoalrun.content.ContentResource.source`
+
+```typescript
+source?: { documentId?: string; snippetId?: string; valuesDigest?: string; } | undefined
+```
+
+**Type:&#x20;**`{ documentId?: string; snippetId?: string; valuesDigest?: string; } | undefined`
+
+Optional
+
+## shoalrun.content.ContentResource.summary
+
+**Property** `shoalrun.content.ContentResource.summary`
+
+```typescript
+summary: string
+```
+
+Short explanation of the resource's purpose.
+
+**Type:&#x20;**`string`
+
+Required
+
+## shoalrun.content.ContentResource.title
+
+**Property** `shoalrun.content.ContentResource.title`
+
+```typescript
+title: string
+```
+
+Human-readable resource title.
+
+**Type:&#x20;**`string`
+
+Required
+
+## shoalrun.content.ContentResource.type
+
+**Property** `shoalrun.content.ContentResource.type`
+
+```typescript
+type: string
+```
+
+Authored document type, or section/snippet for a selected resource.
+
+**Type:&#x20;**`string`
+
+Required

package/agent-docs/content-delivery/sdk/content-rest-entry/key.md

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

package/agent-docs/content-delivery/sdk/content-rest-entry/resource.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentRestEntry.resource
+title: resource
+summary: "property: shoalrun.content.ContentRestEntry.resource"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-entry/resource
+---
+
+# resource
+
+> 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.ContentRestEntry.resource`
+
+```typescript
+resource: ContentResource
+```
+
+**Type: **[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md)
+
+Required

package/agent-docs/content-delivery/sdk/content-rest-entry.md

@@ -0,0 +1,57 @@
+---
+id: reference.content-sdk.ContentRestEntry
+title: ContentRestEntry
+summary: One resource inventory entry with its REST lookup key.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-entry
+---
+
+# ContentRestEntry
+
+> 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.ContentRestEntry`
+
+```typescript
+type ContentRestEntry = {
+    key: string;
+    resource: ContentResource;
+};
+```
+
+One resource inventory entry with its REST lookup key.
+
+## Fields
+
+| Name                                                                                                                         | Type                                                                                   | Required / default | Description |
+| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| [`key`](https://www.shoalrun.com/content-delivery/sdk/content-rest-entry.md#shoalrun-content-contentrestentry-key)           | `string`                                                                               | Required           | —           |
+| [`resource`](https://www.shoalrun.com/content-delivery/sdk/content-rest-entry.md#shoalrun-content-contentrestentry-resource) | [`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md) | Required           | —           |
+
+## shoalrun.content.ContentRestEntry.key
+
+**Property** `shoalrun.content.ContentRestEntry.key`
+
+```typescript
+key: string
+```
+
+**Type: **`string`
+
+Required
+
+## shoalrun.content.ContentRestEntry.resource
+
+**Property** `shoalrun.content.ContentRestEntry.resource`
+
+```typescript
+resource: ContentResource
+```
+
+**Type: **[`ContentResource`](https://www.shoalrun.com/content-delivery/sdk/content-resource.md)
+
+Required

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

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentRestError.error
+title: error
+summary: "property: shoalrun.content.ContentRestError.error"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-error/error
+---
+
+# error
+
+> 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.ContentRestError.error`
+
+```typescript
+error: { code: ContentRestErrorCode; message: string; }
+```
+
+**Type: **`{ code: `[`ContentRestErrorCode`](https://www.shoalrun.com/content-delivery/sdk/content-rest-error-code.md)`; message: string; }`
+
+Required

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

@@ -0,0 +1,23 @@
+---
+id: reference.content-sdk.ContentRestErrorCode
+title: ContentRestErrorCode
+summary: Error categories used by the content REST protocol.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-error-code
+---
+
+# ContentRestErrorCode
+
+> 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.ContentRestErrorCode`
+
+```typescript
+type ContentRestErrorCode = 'invalid_request' | 'not_found' | 'unsupported_format' | 'stale_revision' | 'method_not_allowed' | 'internal_error';
+```
+
+Error categories used by the content REST protocol.

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

@@ -0,0 +1,46 @@
+---
+id: reference.content-sdk.ContentRestError
+title: ContentRestError
+summary: JSON error envelope returned by the content REST service.
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-error
+---
+
+# ContentRestError
+
+> 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.ContentRestError`
+
+```typescript
+type ContentRestError = {
+    error: {
+        code: ContentRestErrorCode;
+        message: string;
+    };
+};
+```
+
+JSON error envelope returned by the content REST service.
+
+## Fields
+
+| Name                                                                                                                   | Type                                                                                                                               | Required / default | Description |
+| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
+| [`error`](https://www.shoalrun.com/content-delivery/sdk/content-rest-error.md#shoalrun-content-contentresterror-error) | `{ code: `[`ContentRestErrorCode`](https://www.shoalrun.com/content-delivery/sdk/content-rest-error-code.md)`; message: string; }` | Required           | —           |
+
+## shoalrun.content.ContentRestError.error
+
+**Property** `shoalrun.content.ContentRestError.error`
+
+```typescript
+error: { code: ContentRestErrorCode; message: string; }
+```
+
+**Type: **`{ code: `[`ContentRestErrorCode`](https://www.shoalrun.com/content-delivery/sdk/content-rest-error-code.md)`; message: string; }`
+
+Required

package/agent-docs/content-delivery/sdk/content-rest-list/publication.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentRestList.publication
+title: publication
+summary: "property: shoalrun.content.ContentRestList.publication"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-list/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.ContentRestList.publication`
+
+```typescript
+publication: ContentPublication
+```
+
+**Type: **[`ContentPublication`](https://www.shoalrun.com/content-delivery/sdk/content-publication.md)
+
+Required

package/agent-docs/content-delivery/sdk/content-rest-list/resources.md

@@ -0,0 +1,25 @@
+---
+id: reference.content-sdk.ContentRestList.resources
+title: resources
+summary: "property: shoalrun.content.ContentRestList.resources"
+type: code-reference
+area: publishing
+subarea: publishing-content-delivery
+canonical: /content-delivery/sdk/content-rest-list/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.ContentRestList.resources`
+
+```typescript
+resources: ContentRestEntry[]
+```
+
+**Type: **[`ContentRestEntry`](https://www.shoalrun.com/content-delivery/sdk/content-rest-entry.md)`[]`
+
+Required

package/agent-docs/content-delivery/sdk/content-rest-list/revision.md

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

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

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