- luxe remote puts the sessions on your computer in reach of your own phone or tablet over Tailscale: write, steer, answer prompts, send photos, browse files, diffs and GitHub, with a paired device and your own Tailscale login. - luxe join lets another program on the same machine join a running session over the RPC protocol. - An AGENTS.md in a subfolder reaches the model the first time it works there. - Long sessions stay fast: no stall before each model call, lighter memory, cheaper drawing. - A session is open in one Luxe at a time, web_search shares results across its phrasings, and a grep glob starting with ! excludes. The CHANGELOG has the full list.
2.8 KiB
title, summary, order, group
| title | summary | order | group |
|---|---|---|---|
| Overview | What Luxe is, and where to find what you need. | 0 | Get started |
Luxe is a coding agent for your terminal. It works in your project with the model you choose, then walks you through what it changed so you can review it and open a pull request without leaving the terminal.
New to Luxe? Install it, then follow the Quickstart. The rest of the guide is reference, for when you need it.
Find what you need
| To | Read |
|---|---|
| Connect a model, or switch between them | Models and providers |
| Find your way around the screen | The interface |
| Find a command or a key, or rebind one | Commands and keys |
| Point the agent at a file, issue or skill | Mentions |
| Review what the agent changed | Guided Review |
| Work from an issue, open or merge a pull request | Git and GitHub |
| Resume a session, or see what fills the context | Sessions and context |
| See what the agent can use | Tools |
| Let the agent work through a plan on its own | Autonomous runs |
| Reach your sessions from your phone or tablet | Luxe on your phone |
| Change the theme, keys or statusline | Configuration |
| Give the agent your project's conventions | Project context |
| Add tools, skills or your own commands | Extending Luxe, Recipes |
| Control what the agent may do | Security and permissions |
| Look up a command, flag or environment variable | Command line, Environment variables |
| Fix something that is not working | Troubleshooting |
Help
- Help (
/help) lists every key for the screen you are on, with any you have rebound. luxe doctorchecks which language servers, debuggers and tools Luxe can use on your machine.- Troubleshooting covers common problems and how to report a bug.
- Problems and questions: GitHub issues.
Ask Luxe
This guide is built into Luxe, for the version you have installed. Ask the agent how to do something in Luxe, such as how do I add an MCP server?, and it reads the answer from the guide rather than guessing. You can read it yourself too:
luxe docs # every page
luxe docs hooks # one page
luxe docs --search "on_ask"
For agents
Every page is also plain markdown, at the same address with .md on the end:
https://luxe.dev/docs/install.md. llms.txt lists every page with a
one-line summary, and llms-full.txt is the whole guide in one
file. Inside Luxe, luxe docs serves the same pages offline.