namastejs/README.md

A spiritual greeting from your JavaScript code. Because every function deserves a 'Namaste 🙏'

<p align="center">
  <img src="https://unpkg.com/namastejs@latest/src/assets/namastejs.jpg" alt="namastejs" height="400" width="100%"  />
</p>

## 📚 Table of Contents

- [What is namastejs?](#-what-is-namastejs)
- [Quick Start](#-quick-start)
- [Install](#-install-optional)
- [CLI Features](#-cli-features)
- [Vault Usage](#-vault-usage)
- [Setup Automation](#-setup-automation)
- [Contribution](#-️-contribution)

## ✨ What is `namastejs`?

A lightweight, fun, and powerful developer utility CLI. It started with a simple blessing and now supports real productivity tools like branch management, port killing, vault management, project cleaning, and more — all accessible via `npx`.

---


![npm version](https://img.shields.io/npm/v/namastejs)
![npm downloads](https://img.shields.io/npm/dt/namastejs)
![license](https://img.shields.io/npm/l/namastejs)
![Code Style](https://img.shields.io/badge/code_style-standard-brightgreen.svg)
![Gitlab last commit](https://img.shields.io/gitlab/last-commit/hardik.47/namastejs)

---


## ⚡ Quick Start

```bash
npx namastejs
```

## 📦 Install (Optional)

```bash
npm install -g namastejs
```

---


## 🧰 CLI Features

| Feature                | Command Example                                | Description                                                   |
| ---------------------- | ---------------------------------------------- | ------------------------------------------------------------- |
| 💬 Dev Blessing API    | `require('namastejs').blessingForDev()`        | Use it in your apps to inject positive vibes into the console |
| 🙏 Default Greet       | `npx namastejs`                                | Prints a dev blessing and a spiritual namaste quote           |
| 🌧️ Typing Game         | `npx namastejs typing-rain`                    | Fun CLI typing rain game                                      |
| 🌐 Get Common Commands | `npx namastejs get <serviceName>`              | Fetch commonly used command of a service directly in terminal |
| 🔄 Branch Updater      | `npx namastejs update --my=feature --from=dev` | Pulls & merges a source branch into your current working one  |
| 🔌 Port Scanner        | `npx namastejs ports`                          | Lists active local ports with process names and PIDs          |
| ❌ Kill a Port         | `npx namastejs ports --kill=3000`              | Frees a stuck port instantly                                  |
| 📊 Size Analyzer       | `npx namastejs size`                           | Displays top 5 heaviest folders/files in your project         |
| 🧘 Breathing Timer     | `npx namastejs breathe`                        | 60-second breathing animation for mental reset                |
| 🔐 Vault CLI           | `npx namastejs vault`                          | Manage dev credentials (add/get/list/delete/clear)            |
| 🚿 Project Cleaner     | `npx namastejs clear`                          | Deletes `node_modules`, `dist`, `build`, and cache folders    |
| ⚙️ Project Setup       | `npx namastejs setup`                          | Installs dependencies, checks tools, creates `.env` if needed |

---


## 🎮 Typing Rain

A fast-paced CLI typing game where words rain from the top 🌧️  
Type the words before they hit the ground.

```bash
npx namastejs typing-rain
```
- Destroy falling words by typing them correctly
- Prevent words from touching the bottom
- Score as high as possible before game over

| Key / Action      | What it does                         |
| ----------------- | ------------------------------------ |
| Type word + Enter | Removes matching falling word        |
| Backspace         | Edit input (disabled after score 10) |
| Space             | ⏸️ Pause / ▶️ Resume game            |
| Ctrl + C          | Exit the game                        |

- Words fall continuously from the top
- Each missed word increases the **Dropped** count
- ❌ 3 dropped words = Game Over
- Game speed increases as score grows
- After level-up, backspace is disabled

---


## 📊 Size Analyzer

```bash
npx namastejs size                # Scan current directory for largest files/folders
npx namastejs size --path=C:\dev  # Scan a custom path (e.g., project directory or drive)
```

---


## 🔐 Vault Usage

```bash
npx namastejs vault add           # Add a service (GitHub, Netlify, etc.)
npx namastejs vault get github    # Get saved credentials
npx namastejs vault list          # List all stored services
npx namastejs vault delete github # Delete a specific service
npx namastejs vault clear         # Wipe the entire vault
```

- Stored globally on your machine with safe (no-dependency) encryption.

---


## 📁 Setup Automation

```bash
npx namastejs setup
```

This command will 👇

- Check for required tools (git, node, npm)
- Install dependencies
- Create .env file from .env.sample (if available)

---


## ❤️ Contribution

Want to improve namastejs or suggest a new feature?

- Fork this project on GitLab: [gitlab.com/hardik.47/namastejs](https://gitlab.com/hardik.47/namastejs)
- Submit an issue or merge request
- Feature ideas? Use npx namastejs help and see what’s already built

> ⚒️ Made with `code` and a lot of ❤️ by [Hardik B Chaudhary](https://in.linkedin.com/in/hardik-b-chaudhary) — may code bless you 🙏