Repository navigation
docs(install): simplify the install page and ship archives #2160
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@fission-ai/openspec": patch | ||
| --- | ||
|
|
||
| Install from openspec.dev: `curl -fsSL https://openspec.dev/cli/install.sh | sh` (Windows: `irm https://openspec.dev/cli/install.ps1 | iex`). Release files are now `.tar.gz` archives (`.zip` on Windows). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,18 +21,18 @@ TODO: | |
|
|
||
| ## 1. Install | ||
|
|
||
| Run `openspec --version` first. If it already prints a version, the CLI is installed: say so, run `openspec version --check` (it prints the update command for how OpenSpec was installed when it can tell; otherwise update it the way it was installed, e.g. `brew upgrade openspec`), offer to run that command, and skip ahead to step 3. If it was installed with npm or another package manager, mention once that `openspec install` switches to the standalone install. Only offer it: the user may have chosen npm on purpose, so don't repeat it or switch unless they ask. Never switch an install to a different method on your own; that leaves two copies competing on PATH. | ||
|
|
||
| Install the standalone OpenSpec binary (on Alpine Linux, `apk add libstdc++ libgcc` first). Show the command for the user's OS and run it only once they confirm, then skip to step 3: | ||
|
|
||
| ```bash | ||
| # macOS / Linux | ||
| curl -fsSL https://openspec.dev/cli/install.sh | sh | ||
| ``` | ||
|
|
||
| ```powershell | ||
| # Windows (PowerShell) | ||
| irm https://openspec.dev/cli/install.ps1 | iex | ||
| ``` | ||
|
|
||
| If the user would rather use a package manager, or the installer fails, continue with step 2. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -75,8 +75,9 @@ Validates package version consistency before publishing. | |
|
|
||
| Builds the standalone `openspec` executables (no Node.js needed), the default | ||
| way users install OpenSpec. `.github/workflows/binaries.yml` cross-compiles | ||
| every asset on Linux, tests each on its own OS and CPU, and attaches them to | ||
| each published release as `.tar.gz` archives (`.zip` on Windows) with | ||
| `SHA256SUMS`. The installers are served from main. | ||
|
|
||
| | File | What it is | | ||
| |---|---| | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Installs the standalone `openspec.exe` (no Node.js needed) on Windows. | ||
| # | ||
| # irm https://openspec.dev/cli/install.ps1 | iex | ||
| # | ||
| # $env:OPENSPEC_VERSION release to install (default: the newest complete one), e.g. v1.15.0 | ||
| # $env:OPENSPEC_INSTALL_DIR where to put it (default: %LOCALAPPDATA%\Programs\openspec) | ||
|
|
@@ -84,19 +84,36 @@ | |
| $base = "$releases/download/$version" | ||
| } | ||
|
|
||
| try { | ||
| if (-not (Test-Path $sums)) { Invoke-WebRequest -UseBasicParsing -Uri "$base/SHA256SUMS" -OutFile $sums } | ||
| } catch { | ||
| throw "openspec install: could not download from ${base}: $($_.Exception.Message). $npmHint" | ||
| } | ||
|
|
||
| # Releases ship a .zip; v1.15.0 and earlier, the bare .exe. | ||
| $lines = Get-Content $sums | ||
| $file = $null | ||
| $expected = $null | ||
| foreach ($candidate in "$($asset -replace '\.exe$', '.zip')", $asset) { | ||
| $line = $lines | Where-Object { ($_ -split '\s+')[1] -eq $candidate } | Select-Object -First 1 | ||
| if ($line) { $file = $candidate; $expected = ($line -split '\s+')[0]; break } | ||
| } | ||
| if (-not $file) { throw "openspec install: $asset is not listed in SHA256SUMS" } | ||
|
|
||
| Write-Host "Downloading $file ($version)..." | ||
| $download = Join-Path $tmp $file | ||
| try { | ||
| Invoke-WebRequest -UseBasicParsing -Uri "$base/$file" -OutFile $download | ||
| } catch { | ||
| throw "openspec install: could not download from ${base}: $($_.Exception.Message). $npmHint" | ||
| } | ||
| $actual = (Get-FileHash -Algorithm SHA256 -Path $download).Hash | ||
| if ($actual -ne $expected) { throw "openspec install: checksum mismatch for $file; refusing to install" } | ||
| if ($file -ne $asset) { | ||
| $unpacked = Join-Path $tmp 'unpacked' | ||
| Expand-Archive -Path $download -DestinationPath $unpacked | ||
| Move-Item -Path (Join-Path $unpacked 'openspec.exe') -Destination $exe | ||
| } | ||
|
|
||
| $installed = $null | ||
| # A binary that cannot start at all throws instead of setting an exit code. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| #!/bin/sh | ||
| # Installs the standalone `openspec` binary (no Node.js needed) on Linux or macOS. | ||
| # | ||
| # curl -fsSL https://openspec.dev/cli/install.sh | sh | ||
| # | ||
| # OPENSPEC_VERSION release to install (default: the newest complete one), e.g. v1.15.0 | ||
| # OPENSPEC_INSTALL_DIR where to put it (default: ~/.local/bin) | ||
|
|
@@ -46,7 +46,7 @@ main() { | |
| case "$(uname -s)" in | ||
| Linux) os=linux ;; | ||
| Darwin) os=darwin ;; | ||
| *) fail "unsupported OS $(uname -s). On Windows, use install.ps1." ;; | ||
| esac | ||
| case "$(uname -m)" in | ||
| x86_64 | amd64) arch=x64 ;; | ||
|
|
@@ -138,21 +138,33 @@ main() { | |
| base="$releases/download/$version" | ||
| fi | ||
|
|
||
| if [ ! -s "$tmp/SHA256SUMS" ]; then | ||
| download "$base/SHA256SUMS" "$tmp/SHA256SUMS" || fail "could not download $base/SHA256SUMS; $npm_hint" | ||
| fi | ||
|
|
||
| # Releases ship a .tar.gz; v1.15.0 and earlier, the bare binary. | ||
| file="$asset.tar.gz" | ||
| expected=$(awk -v f="$file" '$2 == f { print $1 }' "$tmp/SHA256SUMS") | ||
| if [ -z "$expected" ]; then | ||
| file=$asset | ||
| expected=$(awk -v f="$file" '$2 == f { print $1 }' "$tmp/SHA256SUMS") | ||
| fi | ||
| [ -n "$expected" ] || fail "$asset is not listed in SHA256SUMS" | ||
|
|
||
| echo "Downloading $file ($version)..." | ||
| download "$base/$file" "$tmp/$file" || fail "could not download $base/$file; $npm_hint" | ||
| if command -v sha256sum >/dev/null 2>&1; then | ||
| actual=$(sha256sum "$tmp/$file" | awk '{ print $1 }') | ||
| else | ||
| actual=$(shasum -a 256 "$tmp/$file" | awk '{ print $1 }') | ||
| fi | ||
| [ "$actual" = "$expected" ] || fail "checksum mismatch for $file; refusing to install" | ||
|
|
||
| if [ "$file" != "$asset" ]; then | ||
| mkdir "$tmp/unpacked" | ||
| tar -xzf "$tmp/$file" -C "$tmp/unpacked" openspec || fail "could not unpack $file" | ||
| mv "$tmp/unpacked/openspec" "$tmp/$asset" | ||
| fi | ||
| chmod 755 "$tmp/$asset" | ||
| if ! installed=$("$tmp/$asset" --version); then | ||
| case "$asset" in | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ Runtime observed
Script executed:
Repository: Fission-AI/OpenSpec
Length of output: 363
Deploy the
/cli/install.ps1route before merging the Windows command.The README now points Windows users to
https://openspec.dev/cli/install.ps1. That URL returned HTTP 404 when checked. The PR description names only theopenspec.dev/cli/install.shredirect as a prerequisite, so nothing in the PR establishes that the PowerShell route will exist at merge. If it stays absent, the Windows Quick Start command inREADME.mdfails. Confirm that/cli/install.ps1serves the intended script before this change merges. Keep the GitHub-hosted PowerShell command until the route is live.