Installation

Learn how to set up the Katlux Toolkit in your Nuxt 3 application. Choose between a basic quickstart or a complete, production-ready setup.

Create a new Nuxt 3 project using the official CLI:

Bash

npx nuxi@latest init my-katlux-app
cd my-katlux-app

Install the core Katlux package:

Bash

npm install @katlux/toolkit

TypeScript

export default defineNuxtConfig({
	modules: [
		'@katlux/toolkit'
	]
})

Use Katlux components globally in your Vue files:

Vue

<template lang="pug">
KButton(type="primary") Hello Katlux!
</template>

If you use AI coding assistants (like Cursor, GitHub Copilot, ChatGPT, or Gemini) to build your application, you can include the KATLUX_AI_REFERENCE.md file in your project root directory.

This document contains the authoritative reference rules, component APIs, data provider configurations, and development standards (like using Pug and custom templates). Providing this context to your AI assistant will ensure it writes correct, high-fidelity Katlux implementations out of the box.

Bash

# Download the AI Reference file to your repository root:
curl -sS "https://raw.githubusercontent.com/katlux-ui/KatluxShowcase/refs/heads/master/KATLUX_AI_REFERENCE.md" -o KATLUX_AI_REFERENCE.md