NLUX CLI

NPX command line interface of the NLUX AI UI library.

If you are looking for the main NLUX NPM development packages to import in your project, please check @nlux/core and @nlux/react.

NPX Commands

Create

Create an NLUX starter web project. The project will include NLUX example ready to use, and it will be setup with the framework or library of your choice.

npx nlux-cli create <project-type> [directory]

Options

• <project-type> — The type of project to create. Use one of:

  • nextjs — Next.js project with NLUX example.
  • react — React project running on Vite dev server, with NLUX example.
  • vanilla — Vanilla TypeScript project running on Vite dev server, with NLUX example.

• [directory] — The directory to create the project in.

Examples

Create a new Next.js project with NLUX example:

npx nlux-cli create nextjs myAiProject

Create a new React project with NLUX example:

npx nlux-cli create react myAiProject

Learn More

To learn more about NLUX, please visit: docs.nlkit.com/nlux