npm - @shoalrun/cli - Versions diffs - 0.1.0-alpha.11 → 0.1.0-alpha.12 - Mend

@shoalrun/cli 0.1.0-alpha.11 → 0.1.0-alpha.12

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.

Files changed (513) hide show

package/agent-docs/config/examples.sections/parcel-api-documentation.md CHANGED Viewed

@@ -13,30 +13,35 @@ canonical: /config/examples
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt) (ID: examples-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Example projects
+Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
 **Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/config/examples.md)
-Each example below is a complete project in the repository's `framework/example-configs/` directory, with pages and any OpenAPI files it needs. The test suite builds every one, and checks that the configs on this page match the files, so they stay correct. Start with the bundled `minimal`, `api-docs`, or `showcase` project, then build it:
+The installed package includes complete projects under `node_modules/@shoalrun/cli/example-configs/`, with their pages and local OpenAPI files. Start with a bundled starter in a new directory:
+Install Node.js 22.12 or newer and npm before running these commands.
 ```sh
-shoalrun init my-docs --starter minimal
+mkdir my-docs
 cd my-docs
-shoalrun build docs.config.yaml site-dist
-shoalrun serve site-dist
+npm init -y
+npm install --save-exact @shoalrun/cli@0.1.0-alpha.11
+npx --no-install shoalrun init . --starter minimal
+npx --no-install shoalrun build docs.config.yaml site-dist
+npx --no-install shoalrun serve site-dist
 ```
-Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `framework/example-configs/`.
+Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `node_modules/@shoalrun/cli/example-configs/`.
-The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. Build it from the repository root:
+The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. From the project where you installed Shoalrun, build the bundled example:
 ```sh
-node framework/dist/cli.js build framework/example-configs/notifications/docs.config.yaml /tmp/notifications-site
-node framework/dist/cli.js serve /tmp/notifications-site
+npx --no-install shoalrun build node_modules/@shoalrun/cli/example-configs/notifications/docs.config.yaml /tmp/notifications-site
+npx --no-install shoalrun serve /tmp/notifications-site
 ```
 The [configuration reference](https://www.shoalrun.com/config.md) explains every key.

package/agent-docs/config/examples.sections/related-reading.md CHANGED Viewed

@@ -13,30 +13,35 @@ canonical: /config/examples
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt) (ID: examples-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Example projects
+Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
 **Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/config/examples.md)
-Each example below is a complete project in the repository's `framework/example-configs/` directory, with pages and any OpenAPI files it needs. The test suite builds every one, and checks that the configs on this page match the files, so they stay correct. Start with the bundled `minimal`, `api-docs`, or `showcase` project, then build it:
+The installed package includes complete projects under `node_modules/@shoalrun/cli/example-configs/`, with their pages and local OpenAPI files. Start with a bundled starter in a new directory:
+Install Node.js 22.12 or newer and npm before running these commands.
 ```sh
-shoalrun init my-docs --starter minimal
+mkdir my-docs
 cd my-docs
-shoalrun build docs.config.yaml site-dist
-shoalrun serve site-dist
+npm init -y
+npm install --save-exact @shoalrun/cli@0.1.0-alpha.11
+npx --no-install shoalrun init . --starter minimal
+npx --no-install shoalrun build docs.config.yaml site-dist
+npx --no-install shoalrun serve site-dist
 ```
-Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `framework/example-configs/`.
+Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `node_modules/@shoalrun/cli/example-configs/`.
-The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. Build it from the repository root:
+The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. From the project where you installed Shoalrun, build the bundled example:
 ```sh
-node framework/dist/cli.js build framework/example-configs/notifications/docs.config.yaml /tmp/notifications-site
-node framework/dist/cli.js serve /tmp/notifications-site
+npx --no-install shoalrun build node_modules/@shoalrun/cli/example-configs/notifications/docs.config.yaml /tmp/notifications-site
+npx --no-install shoalrun serve /tmp/notifications-site
 ```
 The [configuration reference](https://www.shoalrun.com/config.md) explains every key.

package/agent-docs/config/examples.sections/shared-company-preset.md CHANGED Viewed

@@ -13,30 +13,35 @@ canonical: /config/examples
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt) (ID: examples-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Example projects
+Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
 **Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/config/examples.md)
