Checkwright

Installing step by step

These are the steps the one-line install runs, taken one at a time for a reader who wants to see each command before it runs. Run your system’s first block on the install page before them, where that page gives one. Pick a version from the releases page and put it in place of X.Y.Z. Requirements lists the tools.

macOS and Linux

Download the release into a scratch directory, so it unpacks outside the repository:

v=X.Y.Z
cw="$(mktemp -d)" \
  && curl -fsSLo "$cw/checkwright-$v.tgz" "https://github.com/checkwright/checkwright/releases/download/v$v/checkwright-$v.tgz" \
  && curl -fsSLo "$cw/checkwright-$v.tgz.sha256" "https://github.com/checkwright/checkwright/releases/download/v$v/checkwright-$v.tgz.sha256"

Where gh is installed and signed in, check the build attestation too; a release older than attestation fails it:

gh attestation verify "$cw/checkwright-$v.tgz" --repo checkwright/checkwright --source-ref "refs/tags/v$v"

Then verify, extract and run init from your repository root:

( cd "$cw" \
  && { sha256sum -c "checkwright-$v.tgz.sha256" || shasum -a 256 -c "checkwright-$v.tgz.sha256"; } \
  && tar -xzf "checkwright-$v.tgz" ) \
  && sh "$cw/package/bin/checkwright.sh" init

To verify, git show --stat HEAD lists everything the install brought in. Run the commands init prints to finish the setup.

To uninstall, sh "$cw/package/bin/checkwright.sh" uninstall reverses it in one commit. If $cw is gone, download any release, as Managing says.

Windows

Download the release, in PowerShell. Each block here stops at its first error, then puts your session’s preferences back:

. {
  $keep = $ErrorActionPreference, $ProgressPreference
  try {
    $ErrorActionPreference = 'Stop'
    $ProgressPreference = 'SilentlyContinue'
    $v = 'X.Y.Z'
    $cw = Join-Path ([IO.Path]::GetTempPath()) ([IO.Path]::GetRandomFileName())
    New-Item -ItemType Directory $cw | Out-Null
    $url = "https://github.com/checkwright/checkwright/releases/download/v$v/checkwright-$v.tgz"
    Invoke-WebRequest $url -OutFile "$cw\checkwright-$v.tgz" -UseBasicParsing
    Invoke-WebRequest "$url.sha256" -OutFile "$cw\checkwright-$v.tgz.sha256" -UseBasicParsing
  } finally { $ErrorActionPreference, $ProgressPreference = $keep }
}

Check the attestation as on macOS and Linux:

gh attestation verify "$cw\checkwright-$v.tgz" --repo checkwright/checkwright --source-ref "refs/tags/v$v"

Then check the digest, unpack, and run init, still from your repository root:

. {
  $keep = $ErrorActionPreference
  try {
    $ErrorActionPreference = 'Stop'
    $want = (Get-Content -Raw "$cw\checkwright-$v.tgz.sha256").Split(' ')[0]
    if ((Get-FileHash "$cw\checkwright-$v.tgz" -Algorithm SHA256).Hash -ne $want) { throw 'checksum mismatch: download both files again' }
    & "$env:SystemRoot\System32\tar.exe" -xzf "$cw\checkwright-$v.tgz" -C $cw
    if ($LASTEXITCODE -ne 0) { throw 'tar.exe could not unpack the tarball: download it again' }
    powershell -NoProfile -ExecutionPolicy Bypass -File "$cw\package\bin\checkwright.ps1" init
  } finally { $ErrorActionPreference = $keep }
}

Verify as above. To uninstall, run the init line with uninstall in place of init.