Niluxv1.0.11
/get-started

Quickstart

You've installed Nilux. Now let's do something useful with it.

Start a session

Open any project directory and run nilux:

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

Nilux scans the project structure, picks up any nilux.md instructions, and opens an interactive session. You're talking to an agent that can read, edit, search, and run commands in your project.

Ask it something

Type a natural-language prompt. Nilux figures out which tools to use:

bash
❯find all TODO comments and group them by file
> grep · found 12 matches in 5 files
src/auth/login.ts
  L14: TODO — add rate limiting
  L89: TODO — refresh token rotation
src/api/upload.ts
  L7:  TODO — validate file size
  L33: TODO — add progress callback

Let it edit code

Nilux can read, edit, and create files. Before applying changes, it shows a diff and asks for approval:

bash
❯add rate limiting to the login endpoint
> read src/auth/login.ts
> edit src/auth/login.ts
+ import { rateLimit } from '../middleware/rate-limit'
+ const limiter = rateLimit({ window: 60, max: 5 })
Edit file? Proceed?
  1. Yes
  2. Yes, and don't ask again for this file
  3. No, let me provide different instructions
✓ applied · 1 file · 2 lines added

Run commands

Nilux can run shell commands and read the output. It asks for approval before executing anything:

bash
❯run the tests for the auth module
> bash: pnpm test src/auth/
Run command? Proceed?
  1. Yes
  2. Yes, and allow similar commands
  3. No
PASS src/auth/login.test.ts
PASS src/auth/register.test.ts
✓ 2 suites · 18 tests · all passed
TIP

You can save approval rules so Nilux doesn't ask again for similar operations. Option 2 in the approval menu creates a persistent allow-rule in .nilux/settings.json.

Slash commands

Nilux supports built-in commands you can type during a session:

  • /model — switch between Standard and Pro
  • /compact — summarize the conversation to free up context
  • /clear — reset the conversation and start fresh
  • /balance — check your current credit balance
  • /mcp — manage MCP server connections

What's next

Now that you've seen the basics:

  • Set up nilux.md for your project — see Configuration
  • Explore the full list of Tools
  • Connect external services via MCP
← Previous · Install NiluxNext · Configuration →