-Each example below is a complete project in the repository's `framework/example-configs/` directory, with pages and any OpenAPI files it needs. The test suite builds every one, and checks that the configs on this page match the files, so they stay correct. Start with the bundled `minimal`, `api-docs`, or `showcase` project, then build it:
+The installed package includes complete projects under `node_modules/@shoalrun/cli/example-configs/`, with their pages and local OpenAPI files. Start with a bundled starter in a new directory:
+Install Node.js 22.12 or newer and npm before running these commands.
 ```sh
-shoalrun init my-docs --starter minimal
+mkdir my-docs
 cd my-docs
-shoalrun build docs.config.yaml site-dist
-shoalrun serve site-dist
+npm init -y
+npm install --save-exact @shoalrun/cli@0.1.0-alpha.11
+npx --no-install shoalrun init . --starter minimal
+npx --no-install shoalrun build docs.config.yaml site-dist
+npx --no-install shoalrun serve site-dist
 ```
-Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `framework/example-configs/`.
+Use `--starter api-docs` for the Cedar Parcel API example, or `--starter showcase` for a complete component handbook built around that fictional service. The other examples remain available to copy from `node_modules/@shoalrun/cli/example-configs/`.
-The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. Build it from the repository root:
+The `notifications` project demonstrates an optional [cookbook chooser](https://www.shoalrun.com/author/components/cookbook-chooser.md) with email, push, and SMS choices. Its YAML maps supported selections to prebuilt recipe pages. It also includes unpublished ingredient and recipe drafts to show the authoring path. From the project where you installed Shoalrun, build the bundled example:
 ```sh
-node framework/dist/cli.js build framework/example-configs/notifications/docs.config.yaml /tmp/notifications-site
-node framework/dist/cli.js serve /tmp/notifications-site
+npx --no-install shoalrun build node_modules/@shoalrun/cli/example-configs/notifications/docs.config.yaml /tmp/notifications-site
+npx --no-install shoalrun serve /tmp/notifications-site
 ```
 The [configuration reference](https://www.shoalrun.com/config.md) explains every key.
@@ -115,4 +120,4 @@ navigation:
           doc: guide.failed-invoices
 ```
-Run `shoalrun config explain theme.preset example-configs/shared-preset/site/docs.config.yaml` to see that the preset comes from the shared file.
+From the project where you installed Shoalrun, run `npx --no-install shoalrun config explain theme.preset node_modules/@shoalrun/cli/example-configs/shared-preset/site/docs.config.yaml` to see that the preset comes from the shared file.

package/agent-docs/config/integrations.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/integrations
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Search and integration
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Search and integration
 **Updated: 2026-10-27.**

package/agent-docs/config/outputs.md CHANGED Viewed

@@ -13,9 +13,9 @@ canonical: /config/outputs
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Output and export
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
 **Updated: 2026-10-27.**

package/agent-docs/config/outputs.sections/exports.md CHANGED Viewed

@@ -13,9 +13,9 @@ canonical: /config/outputs
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Output and export
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
 **Updated: 2026-10-27.**

package/agent-docs/config/outputs.sections/metadata.md CHANGED Viewed

@@ -13,9 +13,9 @@ canonical: /config/outputs
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Output and export
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
 **Updated: 2026-10-27.**

package/agent-docs/config/outputs.sections/related-reading.md CHANGED Viewed

@@ -13,9 +13,9 @@ canonical: /config/outputs
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Output and export
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
 **Updated: 2026-10-27.**

package/agent-docs/config/publishing.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/publishing
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Publications and routing
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Publications and routing
 **Updated: 2026-10-27.**

package/agent-docs/config/publishing.sections/navigation.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/publishing
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Publications and routing
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Publications and routing
 **Updated: 2026-10-27.**

package/agent-docs/config/publishing.sections/redirects.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/publishing
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Publications and routing
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Publications and routing
 **Updated: 2026-10-27.**

package/agent-docs/config/publishing.sections/related-reading.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/publishing
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Publications and routing
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Publications and routing
 **Updated: 2026-10-27.**

package/agent-docs/config/site.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/site
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Site and theme
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
 **Updated: 2026-10-27.**

package/agent-docs/config/site.sections/related-reading.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/site
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Site and theme
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
 **Updated: 2026-10-27.**

package/agent-docs/config/site.sections/theme.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config/site
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Site and theme
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Site and theme
 **Updated: 2026-10-27.**

package/agent-docs/config.md CHANGED Viewed

@@ -12,9 +12,9 @@ canonical: /config
 > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
-Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
+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: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Reference > Configuration reference > Overview
+Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Overview
 **Updated: 2026-10-27.**

package/agent-docs/configuration.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 `docs.config.yaml` connects your content, presentation, and publication settings. Start with one file, then extract sections or share defaults when several projects need them. This guide explains how those choices interact and how to inspect the result.
@@ -52,13 +52,15 @@ Every entry config resolves to a YAML mapping with `schemaVersion: 1`. Duplicate
 ## Start with one working file
-The examples use the compiled CLI from the [quickstart](https://www.shoalrun.com/start.md). From the Shoalrun checkout root, create a separate minimal project:
+The examples use a separate project so you can replace its configuration as you follow along. Install the same pinned package used in [getting started](https://www.shoalrun.com/start.md):
 ```sh
-SHOALRUN_CLI="$PWD/framework/dist/cli.js"
 CONFIG_DEMO="$(mktemp -d)"
-node "$SHOALRUN_CLI" init "$CONFIG_DEMO/site" --starter minimal
+mkdir "$CONFIG_DEMO/site"
 cd "$CONFIG_DEMO/site"
+npm init -y
+npm install --save-exact @shoalrun/cli@0.1.0-alpha.11
+npx --no-install shoalrun init . --starter minimal
 ```
 The starter has two pages and this basic configuration structure:
@@ -94,7 +96,7 @@ navigation:
 Build once before reorganizing:
 ```sh
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 This produces the same two pages after each reorganization below. Keep `dist/` separate from content and configuration inputs.
@@ -136,8 +138,8 @@ Includes work at any depth and can include other files. Paths in `$include` are
 Inspect the substituted value and its source:
 ```sh
-node "$SHOALRUN_CLI" config resolve docs.config.yaml
-node "$SHOALRUN_CLI" config explain navigation.0.doc docs.config.yaml
+npx --no-install shoalrun config resolve docs.config.yaml
+npx --no-install shoalrun config explain navigation.0.doc docs.config.yaml
 ```
 The first command prints the effective value, digest, and configuration dependencies. The second identifies `config/nav.yaml` as the source of `guide.welcome`.
@@ -204,11 +206,11 @@ The project inherits publications, page defaults, the stylesheet, variables, and
 Check the final values and build:
 ```sh
-node "$SHOALRUN_CLI" config explain site.title docs.config.yaml
-node "$SHOALRUN_CLI" config explain site.header.links docs.config.yaml
-node "$SHOALRUN_CLI" config explain site.customCss docs.config.yaml
-node "$SHOALRUN_CLI" config validate docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config explain site.title docs.config.yaml
+npx --no-install shoalrun config explain site.header.links docs.config.yaml
+npx --no-install shoalrun config explain site.customCss docs.config.yaml
+npx --no-install shoalrun config validate docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 `site.title` comes from the local file, with the preset in its replacement history. `site.customCss` comes from `shared/base.yaml`, so `./brand.css` resolves beside that preset.
@@ -253,9 +255,9 @@ navigation: { $include: ./config/nav.yaml }
 The header now contains Support followed by Status. The variable map retains `company` and drops `legacyLabel`.
 ```sh
-node "$SHOALRUN_CLI" config explain site.header.links docs.config.yaml
-node "$SHOALRUN_CLI" config explain variables docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config explain site.header.links docs.config.yaml
+npx --no-install shoalrun config explain variables docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 ### Know the directive limits
@@ -332,7 +334,7 @@ Use these commands while reorganizing configuration:
 | `config validate docs.config.yaml`           | Successful configuration loading and theme contrast checks                 |
 | `build docs.config.yaml dist`                | Whether content, navigation, APIs, routes, and output can compile together |
-Prefix each command with `node "$SHOALRUN_CLI"`. For `explain`, the key comes before the config filename. Use numeric segments to inspect lists, such as `navigation.0.doc`. Dotted names represent traversal, so a literal key containing a dot cannot be addressed unambiguously through this CLI syntax.
+Prefix each command with `npx --no-install shoalrun`. For `explain`, the key comes before the config filename. Use numeric segments to inspect lists, such as `navigation.0.doc`. Dotted names represent traversal, so a literal key containing a dot cannot be addressed unambiguously through this CLI syntax.
 `graph` reports dependencies, not an edge-by-edge visual graph. Its list covers loaded configuration files, not every content or API input. The resolved digest hashes effective values; it is not a digest of all referenced file contents.
@@ -356,9 +358,9 @@ Match the build message or symptom to the corresponding correction.
 Finish the running example with:
 ```sh
-node "$SHOALRUN_CLI" config graph docs.config.yaml
-node "$SHOALRUN_CLI" config validate docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config graph docs.config.yaml
+npx --no-install shoalrun config validate docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 Next, use the [configuration reference](https://www.shoalrun.com/config.md) for the feature you want to add. For content or publication failures, use [troubleshooting](https://www.shoalrun.com/publish/troubleshooting.md).

package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)

package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)
@@ -53,9 +53,9 @@ navigation: { $include: ./config/nav.yaml }
 The header now contains Support followed by Status. The variable map retains `company` and drops `legacyLabel`.
 ```sh
-node "$SHOALRUN_CLI" config explain site.header.links docs.config.yaml
-node "$SHOALRUN_CLI" config explain variables docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config explain site.header.links docs.config.yaml
+npx --no-install shoalrun config explain variables docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 ### Know the directive limits

package/agent-docs/configuration.sections/extract-a-section-with-include.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)
@@ -68,8 +68,8 @@ Includes work at any depth and can include other files. Paths in `$include` are
 Inspect the substituted value and its source:
 ```sh
-node "$SHOALRUN_CLI" config resolve docs.config.yaml
-node "$SHOALRUN_CLI" config explain navigation.0.doc docs.config.yaml
+npx --no-install shoalrun config resolve docs.config.yaml
+npx --no-install shoalrun config explain navigation.0.doc docs.config.yaml
 ```
 The first command prints the effective value, digest, and configuration dependencies. The second identifies `config/nav.yaml` as the source of `guide.welcome`.

package/agent-docs/configuration.sections/inspect-and-validate-changes.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)
@@ -45,7 +45,7 @@ Use these commands while reorganizing configuration:
 | `config validate docs.config.yaml`           | Successful configuration loading and theme contrast checks                 |
 | `build docs.config.yaml dist`                | Whether content, navigation, APIs, routes, and output can compile together |
