From f547ac6cdcdd08bb690aaa1dc3ff86067ad00e6a Mon Sep 17 00:00:00 2001 From: konojunya Date: Sat, 5 Sep 2026 13:27:35 +0900 Subject: [PATCH] Document the Homebrew install path --- docs/guide/getting-started.md | 4 ++++ docs/ja/guide/getting-started.md | 4 ++++ docs/ko/guide/getting-started.md | 4 ++++ docs/zh/guide/getting-started.md | 4 ++++ scripts/docs-validation.config.mjs | 2 +- 5 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 380ac07..bc70dc6 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -2,6 +2,10 @@ The fastest way to use Stack is the browser [Playground](https://stack-diagram.com/). It runs the formatter, validator, layout engine, and SVG renderer locally in WebAssembly; you do not need to install a command or send source to a rendering API. +## Install the native CLI + +For terminal workflows and local automation, install the owner-maintained Homebrew formula with `brew install stack-sh/tap/stack`. It uses the canonical Stack CLI 0.3.0 release archive and supports Apple Silicon macOS plus glibc-based Linux on arm64 and x86_64 when the host meets Homebrew's current tier-1 requirements. Homebrew owns upgrades through `brew upgrade stack-sh/tap/stack`; uninstalling the formula leaves your Stack configuration and icon store in place. See the [CLI distribution contract](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#homebrew-installation) for the exact platform matrix, direct-install alternative, and recovery policy. + ## Write your first document Replace the editor content with this example: diff --git a/docs/ja/guide/getting-started.md b/docs/ja/guide/getting-started.md index f600daf..18d56db 100644 --- a/docs/ja/guide/getting-started.md +++ b/docs/ja/guide/getting-started.md @@ -2,6 +2,10 @@ 最短の利用方法はbrowser [Playground](https://stack-diagram.com/)です。Formatter、validator、layout engine、SVG rendererがWebAssemblyとしてlocalで動作するため、commandのinstallやrendering APIへのsource送信は不要です。 +## Native CLIをinstallする + +Terminal workflowとlocal automationでは、owner管理のHomebrew formulaを`brew install stack-sh/tap/stack`でinstallします。CanonicalなStack CLI 0.3.0 release archiveを使用し、Homebrewの現行Tier 1要件を満たすApple Silicon macOSと、arm64 / x86_64のglibc Linuxをsupportします。UpgradeはHomebrewが`brew upgrade stack-sh/tap/stack`で管理し、formulaをuninstallしてもStackのconfigとicon storeは保持されます。正確なplatform matrix、direct install、recovery policyは[CLI distribution contract](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#homebrew-installation)を参照してください。 + ## 最初のdocumentを書く Editorを次のexampleへ置き換えます。 diff --git a/docs/ko/guide/getting-started.md b/docs/ko/guide/getting-started.md index c032fbe..3117623 100644 --- a/docs/ko/guide/getting-started.md +++ b/docs/ko/guide/getting-started.md @@ -2,6 +2,10 @@ Stack을 가장 빠르게 사용하는 방법은 브라우저 [Playground](https://stack-diagram.com/)입니다. 포매터, 검증기, 레이아웃 엔진, SVG 렌더러가 WebAssembly로 로컬에서 실행되므로 명령 설치나 렌더링 API로의 소스 전송이 필요 없습니다. +## 네이티브 CLI 설치 + +터미널 워크플로와 로컬 자동화에서는 `brew install stack-sh/tap/stack`으로 Stack이 관리하는 Homebrew formula를 설치합니다. 이 formula는 표준 Stack CLI 0.3.0 릴리스 아카이브를 사용하며, Homebrew의 현재 Tier 1 요구 사항을 충족하는 Apple Silicon macOS와 arm64 / x86_64 glibc Linux를 지원합니다. 업그레이드는 Homebrew가 `brew upgrade stack-sh/tap/stack`으로 관리하며, formula를 제거해도 Stack 설정과 아이콘 저장소는 유지됩니다. 정확한 플랫폼 매트릭스, 직접 설치 방법 및 복구 정책은 [CLI 배포 계약](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#homebrew-installation)을 참고하세요. + ## 첫 문서 작성 에디터 내용을 다음 예제로 바꿉니다. diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md index 804f115..41f5c80 100644 --- a/docs/zh/guide/getting-started.md +++ b/docs/zh/guide/getting-started.md @@ -2,6 +2,10 @@ 使用 Stack 最快的方法是浏览器 [Playground](https://stack-diagram.com/)。格式化器、验证器、布局引擎和 SVG 渲染器都通过 WebAssembly 在本地运行；无需安装命令，也不会把源文件发送到渲染 API。 +## 安装原生 CLI + +对于终端工作流和本地自动化，请使用 `brew install stack-sh/tap/stack` 安装由 Stack 维护的 Homebrew formula。它使用规范的 Stack CLI 0.3.0 发布归档，并支持符合 Homebrew 当前 Tier 1 要求的 Apple Silicon macOS，以及 arm64 / x86_64 的 glibc Linux。Homebrew 通过 `brew upgrade stack-sh/tap/stack` 管理升级；卸载 formula 不会删除 Stack 配置和图标存储。有关准确的平台矩阵、直接安装方式和恢复策略，请参阅 [CLI 分发约定](https://github.com/stack-sh/cli/blob/main/docs/distribution.md#homebrew-installation)。 + ## 编写第一份文档 将编辑器内容替换为下面的示例： diff --git a/scripts/docs-validation.config.mjs b/scripts/docs-validation.config.mjs index 803fcc3..d688e97 100644 --- a/scripts/docs-validation.config.mjs +++ b/scripts/docs-validation.config.mjs @@ -32,7 +32,7 @@ export const documentationContract = { ], cli: { repository: "stack-sh/cli", - revision: "04c47eca36e4a54be83604a8a4f3fb89d135507d", + revision: "ca4a3c8f3eba3bac374f120e05151ac516de0faa", version: "0.3.0", executionExceptions: [ {