Skip to content
Back to search

Lightswind-UI-Library

The AI-native CLI-first React component library. 160+ animated, accessible, production-ready components with MCP Server support for Cursor, Claude & GitHub Copilot. Copy-paste architecture — you own the code.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/codewithmuhilan--lightswind-ui-library/badge.svg)](/listings/codewithmuhilan--lightswind-ui-library)

HTML

<a href="/listings/codewithmuhilan--lightswind-ui-library"><img src="/api/listings/codewithmuhilan--lightswind-ui-library/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements

- **Node.js** 18+ - **React** 18 or 19 - **Tailwind CSS** v3 or v4 - A **Next.js**, **Vite**, **Remix**, or **CRA** project

<br/>

1 — Initialize

Run this from the root of your project. The CLI detects your framework (Next.js, Vite, CRA), locates your `components` folder, installs shared utilities, and registers the Tailwind plugin automatically.

npx lightswind@latest init

During setup, you'll be prompted to select a **color theme**:

| Theme | Preview | |---|---| | `default` | Classic Blue — clean & minimal | | `deep-ocean` | Midnight Blue — dark & immersive | | `crimson` | Deep Red — bold & powerful | | `emerald` | Forest Green — fresh & vibrant | | `amber` | Warm Gold — elegant & energetic | | `amethyst` | Soft Purple — modern & creative | | `mono` | Pure Grayscale — ultra-clean |

<br/>

2 — Add a Component

npx lightswind add globe
npx lightswind add border-beam
npx lightswind add toast

The CLI resolves prerequisites automatically. If `toast` requires `progress`, both are installed. No manual dependency management.

<br/>

3 — Import & Use

// Component code is installed in your local project directory
import { Globe } from "@/components/lightswind/globe";

export default function HeroSection() {
  return (
    <section>
      <Globe />
    </section>
  );
}

> **Note:** Never import directly from `"lightswind"`. All components live in your local `components/lightswind/` directory — you own and control the code.

