🔐 KeyLogin Setup CLI

📖 Table of Contents

• ✨ Features
• 🚀 Quick Start
• 🛠️ Local Development & Customization
• 📦 Supported Frameworks
• 🎨 Setup Types
• 🔧 Configuration
• 🤝 Contributing
• 📄 License

✨ Features

• Zero-config auto-detection – Automatically identifies your framework.
• Full UI or Headless – Choose a complete React dashboard or just the validation service.
• One-time use keys – Keys become invalid after first validation.
• Device fingerprinting – Prevents key sharing across unlimited devices.
• Session monitoring – Auto‑logout when license expires.
• Cross-platform – Works with React, Next.js, Vue, Express, Flask, Laravel, Spring Boot, Gin and more.
• Beautiful CLI output – Professional, clean, and branded terminal experience.

🚀 Quick Start

Run this single command in your project root:

npx keylogin-setup@latest

Open http://localhost:5173 and enter a valid license key generated from your KeyGen admin panel.

🛠️ Local Development & Customization

Want to modify the CLI or contribute? Clone and link locally:

# Clone the repository
git clone https://github.com/atanumaiti147/keylogin-setup.git
cd keylogin-setup

# Install dependencies
npm install

# Link globally for local testing
npm link

# Now you can run it anywhere
cd /path/to/your/project
keylogin-setup

After making changes, run npm link again to refresh the global symlink.

📦 Supported Frameworks

| Language | Framework | Auto‑detection | Full UI | |------------|----------------------|----------------|---------| | JavaScript | React (Vite / CRA) | ✅ | ✅ | | | Next.js | ✅ | — | | | Vue / Nuxt | ✅ | — | | | Express | ✅ | — | | | Node.js | ✅ | — | | Python | Flask | ✅ | — | | | Django | ✅ | — | | | FastAPI | ✅ | — | | PHP | Laravel | ✅ | — | | Ruby | Ruby on Rails | ✅ | — | | Java | Spring Boot | ✅ | — | | Go | Gin | ✅ | — |

💡 Full UI currently available for React only. For other frameworks, the CLI generates a headless validation service that you can integrate into your own UI.

🎨 Setup Types

Full UI Mode

Select Full UI during setup to get a production‑ready React dashboard with:

• Glassmorphism login page
• License key validation
• Protected dashboard
• Session timer & auto‑logout
• Fully responsive (mobile / tablet / desktop)

// After setup, your App.jsx is replaced with the KeyLogin dashboard.
// Original file backed up as App.jsx.backup.

Headless Mode

Choose Headless when you only need the validation function – perfect for:

• Discord / Telegram bots
• Desktop apps (Electron, Tauri)
• Game injectors / cheats
• CLI tools
• Backend services

The CLI creates only the service file (e.g., src/services/keyValidation.js). Import and use it anywhere:

import { validateKey } from './services/keyValidation';

const result = await validateKey('your-license-key');
if (result.valid) {
  // Grant access
}

🔧 Configuration

All configuration is handled automatically. The following environment variable is added to your .env file:

VITE_KEYLOGIN_API_URL=https://sctedved.qzz.io/api/validate-key

You can change the API endpoint by editing this variable (if you host your own KeyGen server).

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/amazing-feature
3. Make your changes and commit: git commit -m 'Add amazing feature'
4. Push to your fork: git push origin feature/amazing-feature
5. Open a Pull Request.

Adding a New Framework

To add support for a new framework:

1. Add the template in lib/setup.js → templates.
2. Add the output path in filePaths.
3. Update detector.js to auto-detect the framework.

📄 License

This project is licensed under the MIT License – see the LICENSE file for details.