Niral Extension
Connect VS Code or Cursor to the Niral platform: manage projects, sync design files, and generate code from your designs—all from the editor.
Features
- Dashboard – View and open your Niral projects from the sidebar
- Login – Sign in with your Niral account to access projects and APIs
- Add / Edit projects – Create new projects or edit existing ones (name, framework, options)
- Project details – Browse pages, manage design files (e.g. Figma), and trigger code generation
- API management – Configure and manage API specs for your projects
- Code generation – Generate React (or other) code from design pages and sync with your workspace
- Niral themes – Niral Light and Niral Dark themes for a consistent look
Getting Started
- Install the extension from the Marketplace or from a
.vsix file (Extensions → ... → Install from VSIX).
- Open the Command Palette (
Ctrl+Shift+P / Cmd+Shift+P) and run Niral: Login to sign in.
- Run Niral: Show Dashboard to open the dashboard and see your projects.
- Run Niral: Add Project to create a new project or open an existing one for editing.
Commands
| Command |
Description |
| Niral: Show Dashboard |
Open the Niral dashboard and project list |
| Niral: Login |
Sign in to your Niral account |
| Niral: Add Project |
Create a new project or edit an existing one |
You can run these from the Command Palette (Ctrl+Shift+P).
Configuration
Open File → Preferences → Settings (or Code → Settings on macOS) and search for Niral.
| Setting |
Description |
Default |
| Niral: Api Base Url |
Niral API server base URL |
http://localhost:3001 |
| Niral: Api Version |
API version path segment |
v1 |
| Niral: Niral Registry |
Registry URL for @niral scope (used when generating React projects; written to project .npmrc) |
http://npm.hakunamatatatech.io/ |
Ensure your Niral API server is running and reachable at the configured base URL.
Themes
The extension includes two editor themes:
- Niral Light – Light color scheme
- Niral Dark – Dark color scheme
To switch: File → Preferences → Color Theme (or Ctrl+K Ctrl+T / Cmd+K Cmd+T) and choose Niral Light or Niral Dark.
Requirements
- VS Code or Cursor version 1.74.0 or newer
License
MIT
| |