Niluxv1.0.11
/get-started

Install Nilux.

Nilux is a terminal-based AI assistant that runs in your project directory. It requires Node.js 18+ and installs as a single npm package.

Install

Install globally via npm:

bash
$npm install -g @nilux-ai/code
added 1 package in 3s
✓ ready
NOTE

In the future, npx @nilux-ai/code will work as a zero-install option that always fetches the latest version. For now, use the global install above.

Quickstart

Once installed, open any project directory and start a session:

bash
$cd ~/projects/my-app
$nilux
❯find every TODO in the auth module and group them by file

On first run, Nilux will:

  • Open your browser for a quick OAuth login (one-time setup)
  • Scan your project structure (3 levels deep) and send it as context
  • Pick up your nilux.md project instructions if present

Configuration

Nilux reads ~/.nilux/config.json for global defaults (auth tokens, model preferences, server URL). Per-project context goes into nilux.md in your repo root — checked into git, shared with your team.

markdown
# nilux.md — project context for the agent
Project uses Next.js 16 + tRPC + Prisma.
Do not modify files in billing/* without asking.
Always run tests after editing middleware.
NOTE

nilux.md content is sent to the server as part of the system prompt. It stays in your project directory but is included in every conversation as context.

Nilux also discovers rules in ~/.nilux/rules/*.md (global) and .nilux/rules/*.md (per-project). Use these for team-wide conventions.

Available models

Nilux supports several model tiers. You can switch models during a session:

  • Nilux Standard — balanced speed and quality, recommended for most tasks
  • Nilux Pro — deep reasoning for complex architecture and debugging

Upgrading

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

Uninstalling

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

Your configuration in ~/.nilux/ is not deleted — remove it manually if desired.

Next · Quickstart →