Installation

Nilux AI is distributed as a global npm package. This guide covers installation on all supported platforms.

Requirements

Note: Nilux AI works on macOS, Linux, and Windows via WSL. Native Windows (without WSL) is not currently supported due to shell compatibility requirements.

Install via npm

npm install -g @nilux/ai

This installs the nilux command globally. After installation, verify it is available:

nilux --version

Expected output:

Nilux AI v1.0.0

Platform-Specific Notes

macOS

No additional setup required. The CLI uses your default shell (zsh or bash).

Linux

Ensure curl and git are installed, as the CLI may use them for certain operations:

sudo apt update && sudo apt install curl git -y   # Debian/Ubuntu
sudo dnf install curl git -y                        # Fedora

Windows (WSL)

1. Install WSL2 if you haven't already:

   wsl --install
   

2. Open a WSL terminal and follow the Linux instructions above
3. The nilux command will be available inside WSL

Upgrading

To upgrade to the latest version:

npm install -g @nilux/ai@latest

Uninstalling

npm uninstall -g @nilux/ai

This removes the CLI. Your configuration files in ~/.nilux/ are not deleted — you can remove them manually if desired.

Next Steps

Now that Nilux AI is installed, proceed to Quickstart to make your first request, or read Configuration to customize your setup.