N
Nyxis
getting started

Introduction

The component toolkit for AI products.

Nyxis is a toolkit for building AI products. Chat, agents, RAG, MCP, tools, multimodal, prompt tooling, evaluation, skills — the patterns the community keeps re-implementing. It’s built on top of shadcn/ui and distributed through the standard shadcn CLI: every component is copy-paste source code that lands in your repo and is yours to edit.

What you get

  • 84+ AI-first components across chat, agents, RAG, MCP, tools, multimodal, prompts, skills, reasoning, AI animations, and dashboard patterns. All shadcn-style: Tailwind classes, Radix where it matters, no theming abstraction to fight.
  • @nyxis/core — a tiny npm package holding the shared types, the provider adapter, an event bus, and React hooks. The only piece of Nyxis that needs versioning.
  • nyxis-ui — a separate tiny npm package with the five-mode theme runtime (<ThemeToggle>, getThemeScript) and the design tokens stylesheet.
  • Provider-agnostic. Anthropic, OpenAI, Google, Mistral, Ollama out of the box; add your own with a single file.

Distribution model

Nyxis distributes through three layers, none subordinate to the others:

  1. @nyxis/core — npm package. Types, adapter, event bus, hooks.
  2. nyxis-ui — npm package. Theme tokens + theme runtime.
  3. Registrynpx shadcn@latest add @nyxis/<name>. UI you own.

You can install only the runtime, only the theme, only some components, or everything. The shadcn CLI resolves cascading dependencies so installing a complex item (say, agent-roster) pulls its sub-components (agent-card, agent-status-badge) and the utils lib in one shot.

The future (roadmap) adds backend recipes (route handlers, server helpers) to the registry, an MCP server that exposes the catalog to Claude Code / Cursor / Windsurf, and parallel registries for Vue / Svelte / Angular / Astro / FastAPI.

How the docs are organised

  • Getting started — installation, theming, registry usage.
  • AI categories — chat, reasoning, tools, MCP, agents, multimodal, prompts/eval, RAG, skills.
  • AI animations — motion primitives specific to AI products (sparkle fields, halo borders, neural backgrounds).
  • Domain patterns — purpose-built components for AI dashboards and operational workflows.

Use ⌘K (or Ctrl K) at any time to jump to a component.

Roadmap

PhaseStatus
1 — Frontend registryDone. This is what’s live.
2 — Backend recipes (route handlers, server helpers)Planned.
3 — Public provider extension APIPlanned.
4 — MCP server for IDE assistantsPlanned.
5+ — Vue / Svelte / Angular / Astro / FastAPI registriesPlanned.