Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 7 additions & 4 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ <h1 id="hero-title">Your agent writes the query. <span class="key">You hold the
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/locksql</span></code></pre>
<p class="install-note">Needs Docker. Then <code>lox add locksql</code> and <code>lox run</code>. The whole family: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
<span class="cmd">brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign</span></code></pre>
<p class="install-note">Needs Docker, <code>lox</code> v0.12.0+ and cosign v2.5.0+. Then <code>lox add locksql</code> and <code>lox run</code>. The whole family: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
</div>
<div class="actions">
<a class="button primary" href="install/">Install guide</a>
Expand Down
6 changes: 3 additions & 3 deletions site/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ <h2 id="homebrew">With Homebrew</h2>
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/locksql</span></code></pre>
<p class="install-note">Homebrew asks you to trust a third-party tap once. <code>brew install davidgodefroid/tap/lockfamily</code> installs the whole family instead.</p>
<span class="cmd">brew install davidgodefroid/tap/locksql davidgodefroid/tap/lox cosign</span></code></pre>
<p class="install-note">Homebrew asks you to trust a third-party tap once. locksql takes lockhub’s <code>lox</code> v0.12.0 or later and cosign v2.5.0 or later: <code>lox add</code> and <code>lox run</code> verify every image with cosign. <code>brew install davidgodefroid/tap/lockfamily</code> installs the whole family instead, <code>lox</code> and cosign included.</p>
</div>
<ol class="steps prose">
<li><p>In your project, <code>lox add locksql</code> asks where your database is. It writes the profile, wires your agent, runs <code>locksql doctor --fix</code>, shows a short review and starts the console.</p>
Expand All @@ -83,7 +83,7 @@ <h2 id="homebrew">With Homebrew</h2>

<section aria-labelledby="build">
<h2 id="build">Without Homebrew</h2>
<p class="prose">Download the install script from the release tag you install, read it, then run it with that release. It needs <a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a> on PATH and stops without it (<code>LOCKSQL_SKIP_COSIGN=1</code> installs unverified, and is read only when cosign is absent):</p>
<p class="prose">Download the install script from the release tag you install, read it, then run it with that release. It needs <a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a> v2.5.0 or later on PATH and stops without it (<code>LOCKSQL_SKIP_COSIGN=1</code> installs unverified, and is read only when cosign is absent):</p>
<pre tabindex="0"><code>V=vX.Y.Z
curl -fsSLO "https://raw.githubusercontent.com/DavidGodefroid/locksql/$V/scripts/install.sh"
less install.sh
Expand Down
Loading