Quickstart.
You have installed Nilux. This page walks through a first session: asking, reviewing changes and approving commands.
Ask in plain words
Start nilux in your project folder and describe the task the way you would to a colleague. You do not need to name files or commands. Nilux looks through the project by itself.
bash❯find every TODO in the auth module and group them by file
While it works, you see each step it takes on its own line: which files it read, what it searched for, which commands it ran.
Check changes before they are made
When Nilux wants to change a file, it shows you the change first (added lines in green, removed lines in red) and waits for your answer:
bash❯add rate limiting to the login endpointDo you want to proceed?> 1. Yes2. Yes, always allow edit operations3. No, let me provide different instructions4. Send feedback
- Yes makes this one change.
- Yes, always allow… makes it, and stops asking about the same thing in this project: changes in that folder, or that command.
- No skips this step. Nilux goes on with the rest of the task, or asks what you would prefer. To stop everything, press
Esc. - Send feedback skips this step and tells Nilux, in your own words, what to do instead.
Commands such as npm test are approved the same way. Nilux also writes one line saying why it wants to run the command and whether it changes anything.
Tired of approving every step? Press Shift+Tab to switch to a mode that asks less. Permission modes explains each mode.
Stop or correct it at any time
- Press
Escto stop Nilux in the middle of a task. What it has done so far stays. - Type a new message while it is working. It reads the message as soon as it can.
- Press
Esctwice on an empty prompt to go back to an earlier message and undo what happened after it. See Sessions and context.
Commands worth knowing
Type / at the prompt to see the full list. The ones you will use most:
/resume: continue an earlier conversation./compact: shorten a long conversation so you can keep going./clear: start a new conversation./model: switch the model./config: settings such as the language of the replies./help: all commands.
Press Ctrl+C twice to quit.
What next
- Write a
nilux.mdso Nilux knows your project from the start: Project instructions. - Every command and key: CLI reference.
- Connect other tools and services: MCP servers.