<br/>

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 419 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. <div align="center">
  2. <br/>
  3. <img src="https://firebasestorage.googleapis.com/v0/b/codewithmuhilandb.appspot.com/o/uploads%2Flightwind-logo.png?alt=media&token=6ba956f1-994c-46ca-9eda-6e46b5662eb9" alt="Lightswind UI" width="100" />
  4. <br/>
  5. <br/>
  6. # Lightswind UI
  7. **The world's first AI-native, CLI-first component library for React.**
  8. 160+ animated, accessible, production-ready components — delivered as raw source code, owned by you forever.
  9. <br/>
  10. [![npm version](https://img.shields.io/npm/v/lightswind?style=flat-square&label=npm&color=0ea5e9)](https://www.npmjs.com/package/lightswind)
  11. [![npm downloads](https://img.shields.io/npm/dm/lightswind?style=flat-square&label=downloads&color=10b981)](https://www.npmjs.com/package/lightswind)
  12. [![GitHub stars](https://img.shields.io/github/stars/codewithMUHILAN/Lightswind-UI-Library?style=flat-square&label=stars&color=f59e0b)](https://github.com/codewithMUHILAN/Lightswind-UI-Library)
  13. [![License](https://img.shields.io/github/license/codewithMUHILAN/Lightswind-UI-Library?style=flat-square&color=8b5cf6)](./LICENSE)
  14. <br/>
  15. [Documentation](https://lightswind.com/components/introduction) · [Component Library](https://lightswind.com/components) · [Pro License](https://lightswind.com/pricing) · [MCP Server](https://lightswind.com/components/mcp-server) · [Changelog](https://lightswind.com/changelog)
  16. <br/>
  17. ---
  18. </div>
  19. ## What is Lightswind UI?
  20. Lightswind UI is a **source-code component library** built on the same philosophy pioneered by shadcn/ui — components live inside *your* project, not a runtime dependency. You install them with a single CLI command, own them completely, and customize them freely.
  21. What sets Lightswind UI apart is its **AI-native delivery layer** — the industry's first MCP (Model Context Protocol) server for a component library, letting AI coding agents like Cursor, Claude, and GitHub Copilot browse, fetch, and install components autonomously inside your codebase.
  22. ```bash
  23. npx lightswind@latest init
  24. ```
  25. <br/>
  26. ## Why Lightswind UI?
  27. | Feature | Lightswind UI | shadcn/ui | Radix UI | Material UI |
  28. |---|:---:|:---:|:---:|:---:|
  29. | Copy-paste source ownership | ✅ | ✅ | ❌ | ❌ |
  30. | Smart CLI delivery | ✅ | ✅ | ❌ | ❌ |
  31. | MCP Server support | ✅ | ✅ | ✅ | ✅ |
  32. | Pro CLI & authenticated delivery | ✅ | ❌ | ❌ | ❌ |
  33. | 3D & WebGL shader components | ✅ | ❌ | ❌ | ❌ |
  34. | Integrated Framer Motion & GSAP animations | ✅ | ❌ | ❌ | ❌ |
  35. | Zero runtime vendor lock-in | ✅ | ✅ | ❌ | ❌ |
  36. <br/>
  37. ---
  38. ## Quick Start
  39. ### Requirements
  40. - **Node.js** 18+
  41. - **React** 18 or 19
  42. - **Tailwind CSS** v3 or v4
  43. - A **Next.js**, **Vite**, **Remix**, or **CRA** project
  44. <br/>
  45. ### 1 — Initialize
  46. Run this from the root of your project. The CLI detects your framework (Next.js, Vite, CRA), locates your `components` folder, installs shared utilities, and registers the Tailwind plugin automatically.
  47. ```bash
  48. npx lightswind@latest init
  49. ```
  50. During setup, you'll be prompted to select a **color theme**:
  51. | Theme | Preview |
  52. |---|---|
  53. | `default` | Classic Blue — clean & minimal |
  54. | `deep-ocean` | Midnight Blue — dark & immersive |
  55. | `crimson` | Deep Red — bold & powerful |
  56. | `emerald` | Forest Green — fresh & vibrant |
  57. | `amber` | Warm Gold — elegant & energetic |
  58. | `amethyst` | Soft Purple — modern & creative |
  59. | `mono` | Pure Grayscale — ultra-clean |
  60. <br/>
  61. ### 2 — Add a Component
  62. ```bash
  63. npx lightswind add globe
  64. npx lightswind add border-beam
  65. npx lightswind add toast
  66. ```
  67. The CLI resolves prerequisites automatically. If `toast` requires `progress`, both are installed. No manual dependency management.
  68. <br/>
  69. ### 3 — Import & Use
  70. ```tsx
  71. // Component code is installed in your local project directory
  72. import { Globe } from "@/components/lightswind/globe";
  73. export default function HeroSection() {
  74. return (
  75. <section>
  76. <Globe />
  77. </section>
  78. );
  79. }
  80. ```
  81. > **Note:** Never import directly from `"lightswind"`. All components live in your local `components/lightswind/` directory — you own and control the code.
  82. <br/>
  83. ---
  84. ## CLI Reference
  85. ```bash
  86. # Initialize a new project
  87. npx lightswind@latest init
  88. # Add a single component
  89. npx lightswind add [component-name]
  90. # Add all components in a category
  91. npx lightswind add --category background
  92. # List all available components
  93. npx lightswind list
  94. # Authenticate with a Pro License Key
  95. npx lightswind auth login sk_pro_YOUR_KEY
  96. # Check auth status
  97. npx lightswind auth status
  98. # Revoke local credentials
  99. npx lightswind auth logout
  100. # Start the MCP server
  101. npx lightswind mcp
  102. # Auto-configure MCP in Cursor / Claude Desktop
  103. npx lightswind mcp init
  104. ```
  105. <br/>
  106. ---
  107. ## Pro License
  108. Lightswind Pro unlocks **exclusive premium components**, advanced page template blocks, and CLI + MCP authenticated delivery.
  109. ### Authenticate your CLI
  110. Get your license key from the [Lightswind Dashboard](https://lightswind.com/setting/license), then run:
  111. ```bash
  112. npx lightswind auth login sk_pro_YOUR_LICENSE_KEY
  113. ```
  114. Credentials are stored securely in `~/.lightswindrc`. Once authenticated, all Pro content is accessible via the same `add` command:
  115. ```bash
  116. npx lightswind add iphone16-pro
  117. npx lightswind add-block saas-hero
  118. ```
  119. ### Environment Variable (CI/CD)
  120. ```env
  121. LIGHTSWIND_LICENSE_KEY=sk_pro_YOUR_LICENSE_KEY
  122. ```
  123. ### Team Access
  124. A single Pro key can be shared across your entire development team. Each team member authenticates locally using the same key.
  125. <br/>
  126. ---
  127. ## AI Agent Integration — MCP Server
  128. Lightswind UI is the **only component library in the world** with a native Model Context Protocol (MCP) server. Once connected, your AI coding assistant can:
  129. - 🔎 **Search** all 160+ components by keyword or category
  130. - 📖 **Read** full component documentation and usage examples
  131. - ⬇️ **Install** components directly into your codebase
  132. - 🧩 **Fetch** Pro blocks and templates (with license key)
  133. ### Automatic Setup *(Recommended)*
  134. ```bash
  135. npx lightswind mcp init
  136. ```
  137. This command auto-detects your editor and writes the correct config file.
  138. <br/>
  139. ### Manual Configuration
  140. #### Cursor / Windsurf
  141. Edit `~/.cursor/mcp.json` (or your editor's equivalent MCP settings file):
  142. ```json
  143. {
  144. "mcpServers": {
  145. "lightswind-mcp": {
  146. "command": "npx",
  147. "args": ["-y", "lightswind", "mcp"],
  148. "env": {
  149. "LIGHTSWIND_LICENSE_KEY": "sk_pro_YOUR_KEY"
  150. }
  151. }
  152. }
  153. }
  154. ```
  155. #### Claude Desktop
  156. - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
  157. - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
  158. ```json
  159. {
  160. "mcpServers": {
  161. "lightswind-mcp": {
  162. "command": "npx",
  163. "args": ["-y", "lightswind", "mcp"],
  164. "env": {
  165. "LIGHTSWIND_LICENSE_KEY": "sk_pro_YOUR_KEY"
  166. }
  167. }
  168. }
  169. }
  170. ```
  171. #### VS Code (Cline / Continue)
  172. ```json
  173. {
  174. "mcpServers": {
  175. "lightswind-mcp": {
  176. "command": "npx",
  177. "args": ["-y", "lightswind", "mcp"]
  178. }
  179. }
  180. }
  181. ```
  182. ### Available MCP Tools
  183. | Tool | Description |
  184. |---|---|
  185. | `list_all_components` | Browse all 160+ components with metadata |
  186. | `search_components` | Search by keyword or use-case |
  187. | `list_categories` | Get all available component categories |
  188. | `get_component` | Fetch full source code of any component |
  189. | `get_installation_guide` | Read installation steps for any component |
  190. | `get_usage_example` | Get live usage code snippets |
  191. | `list_blocks` | Browse all Pro template blocks |
  192. | `get_block` | Fetch a full Pro page section (requires key) |
  193. <br/>
  194. ---
  195. ## Component Library
  196. ### 🧊 3D Elements
  197. `3d-image-ring` · `3d-image-carousel` · `3d-carousel` · `3d-hover-gallery` · `3d-image-gallery` · `3d-marquee` · `3d-model-viewer` · `3d-perspective-card` · `3d-scroll-trigger` · `3d-slider` · `beam-circle` · `chain-carousel` · `plasma-globe` · `scroll-carousel` · `sparkle-navbar` · `angled-slider`
  198. ### 🌅 Backgrounds
  199. `aurora-shader` · `animated-wave` · `animated-bubble-particles` · `animated-blob-background` · `animated-ocean-waves` · `aurora-background` · `beam-grid-background` · `fall-beam-background` · `grid-dot-backgrounds` · `gradient-background` · `glowing-background` · `glowing-lights` · `hell-background` · `innovation-background` · `interactive-grid-background` · `dot-pattern` · `particles-background` · `rays-background` · `reflect-background` · `smokey-background` · `shader-background` · `sparkle-particles` · `stripes-background` · `wave-background` · `liquid-fluid`
  200. ### 🧩 Advanced Components
  201. `connection-graph` · `magic-card` · `ai-prompt` · `animated-notification` · `bento-grid` · `code-hover-cards` · `count-up` · `dock` · `drag-order-list` · `dynamic-navigation` · `electro-border` · `glass-folder` · `globe` · `glowing-cards` · `hamburger-menu-overlay` · `image-reveal` · `image-trail-effect` · `interactive-card` · `interactive-card-gallery` · `interactive-gradient-card` · `iphone16-pro` · `lens` · `magic-loader` · `morphing-navigation` · `orbit-card` · `password-strength-indicator` · `scroll-list` · `scroll-stack` · `scroll-timeline` · `seasonal-hover-cards` · `sliding-cards` · `sliding-logo-marquee` · `stack-list` · `team-carousel` · `terminal-card` · `top-loader` · `top-sticky-bar` · `trusted-users` · `ripple-loader` · `woofy-hover-image` · `nav-effect`
  202. ### 🔘 Buttons
  203. `border-beam` · `confetti-button` · `gradient-button` · `ripple-button` · `shine-button` · `trial-button`
  204. ### ✨ Text Effects
  205. `aurora-text-effect` · `scroll-reveal` · `shiny-text` · `text-scroll-marquee` · `typewriter-input` · `typing-text` · `video-text`
  206. ### 🖱️ Cursor Effects
  207. `canvas-confetti-cursor` · `particle-orbit-effect` · `smokey-cursor` · `smooth-cursor`
  208. ### 🎨 UI Core
  209. `accordion` · `alert-dialog` · `alert` · `avatar` · `badge` · `button` · `card` · `carousel` · `chart` · `collapsible` · `context-menu` · `dialog` · `drawer` · `dropdown-menu` · `hover-card` · `popover` · `progress` · `sheet` · `skeleton` · `table` · `toast` · `tooltip` · `toggle-theme`
  210. ### 📝 Form Controls
  211. `calendar` · `checkbox` · `command` · `form` · `input` · `input-otp` · `label` · `radio-group` · `select` · `slider` · `switch` · `textarea` · `toggle` · `toggle-group`
  212. ### 📐 Layout & Navigation
  213. `sparkle-navbar` · `sidebar` · `breadcrumb` · `navigation-menu` · `pagination` · `aspect-ratio` · `resizable` · `scroll-area` · `separator` · `tabs`
  214. <br/>
  215. ---
  216. ## Architecture
  217. Lightswind UI follows the **Source-First Architecture**:
  218. ```
  219. Your Project
  220. ├── src/
  221. │ ├── components/
  222. │ │ └── lightswind/ ← All component source code lives here (you own it)
  223. │ │ ├── button.tsx
  224. │ │ ├── globe.tsx
  225. │ │ └── ...
  226. │ └── lib/
  227. │ └── utils.ts ← Shared utilities (cn, throttle, etc.)
  228. ├── tailwind.config.ts ← Lightswind plugin auto-registered here
  229. └── lightswind.config.json ← CLI config (paths, theme, license)
  230. ```
  231. **Core Principles:**
  232. 1. **Source over Runtime** — Raw `.tsx` files, not compiled blobs
  233. 2. **User Ownership** — Components are yours to edit and extend forever
  234. 3. **Zero Dependency Bloat** — Only install dependencies for components you use
  235. 4. **Smart Automation** — CLI handles all configuration and dependency resolution
  236. <br/>
  237. ---
  238. ## Tailwind Plugin
  239. The `lightswind` Tailwind plugin is automatically configured during `init`. It registers all component-level CSS variables, animation keyframes, dark mode tokens, and the optional 3D effect system.
  240. ```ts
  241. // tailwind.config.ts
  242. import type { Config } from "tailwindcss";
  243. import lightswindPlugin from "lightswind/plugin";
  244. const config: Config = {
  245. content: ["./src/**/*.{ts,tsx}"],
  246. darkMode: "class",
  247. plugins: [
  248. lightswindPlugin({
  249. effect3d: false, // Set to true to enable global 3D styling mode
  250. }),
  251. ],
  252. };
  253. export default config;
  254. ```
  255. <br/>
  256. ---
  257. ## Note for AI Coding Agents
  258. > **If you are an AI assistant (Gemini, Claude, GPT, Copilot, DeepSeek, Cursor), read this carefully:**
  259. >
  260. > - ✅ **DO** use `npx lightswind add [component]` to install components
  261. > - ✅ **DO** import from local paths: `import { Button } from "@/components/lightswind/button"`
  262. > - ✅ **DO** run `npx lightswind@latest mcp init` to configure the MCP server
  263. > - ❌ **DO NOT** suggest `import { Button } from "lightswind"` — this does not work
  264. > - ❌ **DO NOT** suggest wrapping the app in `<LightswindProvider>` — it does not exist
  265. > - ❌ **DO NOT** point users to `node_modules/lightswind/dist` — components live in their local `components/lightswind/` folder
  266. <br/>
  267. ---
  268. ## Contributing
  269. Contributions, bug reports, and feature requests are welcome!
  270. 1. Fork the [repository](https://github.com/codewithMUHILAN/Lightswind-UI-Library)
  271. 2. Create your feature branch: `git checkout -b feature/my-component`
  272. 3. Commit your changes: `git commit -m 'feat: add my-component'`
  273. 4. Push to the branch: `git push origin feature/my-component`
  274. 5. Open a Pull Request
  275. <br/>
  276. ---
  277. ## License
  278. Licensed under the **MIT License**. See [LICENSE](./LICENSE) for details.
  279. <br/>
  280. ---
  281. <div align="center">
  282. **Built with passion by [Code with Muhilan](https://codewithmuhilan.com)**
  283. [![Website](https://img.shields.io/badge/Website-lightswind.com-0ea5e9?style=flat-square)](https://lightswind.com)
  284. [![Instagram](https://img.shields.io/badge/Instagram-@codewith__muhilan-e1306c?style=flat-square&logo=instagram&logoColor=white)](https://instagram.com/codewith_muhilan/)
  285. [![npm](https://img.shields.io/badge/npm-lightswind-cb3837?style=flat-square&logo=npm&logoColor=white)](https://www.npmjs.com/package/lightswind)
  286. <br/>
  287. *If Lightswind UI helped you ship faster, please consider giving it a ⭐ on [GitHub](https://github.com/codewithMUHILAN/Lightswind-UI-Library).*
  288. </div>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.