Neriov0.1.0-alpha.1
GitHub

Start

Getting started

Use Nerio through package entrypoints while building the foundation, or install editable source components into an application through the registry CLI.

Install

After the manually approved public alpha is available, install the packages needed by your application. No npm release exists while the package manifests remain private.

pnpm add @nerio-ui/tokens @nerio-ui/adapters @nerio-ui/uipnpm add tailwindcsspnpm add -D @tailwindcss/postcss postcss @nerio-ui/registry @nerio-ui/cli @nerio-ui/mcp
/* app/globals.css */@import "tailwindcss";@import "@nerio-ui/tokens/tailwind.css";@import "@nerio-ui/ui/styles.css";@source "../node_modules/@nerio-ui/ui/src";
import { Settings } from "@nerio-ui/adapters/icons";import { Alert, Card, Field, FormGroup, Table } from "@nerio-ui/ui";import { Button, Checkbox, Dialog, RadioGroup, Select, Switch, ToastProvider } from "@nerio-ui/ui/client";import "@nerio-ui/ui/styles.css";

@nerio-ui/ui is the server-safe entrypoint for static Core components and utilities, including Field and FormGroup. @nerio-ui/ui/client contains interactive Base UI-backed components such as Checkbox, RadioGroup, Switch, Select, and Dialog. @nerio-ui/ui/styles.css imports tokens, named keyframes, and the scoped no-Preflight compatibility rules; component visuals compile from their Tailwind recipes. Tailwind Preflight remains consumer-owned, and package source must be registered explicitly because Tailwind ignores node_modules by default. Adjust the @source path relative to your global stylesheet for other package-manager layouts.

Consumers may omit Preflight by importing only Tailwind's theme and utilities layers. Nerio's residual stylesheet remains limited to named keyframes plus scoped box-sizing and native-control typography compatibility for that mode; component visuals remain owned by static Tailwind recipes.

Import icons and icon types from @nerio-ui/adapters/icons. The adapter package has no aggregating root entrypoint: table, chart, form, and schema integrations use their dedicated subpaths and require only their matching optional peer.

Core packages ship TypeScript source. Add the Nerio packages used by your application to Next.js transpilePackages.

import type { NextConfig } from "next";const nextConfig: NextConfig = {  transpilePackages: ["@nerio-ui/adapters", "@nerio-ui/registry", "@nerio-ui/tokens", "@nerio-ui/ui"],};export default nextConfig;

Project shape

nerio initnerio listnerio info buttonnerio add button --dry-runnerio add buttonnerio doctor

The CLI writes editable source files into the consuming app. Use list and info to inspect registry contents, add --dry-run to preview files, and doctor to validate configuration. Tailwind-first source installs include styles/tailwind.css; import it from a Tailwind-processed global stylesheet alongside the installed token and residual styles.

Principles

  • Keep Core universal, source-first, and independent from Pro packages.
  • Use semantic and component tokens before product-specific CSS.
  • Keep interactive components in client boundaries.

Contributing and releases

Read the repository's contribution guide before proposing changes. Releases follow the manual release runbook; CI validates readiness but never publishes packages, creates tags, or creates GitHub Releases.