A v-tag releases Luxe with installers, Homebrew and crates.io, SECURITY.md says how to report a hole, and luxe update runs the installer's updater

- release.yml, generated by dist from dist-workspace.toml, builds macOS, Linux and Windows,
  attests every artifact, and publishes shell and PowerShell installers with their updater,
  a luxe formula in evanwhittaker/homebrew-tap, and the crates through Trusted Publishing
  (publish-crates.yml, which skips versions crates.io already has).
- luxe update recognizes an installer copy by luxe-cli-update beside it and runs that.
- The README, the install guide and the site lead with the installer, Homebrew and Windows.
- SECURITY.md: report privately through a GitHub advisory or contact@luxe.dev.
This commit is contained in:
Evan Whittaker
2026-10-17 15:37:45 -05:00
parent 0c0df734c1
commit 846a413a4d
22 changed files with 729 additions and 67 deletions

View File

@@ -5,20 +5,49 @@ order: 1
group: "Get started"
---
## Install with Cargo
## Install
On macOS and Linux, the install script puts `luxe` in `~/.local/bin`, or in `$LUXE_INSTALL_DIR`
when it is set, and adds that to your `PATH`:
```bash
cargo install luxe-cli
luxe --version
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.sh | sh
```
This installs the `luxe` command. You need a recent stable Rust; [rustup](https://rustup.rs)
installs one.
On Windows, in PowerShell:
```powershell
powershell -ExecutionPolicy Bypass -c "irm https://github.com/evanwhittaker/luxe/releases/latest/download/luxe-cli-installer.ps1 | iex"
```
With Homebrew, on macOS or Linux:
```bash
brew install evanwhittaker/tap/luxe
```
With Cargo, which builds it, so you need Rust 1.89 or newer ([rustup](https://rustup.rs) installs
one):
```bash
cargo install --locked luxe-cli
```
Any of them installs the `luxe` command; `luxe --version` checks it worked.
To update, run `luxe update`, or `/update` inside Luxe. Luxe checks once a day for a newer release
and says so on the start screen; see [Updates](configuration.md#updates) for how it updates and how
to turn the check off.
### Check a download
Every file on a release carries a build attestation, so you can confirm it came from this
repository's release workflow and nowhere else:
```bash
gh attestation verify luxe-cli-x86_64-unknown-linux-gnu.tar.xz --repo evanwhittaker/luxe
```
## Build from source
```bash