Luxe runs on Linux, macOS and Windows, in any UTF-8 terminal; on Windows, use Windows Terminal and
install [Git for Windows](https://gitforwindows.org/) so the agent has a POSIX shell. You also need
a model to talk to: an API key or a subscription. Your settings and credentials live in
`~/.config/luxe/` (`%APPDATA%\luxe` on Windows).
Icons come from a [Nerd Font](https://www.nerdfonts.com/) when you have one, in its **Mono** build;
without one, Luxe draws plain characters, and every icon has a word beside it. See
[Fonts](https://luxe.dev/docs/install/#fonts).
Luxe uses these when they are installed, and works without them:
| | For |
| --- | --- |
| Git | Reviewing changes, and worktrees |
| The GitHub CLI, `gh`, signed in | Issues and pull requests |
| A language server per language | Errors after each edit, definitions and references |
| A debug adapter per language | The `debug` tool |
| [ast-grep](https://ast-grep.github.io) | Search and replace by code structure |
`luxe doctor` checks which of them Luxe can use on your machine, and how to install the rest.
## Quickstart
1.**Start in your project, on a branch of its own.**
```bash
cd your-project
git switch -c my-change
luxe
```
`luxe --worktree` does the same in a worktree, so your checkout is never touched.
2.**Answer setup.** The first launch asks for a theme, a provider, which tools the agent can use,
and what Luxe opens on. Sign in with a subscription or paste an API key; a key already in your
environment, such as `ANTHROPIC_API_KEY`, is found on its own. Choose a model when the picker
opens.
3.**Ask for something.** Type it and press `enter`. Each step the agent takes appears as a card;
type while it works to steer it, and `ctrl+esc` stops the turn.
4.**Review it.** Press `ctrl+g`. When `review ready` shows, press it again: `space` steps through
the change, `c` comments on a line, `a` asks the agent about it.
5.**Ship it.**`alt+enter` finishes the review. Choose **Request fixes** to send your comments,
or, with the GitHub CLI signed in (`gh auth login`), **Open pull request**, drafted from the
review.
`luxe -c` picks up your last session. `ctrl+k` opens the Command Palette, `/help` lists every key
on the screen you are on, and `ctrl+c` quits; the session is already saved. The
[Quickstart](https://luxe.dev/docs/quickstart/) walks through the same steps with pictures.

## Documentation
The guide is at [luxe.dev/docs](https://luxe.dev/docs/), and built into Luxe for the version you
have: `luxe docs`, `luxe docs hooks`, `luxe docs --search "on_ask"`. Ask the agent how to do
something in Luxe and it reads the answer from the same pages.
| To | Read |
| --- | --- |
| Connect a model, or switch between them | [Models and providers](https://luxe.dev/docs/providers/) |
| Find your way around the screen | [The interface](https://luxe.dev/docs/interface/) |
| Find a command or a key, or rebind one | [Commands and keys](https://luxe.dev/docs/commands/) |
| Review what the agent changed | [Guided Review](https://luxe.dev/docs/guided-review/) |
| Work from an issue, open or merge a pull request | [Git and GitHub](https://luxe.dev/docs/github/) |
| Let the agent work through a plan on its own | [Autonomous runs](https://luxe.dev/docs/loop/) |
| See what the agent can use | [Tools](https://luxe.dev/docs/tools/) |
| Give the agent your project's conventions | [Project context](https://luxe.dev/docs/project-context/) |
| Change the theme, keys or statusline | [Configuration](https://luxe.dev/docs/configuration/) |
| Control what the agent may do | [Security and permissions](https://luxe.dev/docs/security/) |
| Add tools, skills, hooks or your own front end | [Extending Luxe](https://luxe.dev/docs/extending/) |
| Look up a flag or an environment variable | [Command line](https://luxe.dev/docs/cli/), [Environment variables](https://luxe.dev/docs/environment/) |
| Fix something that is not working | [Troubleshooting](https://luxe.dev/docs/troubleshooting/) |
Every page is also plain markdown in [`docs/guide/`](docs/guide/), and
[`llms.txt`](https://luxe.dev/llms.txt) lists them for an agent.
## Contributing
[`CONTRIBUTING.md`](CONTRIBUTING.md) has the gate, the architecture, the Windows checks and how
the site and the demos are made; [`AGENTS.md`](AGENTS.md) has the rules an agent working here holds
to. Problems and questions go to [GitHub issues](https://github.com/evanwhittaker/luxe/issues).