2026-10-17 12:08:30 -05:00
---
title: "Install"
2026-10-20 13:51:34 -05:00
summary: "Install luxe, check your setup, and pick a font."
2026-10-17 12:08:30 -05:00
order: 1
group: "Get started"
---
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.
2026-10-17 15:37:45 -05:00
## 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` :
2026-10-17 12:08:30 -05:00
```bash
Luxe installs with curl -fsSL https://luxe.dev/install.sh | sh, edits keep a file's permissions, and the tools page charts every agent by name
- luxe.dev/install.sh redirects to the latest release's installer, and luxe.dev/install.ps1 runs
the release's PowerShell installer under Windows' default policy, so the commands are
`curl -fsSL https://luxe.dev/install.sh | sh` and `powershell -c "irm https://luxe.dev/install.ps1 | iex"`.
The install tabs run shell, brew, cargo, then windows.
- The edit and write tools and format-on-save keep a file's mode, so editing a script no longer
leaves it unrunnable.
- The tools page gives Claude Code and Codex their own columns and bars, draws Luxe's own bar in
each group, and its terminal's window controls take macOS's colors.
- scripts/aur-pkgbuild.sh writes a luxe-bin PKGBUILD from a release, for the AUR once it reopens.
2026-10-17 20:05:01 -05:00
curl -fsSL https://luxe.dev/install.sh | sh
2026-10-17 12:08:30 -05:00
```
Luxe installs with curl -fsSL https://luxe.dev/install.sh | sh, edits keep a file's permissions, and the tools page charts every agent by name
- luxe.dev/install.sh redirects to the latest release's installer, and luxe.dev/install.ps1 runs
the release's PowerShell installer under Windows' default policy, so the commands are
`curl -fsSL https://luxe.dev/install.sh | sh` and `powershell -c "irm https://luxe.dev/install.ps1 | iex"`.
The install tabs run shell, brew, cargo, then windows.
- The edit and write tools and format-on-save keep a file's mode, so editing a script no longer
leaves it unrunnable.
- The tools page gives Claude Code and Codex their own columns and bars, draws Luxe's own bar in
each group, and its terminal's window controls take macOS's colors.
- scripts/aur-pkgbuild.sh writes a luxe-bin PKGBUILD from a release, for the AUR once it reopens.
2026-10-17 20:05:01 -05:00
That address redirects to the script on the [latest
release](https://github.com/evanwhittaker/luxe/releases/latest), the one it built and attested. To
read it before running it, drop the `| sh` .
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.
2026-10-17 15:37:45 -05:00
With Homebrew, on macOS or Linux:
```bash
brew install evanwhittaker/tap/luxe
```
2026-10-20 13:51:34 -05:00
Homebrew finishes with a line that names the installed version; run `luxe --version`
to check. Since Homebrew 6, a tap has to be trusted before its code runs. The full name above
trusts luxe's formula for you, but Homebrew can still stop on * another * tap you already have. If it
names one, trust it with `brew trust <user>/<repository>` , or remove it with `brew untap` .
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.
2026-10-17 15:37:45 -05:00
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
```
Luxe installs with curl -fsSL https://luxe.dev/install.sh | sh, edits keep a file's permissions, and the tools page charts every agent by name
- luxe.dev/install.sh redirects to the latest release's installer, and luxe.dev/install.ps1 runs
the release's PowerShell installer under Windows' default policy, so the commands are
`curl -fsSL https://luxe.dev/install.sh | sh` and `powershell -c "irm https://luxe.dev/install.ps1 | iex"`.
The install tabs run shell, brew, cargo, then windows.
- The edit and write tools and format-on-save keep a file's mode, so editing a script no longer
leaves it unrunnable.
- The tools page gives Claude Code and Codex their own columns and bars, draws Luxe's own bar in
each group, and its terminal's window controls take macOS's colors.
- scripts/aur-pkgbuild.sh writes a luxe-bin PKGBUILD from a release, for the AUR once it reopens.
2026-10-17 20:05:01 -05:00
On Windows, in PowerShell:
```powershell
powershell -c "irm https://luxe.dev/install.ps1 | iex"
```
[That script ](https://luxe.dev/install.ps1 ) is two lines: it lets this PowerShell window run the
release's installer, which Windows' default execution policy would stop, then runs it. Nothing
about your policy is saved.
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.
2026-10-17 15:37:45 -05:00
Any of them installs the `luxe` command; `luxe --version` checks it worked.
2026-10-17 12:08:30 -05:00
2026-10-20 13:51:34 -05:00
To update, run `luxe update` , or `/update` inside luxe. luxe checks once a day for a newer release
luxe update and /update, editable question answers, and a version bump owed once per release
- luxe update and /update update Luxe with the command for however it was installed (cargo or
Homebrew), run one program at a time with the terminal attached, then check that the luxe on
PATH is the new version. Luxe never downloads or replaces its own binary. The start screen says
"Update available · /update".
- A question's typed answer edits at its caret: arrows, word jumps, Home, End and Delete work,
and up and down move through a wrapped answer before leaving it.
- The version check owes a bump once per release: the version on main is the next release, and
only a released one (a v-tag) has to move.
- Dependency updates arrive through the sync, so Dependabot and the weekly jobs no longer run here.
2026-10-17 14:14:27 -05:00
and says so on the start screen; see [Updates ](configuration.md#updates ) for how it updates and how
to turn the check off.
2026-10-17 12:08:30 -05:00
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.
2026-10-17 15:37:45 -05:00
### 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
```
2026-10-17 12:08:30 -05:00
## Build from source
```bash
git clone https://github.com/evanwhittaker/luxe.git
cd luxe
cargo build --release
./target/release/luxe --version
```
## Requirements
2026-10-20 13:51:34 -05:00
luxe runs natively on Linux, macOS and Windows. Only a terminal and a model are required.
2026-10-17 12:08:30 -05:00
| | |
| --- | --- |
| **Terminal ** | Any current terminal with UTF-8. On Windows, use Windows Terminal. |
| **Model ** | An API key, a ChatGPT, Copilot or OpenRouter subscription, or a local server such as LM Studio or Ollama. See [Providers ](providers.md ). |
2026-10-20 13:51:34 -05:00
| **Git ** | For reviewing changes and working in worktrees. Without a repository, luxe runs with nothing to review. |
2026-10-17 12:08:30 -05:00
| **GitHub CLI ** | Optional. `gh` , signed in, for issues and pull requests. |
| **A Nerd Font ** | Optional, for icons. See [Fonts ](#fonts ). |
2026-10-20 13:51:34 -05:00
luxe also uses these when they are installed:
2026-10-17 12:08:30 -05:00
- `ast-grep` , for structural search.
- A language server per language, for code intelligence. See [Code
intelligence](tools.md#code -intelligence).
- A debug adapter per language, for the debugger. See [Debugger ](tools.md#debugger ).
## Check your setup
```bash
luxe doctor
```
2026-10-20 13:51:34 -05:00
`luxe doctor` lists the tools, language servers and debug adapters luxe found, which ones work, and
2026-10-17 12:08:30 -05:00
how to install what is missing:
```
External programs
ok git git
ok gh git (pull requests)
Language servers
ok rust rust-analyzer
none go tried: gopls
go install golang.org/x/tools/gopls@latest
```
## Fonts
2026-10-20 13:51:34 -05:00
luxe draws its icons from a [Nerd Font ](https://www.nerdfonts.com/ ) when your terminal has one.
2026-10-17 12:08:30 -05:00
Without one, it falls back to plain characters on its own, and every icon has a word beside it, so
nothing becomes unreadable.
The screenshots use **JetBrains Mono Nerd Font Mono ** :
```bash
brew install --cask font-jetbrains-mono-nerd-font # macOS
sudo pacman -S ttf-jetbrains-mono-nerd # Arch
scoop install nerd-fonts/JetBrainsMono-NF-Mono # Windows, after `scoop bucket add nerd-fonts`
```
Use the **Mono ** build of a Nerd Font. The other build draws icons wider than one cell, so they
overlap the character after them. Set it in your terminal by its short family name:
```toml title="alacritty.toml"
[font]
normal = { family = "JetBrainsMono NFM" }
```
The short name matters on Linux desktops that pick their monospace font with a fontconfig rule,
such as Omarchy. Asking for the full name, `JetBrainsMono Nerd Font Mono` , can hand you the
desktop's font instead. To check what a name resolves to:
```bash
fc-match -f '%{file}\n' "JetBrainsMono NFM"
```
2026-10-20 13:51:34 -05:00
JetBrains Mono lacks six symbols luxe draws (`ℹ ︎ ↳︎ ↺︎ ⏸︎ ✔︎ ✖︎` ), and your system fills them in
2026-10-17 12:08:30 -05:00
from another font. For every character from one face, use **IosevkaTerm ** or **Adwaita Mono ** :
```bash
brew install --cask font-iosevka-term-nerd-font # "IosevkaTerm NFM"
brew install --cask font-adwaita-mono-nerd-font # "AdwaitaMono Nerd Font Mono"
sudo pacman -S ttf-iosevka-nerd ttf-adwaitamono-nerd
scoop install nerd-fonts/IosevkaTerm-NF-Mono nerd-fonts/AdwaitaMono-NF-Mono
```
To use the wider icons anyway, set `"glyphs": "nerd_wide"` in
2026-10-20 13:51:34 -05:00
[`config.json` ](configuration.md ), and luxe gives each icon two cells.
2026-10-17 12:08:30 -05:00
## On Windows
2026-10-20 13:51:34 -05:00
Install [Git for Windows ](https://gitforwindows.org/ ). luxe finds its `bash` even though it is not
2026-10-17 12:08:30 -05:00
on `PATH` , and the agent needs a POSIX shell for most commands. Without one, commands run through
`cmd.exe` , which handles `cargo test` or `npm run build` but not much else.
2026-10-20 13:51:34 -05:00
If WSL is installed, luxe skips the `bash.exe` in `System32` , which would run commands inside Linux
2026-10-17 12:08:30 -05:00
against a different filesystem.
2026-10-18 15:04:51 -05:00
Python on Windows is `py` or `python` . `python3` is usually the Microsoft Store's placeholder, so
2026-10-20 13:51:34 -05:00
luxe tries `py -3` first. For the Python debugger, run `py -m pip install debugpy` . The agent's
2026-10-18 15:04:51 -05:00
commands run Python in UTF-8 mode (`PYTHONUTF8=1` ) unless you have set it yourself, so output with
characters outside your code page doesn't crash them.
2026-10-20 13:51:34 -05:00
Windows Terminal keeps a column at the right edge for its scrollbar. To give it to luxe, set
2026-10-18 15:04:51 -05:00
**Scrollbar visibility** to **Hidden ** in your profile's **Appearance ** settings.
2026-10-20 13:51:34 -05:00
## Where luxe keeps files
2026-10-17 12:08:30 -05:00
| | Linux and macOS | Windows |
| --- | --- | --- |
| Configuration and credentials | `~/.config/luxe` | `%APPDATA%\luxe` |
| State | `~/.local/state/luxe` | `%LOCALAPPDATA%\luxe` |
| Cache | `~/.cache/luxe` | `%LOCALAPPDATA%\luxe` |
An `XDG_CONFIG_HOME` , `XDG_STATE_HOME` or `XDG_CACHE_HOME` you have set wins on every platform.
`LUXE_CONFIG_DIR` moves every configuration file, API key and provider sign-in. `LUXE_STATE_DIR`
2026-10-20 13:51:34 -05:00
moves the state luxe keeps for you: the model you last chose, MCP sign-ins, and the logs of
2026-10-17 12:08:30 -05:00
commands that only report, such as `luxe auth` .
2026-10-20 13:51:34 -05:00
Inside a project, luxe keeps its sessions, logs and caches in `.luxe/` , with a `.gitignore` that
2026-10-17 12:08:30 -05:00
keeps all of it out of Git except the files a team may want to share: `permissions.json` ,
`mcp.json` , `hooks.json` and `skills/` .