-Prefix each command with `node "$SHOALRUN_CLI"`. For `explain`, the key comes before the config filename. Use numeric segments to inspect lists, such as `navigation.0.doc`. Dotted names represent traversal, so a literal key containing a dot cannot be addressed unambiguously through this CLI syntax.
+Prefix each command with `npx --no-install shoalrun`. For `explain`, the key comes before the config filename. Use numeric segments to inspect lists, such as `navigation.0.doc`. Dotted names represent traversal, so a literal key containing a dot cannot be addressed unambiguously through this CLI syntax.
 `graph` reports dependencies, not an edge-by-edge visual graph. Its list covers loaded configuration files, not every content or API input. The resolved digest hashes effective values; it is not a digest of all referenced file contents.
@@ -69,9 +69,9 @@ Match the build message or symptom to the corresponding correction.
 Finish the running example with:
 ```sh
-node "$SHOALRUN_CLI" config graph docs.config.yaml
-node "$SHOALRUN_CLI" config validate docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config graph docs.config.yaml
+npx --no-install shoalrun config validate docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 Next, use the [configuration reference](https://www.shoalrun.com/config.md) for the feature you want to add. For content or publication failures, use [troubleshooting](https://www.shoalrun.com/publish/troubleshooting.md).

package/agent-docs/configuration.sections/related-reading.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)

package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)

package/agent-docs/configuration.sections/share-defaults-through-extends.md CHANGED Viewed

@@ -15,9 +15,9 @@ canonical: /configuration
 Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigation/docs-50f26fe22670.txt) (ID: docs). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
-Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Get started > Configure your project
+Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
-**Updated: 2026-10-26.**
+**Updated: 2026-10-27.**
 Parent page: [Full Markdown page](/configuration.md)
@@ -93,11 +93,11 @@ The project inherits publications, page defaults, the stylesheet, variables, and
 Check the final values and build:
 ```sh
-node "$SHOALRUN_CLI" config explain site.title docs.config.yaml
-node "$SHOALRUN_CLI" config explain site.header.links docs.config.yaml
-node "$SHOALRUN_CLI" config explain site.customCss docs.config.yaml
-node "$SHOALRUN_CLI" config validate docs.config.yaml
-node "$SHOALRUN_CLI" build docs.config.yaml dist
+npx --no-install shoalrun config explain site.title docs.config.yaml
+npx --no-install shoalrun config explain site.header.links docs.config.yaml
+npx --no-install shoalrun config explain site.customCss docs.config.yaml
+npx --no-install shoalrun config validate docs.config.yaml
+npx --no-install shoalrun build docs.config.yaml dist
 ```
 `site.title` comes from the local file, with the preset in its replacement history. `site.customCss` comes from `shared/base.yaml`, so `./brand.css` resolves beside that preset.