Luxe

Overview

What Luxe is, and where to find what you need.

View as Markdown

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

ToRead
Connect a model, or switch between themModels and providers
Find your way around the screenThe interface
Find a command or a key, or rebind oneCommands and keys
Point the agent at a file, issue or skillMentions
Review what the agent changedGuided Review
Work from an issue, open or merge a pull requestGit and GitHub
Resume a session, or see what fills the contextSessions and context
See what the agent can useTools
Let the agent work through a plan on its ownAutonomous runs
Change the theme, keys or statuslineConfiguration
Give the agent your project’s conventionsProject context
Add tools, skills or your own commandsExtending Luxe, Recipes
Control what the agent may doSecurity and permissions
Look up a command, flag or environment variableCommand line, Environment variables
Fix something that is not workingTroubleshooting

Help

  • Help (/help) lists every key for the screen you are on, with any you have rebound.
  • luxe doctor checks 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.