diff --git a/CHANGELOG.md b/CHANGELOG.md index b8126be..8884866 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -19,6 +19,10 @@ This file records the changes a user or an agent has to know about. longer name `lox attach` or a human decision for every ticket. Known gaps are filed: `locksql grant` through the host launcher (#250), warned reads auto-approved (#251, lockhub#224). +- The install docs and the site name everything locksql needs: `brew + install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign`, with + lockhub's `lox` v0.12.0 or later and cosign v2.5.0 or later (`lox add` and + `lox run` verify every image with cosign), as lockssh#44 does. ## v0.20.0 (2026-11-14) diff --git a/README.md b/README.md index 1d6f0eb..24aee02 100644 --- a/README.md +++ b/README.md @@ -58,15 +58,18 @@ In-agent approval is a convenience; a separate approval process is a boundary. ```sh brew trust davidgodefroid/tap -brew install davidgodefroid/tap/lox davidgodefroid/tap/locksql +brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign ``` locksql runs in Docker: Homebrew installs the `locksql` launcher, which runs -every command in the release's image. `lox` is lockhub's CLI. The whole -family instead: `brew install davidgodefroid/tap/lockfamily`. +every command in the release's image. It also takes lockhub's CLI `lox` +v0.12.0 or later and cosign v2.5.0 or later: `lox add` and `lox run` verify +every image with cosign. The whole family instead, `lox` and cosign included: +`brew install davidgodefroid/tap/lockfamily`. Without Homebrew, the install script of a release tag (it verifies the -release's cosign signatures, so it needs `cosign` on PATH): +release's cosign signatures, so it needs `cosign` v2.5.0 or later on PATH; +install lockhub's `lox` v0.12.0 or later beside it): ```sh V=vX.Y.Z diff --git a/docs/install.md b/docs/install.md index eff6194..c2c2d61 100644 --- a/docs/install.md +++ b/docs/install.md @@ -11,11 +11,14 @@ and where you decide each query. The shortest path is the Lock Family's: install it with Homebrew, then let [`lox add locksql`](https://github.com/DavidGodefroid/lockhub/blob/main/docs/lox-add.md) -ask where your database is and set up its lock, then start it with `lox run`: +ask where your database is and set up its lock, then start it with `lox run`. +locksql takes lockhub's `lox` v0.12.0 or later and cosign v2.5.0 or later +(`lox add` and `lox run` verify every image with cosign); the `lockfamily` +formula installs both, the `locksql` formula neither: ```sh brew trust davidgodefroid/tap # Homebrew asks you to trust a third-party tap once -brew install davidgodefroid/tap/lockfamily # or only this tool: brew install davidgodefroid/tap/locksql +brew install davidgodefroid/tap/lockfamily # or only this tool: brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign cd ~/projects # with lea: its projects directory; with claude: the project lox add locksql # asks about the database, sets up the lock lox run # a terminal of its own, outside the agent: starts the hub and the lock, approves @@ -93,12 +96,12 @@ trust a third-party tap before it loads its formulas), then install: ```sh brew trust davidgodefroid/tap -brew install davidgodefroid/tap/locksql # or davidgodefroid/tap/lockfamily for the whole family +brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign # or davidgodefroid/tap/lockfamily for the whole family ``` Otherwise, download the script from the release tag you install, read it, then run it. It needs [cosign](https://docs.sigstore.dev/cosign/system_config/installation/) -on PATH, and exits with `cosign is required…` without it (unless +v2.5.0 or later on PATH, and exits with `cosign is required…` without it (unless `LOCKSQL_SKIP_COSIGN=1`, which skips the checks only when cosign is absent): ```sh diff --git a/site/index.html b/site/index.html index c0f3b94..69ba88d 100644 --- a/site/index.html +++ b/site/index.html @@ -62,8 +62,8 @@

Your agent writes the query. You hold the
Install with Homebrew
brew trust davidgodefroid/tap
-brew install davidgodefroid/tap/lox davidgodefroid/tap/locksql
-

Needs Docker. Then lox add locksql and lox run. The whole family: brew install davidgodefroid/tap/lockfamily.

+brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign +

Needs Docker, lox v0.12.0+ and cosign v2.5.0+. Then lox add locksql and lox run. The whole family: brew install davidgodefroid/tap/lockfamily.

Install guide diff --git a/site/install/index.html b/site/install/index.html index 3df6945..1326fbe 100644 --- a/site/install/index.html +++ b/site/install/index.html @@ -65,8 +65,8 @@

With Homebrew

Install with Homebrew
brew trust davidgodefroid/tap
-brew install davidgodefroid/tap/lox davidgodefroid/tap/locksql
-

Homebrew asks you to trust a third-party tap once. brew install davidgodefroid/tap/lockfamily installs the whole family instead.

+brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign +

Homebrew asks you to trust a third-party tap once. locksql takes lockhub’s lox v0.12.0 or later and cosign v2.5.0 or later: lox add and lox run verify every image with cosign. brew install davidgodefroid/tap/lockfamily installs the whole family instead, lox and cosign included.

  1. In your project, lox add locksql asks where your database is. It writes the profile, wires your agent, runs locksql doctor --fix, shows a short review and starts the console.

    @@ -83,7 +83,7 @@

    With Homebrew

    Without Homebrew

    -

    Download the install script from the release tag you install, read it, then run it with that release. It needs cosign on PATH and stops without it (LOCKSQL_SKIP_COSIGN=1 installs unverified, and is read only when cosign is absent):

    +

    Download the install script from the release tag you install, read it, then run it with that release. It needs cosign v2.5.0 or later on PATH and stops without it (LOCKSQL_SKIP_COSIGN=1 installs unverified, and is read only when cosign is absent):

    V=vX.Y.Z
     curl -fsSLO "https://raw.githubusercontent.com/DavidGodefroid/locksql/$V/scripts/install.sh"
     less install.sh