Niluxv1.0.33
/get-started

Install Nilux.

Nilux is an AI assistant for programming that works in your terminal. You tell it what you need in plain words. It reads your project, changes files and runs commands, and it asks you before anything that changes your files.

What you need

  • Node.js 20 or newer. Download it from nodejs.org. Not sure which version you have? Run node -v in a terminal.
  • On Windows, Git for Windows. Nilux runs its commands through Git Bash, which comes with Git for Windows. Without it Nilux will not start.
  • A Nilux account. If you do not have one yet, you create it in the browser the first time you start Nilux.

Install

Run this command in a terminal. It works the same on Windows, macOS and Linux:

bash
$npm install -g @nilux-ai/code

The package is called @nilux-ai/code, but the command you type afterwards is just nilux.

Start your first session

Go to your project folder in the terminal and run nilux:

bash
$cd ~/projects/my-app
$nilux

The first time, three things happen:

  1. Nilux asks if you trust this folder. Press y (Enter alone means no). Nilux only works in folders you have trusted. This protects you from projects that come with their own Nilux settings.
  2. Your browser opens to sign in. Sign in with Google, GitHub or your email, then confirm that this computer may use your account.
  3. You are back in the terminal, at a prompt where you type what you need. The Quickstart shows what to do next.
TIP

Give Nilux a short description of your project in a nilux.md file. It reads the file at the start of every session, so you do not have to explain the same things twice. See Project instructions.

Updating

When a new version is out, Nilux asks when it starts. You can update right away, start on the version you have, or skip that version. You can also update at any time:

bash
$nilux update

If you would rather have updates installed automatically, or never be asked, change Updates in /config. See Configuration.

Uninstall

bash
$npm uninstall -g @nilux-ai/code

Your settings and conversation history stay in the .nilux folder in your home folder. Delete that folder too if you want to remove everything.

Something not working? See Troubleshooting.

Next · Quickstart →