passkey-creator 1.0.0

package/README.md

@@ -0,0 +1,60 @@
+
+# Password Creator CLI
+
+This is a simple CLI tool that generates a random password based on user inputs, 
+such as the desired length and the inclusion of lowercase letters, uppercase letters, numbers, and symbols. 
+It uses `inquirer`, `chalk`, and `gradient-string` to provide a rich user interface and a customizable password.
+
+## Table of Contents
+1. [Installation](#installation)
+2. [Usage](#usage)
+3. [Tip](#Tip)
+3. [Features](#features)
+4. [Dependencies](#dependencies)
+5. [License](#license)
+
+## Installation
+
+1. Install the cli tool by running:
+   ```bash
+   npm install -g passkey-creator
+   ```
+
+## Usage
+
+To run the password generator, open the terminal and execute the following command:
+
+```bash
+create-key
+```
+
+You'll be prompted with a series of questions asking about the length of the password and which types of characters to include.
+
+
+## Tip 
+
+- I know that writing this big command is not affordable for your fingers. So to shorten this command follow these steps :-
+
+1. Open bash
+2. Type the command :
+
+```bash
+alias key="create-key"
+```
+This will save you some keystrokes. Note that this alias will only persist for the current terminal session. To make it permanent, add the alias to your .bashrc or .zshrc file.
+
+## Features
+
+- **Customizable Password Length**: You can define the length of the generated password.
+- **Character Type Options**: Choose whether to include lowercase letters, uppercase letters, numbers, and symbols.
+- **Rich User Interface**: The CLI interface is styled using `chalk` and `gradient-string` for a smooth user experience.
+- **Easy-to-Use**: The CLI prompts make it easy to interact with and customize the password generation.
+
+## Dependencies
+
+- `inquirer`: For interactive CLI prompts.
+- `chalk`: For colorful terminal output.
+
+## License
+
+This project is licensed under the [ISC License](https://opensource.org/licenses/ISC).

package/index.js

@@ -0,0 +1,108 @@
+#!/usr/bin/env node
+
+import inquirer from "inquirer";
+import chalk from "chalk";
+
+// Color definitions
+const warningColor = chalk.hex("#FF6F20"); // Warning color
+const successColor = chalk.hex("#B2E2D9");  // Success color
+const neutralColor = chalk.hex("#E6F9E9");  // Neutral color
+const promptColor = chalk.hex("#E0F7FA");   // Prompt color
+const infoColor = chalk.hex("#B3D3E3");     // Info color
+const dangerColor = chalk.hex("#DC143C");   // Danger color
+const bg = chalk.bgHex("#E0F7FA").hex("#2C3E50"); // Background color
+
+
+// Function to generate password
+function generatePassword(
+    length,
+    includeLowercase,
+    includeUppercase,
+    includeNumbers,
+    includesymbols
+) {
+    const lowercase = "abcdefghijklmnopqrstuvwxyz";
+    const uppercase = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    const number = "1234567890";
+    const symbols = "!@#$%^&*()_+";
+
+    let allowedchars = "";
+    let password = "";
+
+    allowedchars += includeLowercase ? lowercase : "";
+    allowedchars += includeUppercase ? uppercase : "";
+    allowedchars += includeNumbers ? number : "";
+    allowedchars += includesymbols ? symbols : "";
+
+    if (length < 1) {
+        return `(Length should not be less than 1)`;
+    }
+    if (allowedchars === "") {
+        return `(At least one character set must be selected)`;
+    } else {
+        for (let i = 0; i < length; i++) {
+            const random = Math.floor(Math.random() * allowedchars.length);
+            password += allowedchars[random];
+        }
+    }
+    return password;
+}
+
+// Main function to interact with the user and generate the password
+(async () => {
+    console.log(bg(`\nWelcome to the Password Generator!`));
+    console.log(infoColor("\nLet's customize your password options.\n"));
+
+    const { len } = await inquirer.prompt({
+        name: "len",
+        message: `${promptColor("Enter password length:")}`,
+        type: "input",
+        validate: (inp) => {
+            if (inp.trim() === "") return warningColor("Length is required.");
+            if (isNaN(inp) || parseInt(inp) < 1) return dangerColor("Enter a valid number greater than 0.");
+            return true;
+        }
+    });
+
+    const { lowcase } = await inquirer.prompt({
+        name: "lowcase",
+        message: `${promptColor("Include lowercase letters?")}`,
+        type: "list",
+        choices: ["Yes", "No"],
+    });
+
+    const { upcase } = await inquirer.prompt({
+        name: "upcase",
+        message: `${promptColor("Include uppercase letters?")}`,
+        type: "list",
+        choices: ["Yes", "No"],
+    });
+
+    const { symbols } = await inquirer.prompt({
+        name: "symbols",
+        message: `${promptColor("Include symbols?")}`,
+        type: "list",
+        choices: ["Yes", "No"],
+    });
+
+    const { numbers } = await inquirer.prompt({
+        name: "numbers",
+        message: `${promptColor("Include numbers?")}`,
+        type: "list",
+        choices: ["Yes", "No"],
+    });
+
+    const change = (val) => val === "Yes";
+
+    // Generate password based on user input
+    const password = generatePassword(
+        parseInt(len),
+        change(lowcase),
+        change(upcase),
+        change(numbers),
+        change(symbols)
+    );
+
+    console.log(successColor(`\nGenerated Password: `), neutralColor(password));
+
+})();

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "passkey-creator",
+  "version": "1.0.0",
+  "main": "index.js",
+  "type": "module",
+  "private":false,
+  "scripts": {
+    "start": "node ."
+  },
+  "bin": {
+    "create-key":"index.js"
+  },
+  "keywords": [
+    "password",
+    "security",
+    "cli",
+    "password-generator"
+  ],
+  "author": "Massachusetts",
+  "license": "ISC",
+  "description": "A CLI tool to generate strong and customizable passwords!",
+
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "inquirer": "^11.0.2"
+  }
+}