@airuleshub/cli 1.0.0 → 1.0.4

package/README.md

@@ -1,8 +1,26 @@
 # @airuleshub/cli
 
-The official CLI tool for [Airuleshub](https://airuleshub.com) - The ultimate destination to find, share, and manage AI rules and instructions.
+**The CLI for AI-Native Development.**
 
-Easily fetch and install AI rules directly into your project with a single command.
+Fetch, manage, and share **Cursor Rules**, **Windsurf Instructions**, and **Copilot Guidelines** effortlessly.
+
+[![License: ISC](https://img.shields.io/badge/License-ISC-yellow.svg?style=flat-square)](https://opensource.org/licenses/ISC)
+
+---
+
+## 📚 Table of Contents
+
+- [Features](#-features)
+- [Installation](#-installation)
+- [Usage](#-usage)
+  - [Install Rules](#install-a-rule)
+  - [Interactive Mode](#interactive-mode)
+- [About AI Rules Hub](#-about-airuleshub)
+- [License](#-license)
+
+## 🌟 Introduction
+
+**@airuleshub/cli** connects your local development environment with the vast library of rules available on [airuleshub.com](https://airuleshub.com). Whether you are starting a new **Next.js** project, setting up a **React Native** app, or configuring **Supabase**, proper context is key for AI coding assistants. This CLI makes it instant.
 
 ## 🚀 Installation
 
@@ -20,11 +38,11 @@ npx @airuleshub/cli install <rule-slug>
 npm install -g @airuleshub/cli
 ```
 
-## 📖 Usage
+## � Usage
 
 ### Install a Rule
 
-To install a rule, simply run the `install` command followed by the rule's slug (ID).
+The primary command is `install`. It fetches the rule content and saves it to your project.
 
 ```bash
 airuleshub install <rule-slug>
@@ -38,22 +56,40 @@ airuleshub install nextjs-app-router-cursor-rules
 
 ### Options
 
-- **Format Selection**: The CLI will ask you to choose the file format (`.md` or `.txt`) if not specified.
-- **Overwrite Protection**: Warns you if the file already exists before overwriting.
+- **Format Selection (`-f, --format`)**: Choose between `.md` (Markdown) or `.txt` (Text).
+- **Overwrite Protection**: Safely checks if the file already exists before overwriting.
+
+### Interactive Mode
+
+You can also run the command without flags to use the interactive prompts:
+
+```bash
+npx @airuleshub/cli install <rule-slug>
+# ❓ Choose file format: Markdown (.md)
+# ❓ File already exists. Overwrite? (y/N)
+```
+
+## ❓ Why use this?
+
+Standardizing your AI context is critical for team consistency. Instead of copy-pasting `.cursorrules` files or prompts, use this CLI to pull the latest, verified versions.
 
 ## 🛠️ Features
 
-- ⚡ **Fast & Easy**: Install rules in seconds.
-- 📂 **Multi-format Support**: Save rules as Markdown or Text files.
-- 🤖 **Interactive**: User-friendly prompts for configuration.
-- 🔄 **Always Up-to-Date**: Fetches the latest version of the rule from Airuleshub.
+- ⚡ **Instant Setup**: Initialize Cursor rules in seconds without manual copy-pasting.
+- 📂 **Multi-Format Support**: Generate rules in `.md` (Markdown) or `.txt` formats compatible with various AI editors.
+- 🤖 **AI-Ready**: Optimized for Cursor, Windsurf, GitHub Copilot, and other AI coding assistants.
+- 🔄 **Always Current**: Fetch the latest community-verified rules directly from the AI Rules Hub registry.
+- 🛠️ **Developer Friendly**: Simple, intuitive CLI interface designed for modern web development workflows (Next.js, TypeScript, etc.).
 
 ## 👤 Author & Community
 
 Built with ❤️ by **Nikunj Borad**.
 
-- **GitHub**: [@nikunjborad123](https://github.com/nikunjborad123)
+Connect with the developer and the community:
+
+- 🐙 **GitHub**: [@nikunjborad123](https://github.com/nikunjborad123)
+- 🌐 **Website**: [AI Rules Hub.com](https://airuleshub.com)
 
 ## 📄 License
 
-This project is licensed under the ISC License.
+This project is licensed under the [ISC License](https://opensource.org/licenses/ISC).

package/dist/bin/airuleshub.js

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { Command } from "commander";
+import { installRule } from "../src/commands/install.js";
+const program = new Command();
+program.name("airuleshub").description("Install AI rules from airuleshub.com");
+program
+    .command("install <slug>")
+    .option("-f, --format <type>", "md or txt")
+    .action(installRule);
+program.parse();

package/dist/src/api/rules.js

@@ -0,0 +1,8 @@
+export async function fetchRule(slug) {
+    const BASE_URL = process.env.VITE_APP_URL || 'https://airuleshub.com';
+    const res = await fetch(`${BASE_URL}/api/rules/${slug}`);
+    if (!res.ok) {
+        throw new Error('Rule not found');
+    }
+    return res.json();
+}

package/dist/src/commands/install.js

@@ -0,0 +1,47 @@
+import fs from 'fs-extra';
+import inquirer from 'inquirer';
+import { fetchRule } from '../api/rules.js';
+import { writeRule, getRulePath } from '../fs/writer.js';
+export async function installRule(slug, options) {
+    try {
+        console.log(`📦 Installing rule: ${slug}`);
+        const rule = await fetchRule(slug);
+        const format = options.format
+            ? options.format
+            : (await inquirer.prompt([
+                {
+                    type: 'list',
+                    name: 'format',
+                    message: '📄 Choose file format:',
+                    choices: [
+                        { name: 'Markdown (.md)', value: 'md' },
+                        { name: 'Text (.txt)', value: 'txt' },
+                    ],
+                    default: 'md',
+                },
+            ])).format;
+        const filePath = getRulePath(slug, format);
+        if (await fs.pathExists(filePath)) {
+            const { overwrite } = await inquirer.prompt([
+                {
+                    type: 'confirm',
+                    name: 'overwrite',
+                    message: '⚠️ File already exists. Overwrite?',
+                    default: false,
+                },
+            ]);
+            if (!overwrite) {
+                console.log('❌ Installation cancelled.');
+                return;
+            }
+        }
+        await writeRule(rule, format ?? 'md');
+    }
+    catch (error) {
+        if (error.message?.includes('User force closed the prompt')) {
+            console.log('\n❌ Operation cancelled.');
+            process.exit(0);
+        }
+        throw error;
+    }
+}

package/dist/src/fs/writer.js

@@ -0,0 +1,14 @@
+import fs from 'fs-extra';
+import path from 'path';
+import { renderTemplate } from '../template.js';
+export const RULES_DIR = 'airules';
+export function getRulePath(slug, format) {
+    return path.join(process.cwd(), RULES_DIR, `${slug}.${format}`);
+}
+export async function writeRule(rule, format) {
+    const baseDir = path.join(process.cwd(), RULES_DIR);
+    await fs.ensureDir(baseDir);
+    const filePath = getRulePath(rule.slug, format);
+    await fs.writeFile(filePath, renderTemplate(rule));
+    console.log(`✅ Installed: ${RULES_DIR}/${rule.slug}.${format}`);
+}

package/dist/src/template.js

@@ -0,0 +1,11 @@
+export function renderTemplate(rule) {
+    return `
+# ${rule.title}
+
+Source: https://airuleshub.com/rules/${rule.slug}
+
+---
+
+${rule.content}
+`.trim();
+}

package/package.json

@@ -1,21 +1,45 @@
 {
   "name": "@airuleshub/cli",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "type": "module",
   "description": "",
   "main": "index.js",
   "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "bin": {
     "airuleshub": "./dist/bin/airuleshub.js"
   },
-  "keywords": [],
+  "keywords": [
+    "ai",
+    "cli",
+    "rules",
+    "cursor",
+    "cursor-rules",
+    "windsurf",
+    "copilot",
+    "automation",
+    "scaffolding",
+    "productivity",
+    "developer-tools",
+    "airuleshub"
+  ],
   "files": [
     "bin",
     "dist"
   ],
-  "author": "",
+  "author": "Nikunj Borad <boradnikunj2001@gmail.com> (https://github.com/nikunjborad123)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nikunjborad123/airuleshub.git",
+    "directory": "airuleshub-cli"
+  },
+  "homepage": "https://github.com/nikunjborad123/airuleshub/tree/master/airuleshub-cli#readme",
+  "bugs": {
+    "url": "https://github.com/nikunjborad123/airuleshub/issues"
+  },
   "license": "ISC",
   "dependencies": {
     "commander": "^14.0.3",