git-cli-scanner 1.0.0 → 1.1.0

package/dist/cli.js

@@ -652,12 +652,6 @@ init_logger();
 
 // src/utils/prompts.ts
 var import_prompts = require("@inquirer/prompts");
-async function askToScan() {
-  return await (0, import_prompts.confirm)({
-    message: "Do you want to scan for vulnerabilities before committing?",
-    default: true
-  });
-}
 async function askToContinue() {
   return await (0, import_prompts.confirm)({
     message: "Vulnerabilities were found! Do you still want to continue with the commit?",
@@ -709,36 +703,61 @@ var Spinner = class {
 };
 
 // src/cli.ts
-var import_child_process2 = require("child_process");
 var fs3 = __toESM(require("fs"));
 var path3 = __toESM(require("path"));
 var program = new import_commander.Command();
-program.name("git-cli-scanner").description("Interactive Git hooks vulnerability scanner").version("1.0.0");
-program.command("init").description("Initialize husky and add the pre-commit hook automatically").action(() => {
-  info("Setting up git hooks with husky...");
+program.name("git-cli-scanner").description("Interactive Git hooks vulnerability scanner").version("1.1.0");
+program.command("init").description("Install pre-commit hook for automatic scanning").action(() => {
+  info("Setting up pre-commit hook...");
   try {
-    (0, import_child_process2.execSync)("npx husky init", { stdio: "inherit" });
-    const hookPath = path3.join(process.cwd(), ".husky", "pre-commit");
-    const hookContent = `
+    const gitDir = path3.join(process.cwd(), ".git");
+    if (!fs3.existsSync(gitDir)) {
+      error("Not a git repository. Run `git init` first.");
+      process.exit(1);
+    }
+    const hooksDir = path3.join(gitDir, "hooks");
+    if (!fs3.existsSync(hooksDir)) {
+      fs3.mkdirSync(hooksDir, { recursive: true });
+    }
+    const hookPath = path3.join(hooksDir, "pre-commit");
+    const hookContent = `#!/bin/sh
+# git-cli-scanner pre-commit hook
 # exec < /dev/tty is required to allow interactive prompts in git hooks
 exec < /dev/tty
 npx git-cli-scanner scan
-`.trim();
-    fs3.writeFileSync(hookPath, hookContent, "utf-8");
-    success("Successfully installed pre-commit hook!");
-    info("Next time you run `git commit`, the scanner will prompt you.");
+`;
+    fs3.writeFileSync(hookPath, hookContent, { mode: 493 });
+    success("Pre-commit hook installed!");
+    info("Every `git commit` will now automatically scan your staged files.");
   } catch (err) {
     error(`Failed to initialize: ${err.message}`);
   }
 });
-program.command("scan").description("Interactive vulnerability scan for staged files").option("--show-sol", "Show solutions for vulnerabilities").action(async (options) => {
-  info("GitHub CLI Scanner triggered by Git Hook.");
+program.command("disable").description("Remove the pre-commit hook and disable automatic scanning").action(() => {
   try {
-    const shouldScan = await askToScan();
-    if (!shouldScan) {
-      info("Skipping scan as requested. Proceeding with commit...");
-      process.exit(0);
+    const gitHookPath = path3.join(process.cwd(), ".git", "hooks", "pre-commit");
+    const huskyHookPath = path3.join(process.cwd(), ".husky", "pre-commit");
+    let removed = false;
+    if (fs3.existsSync(gitHookPath)) {
+      fs3.unlinkSync(gitHookPath);
+      removed = true;
     }
+    if (fs3.existsSync(huskyHookPath)) {
+      fs3.unlinkSync(huskyHookPath);
+      removed = true;
+    }
+    if (removed) {
+      success("Pre-commit hook removed. Automatic scanning is now disabled.");
+    } else {
+      info("No pre-commit hook found. Nothing to disable.");
+    }
+  } catch (err) {
+    error(`Failed to disable: ${err.message}`);
+  }
+});
+program.command("scan").description("Interactive vulnerability scan for staged files").option("--show-sol", "Show solutions for vulnerabilities").action(async (options) => {
+  info("Git CLI Scanner running...");
+  try {
     const spinner = new Spinner([
       "Scanning staged files for vulnerabilities...",
       "Analyzing code patterns...",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-cli-scanner",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A powerful interactive CLI tool that scans your codebase for hardcoded secrets, API keys, passwords, and private keys before they reach your Git history.",
   "main": "dist/cli.js",
   "scripts": {
@@ -8,7 +8,16 @@
     "build": "tsup src/cli.ts --format cjs",
     "prepare": "husky"
   },
-  "keywords": ["security", "scanner", "git", "secrets", "api-keys", "cli", "pre-commit", "vulnerability"],
+  "keywords": [
+    "security",
+    "scanner",
+    "git",
+    "secrets",
+    "api-keys",
+    "cli",
+    "pre-commit",
+    "vulnerability"
+  ],
   "author": "riskchips",
   "license": "ISC",
   "dependencies": {

package/readme.md

@@ -1,110 +1,90 @@
 # Git CLI Scanner
 
-A powerful, interactive CLI tool that scans your codebase for hardcoded secrets, API keys, passwords, private keys, and other vulnerabilities before they ever reach your Git history.
+A powerful CLI tool that scans your codebase for hardcoded secrets, API keys, passwords, and private keys before they reach your Git history.
 
 ---
 
 ## Installation
 
 ```bash
+# Install globally
 npm install -g git-cli-scanner
+
+# Or use directly with npx (no install needed)
+npx git-cli-scanner <command>
 ```
 
-## Quick Start
+---
+
+## Setup
 
 ```bash
-# Set up the pre-commit hook (one-time)
-npx git-cli-scanner init
+# Navigate to your project
+cd your-project
 
-# Now every time you run `git commit`, the scanner will automatically prompt you.
+# Initialize the pre-commit hook
+npx git-cli-scanner init
 ```
 
+After running `init`, every time you run `git commit`, the scanner will automatically scan your staged files and warn you if any vulnerabilities are found.
+
 ---
 
 ## Commands
 
-### `init` — Set up Git hooks
+| Command | Description |
+|---------|-------------|
+| `init` | Install the pre-commit hook for automatic scanning |
+| `disable` | Remove the pre-commit hook and stop automatic scanning |
+| `scan` | Manually scan staged files |
+| `scan --show-sol` | Scan staged files and show suggested fixes |
+| `scan-all [dir]` | Scan an entire directory recursively |
+| `scan-all [dir] --show-sol` | Scan a directory and show suggested fixes |
+| `explore` | Launch interactive file explorer TUI |
 
-Installs a Husky pre-commit hook that triggers the scanner automatically before every commit.
+### Enable automatic scanning
 
 ```bash
 npx git-cli-scanner init
 ```
 
-### `scan` — Scan staged files (Git hook mode)
+Installs a pre-commit hook. After this, every `git commit` will automatically scan your staged files. If vulnerabilities are found, you choose to continue or abort.
 
-Interactively scans only the files you have staged (`git add`) for vulnerabilities. This is what the pre-commit hook runs.
+### Disable automatic scanning
 
 ```bash
-npx git-cli-scanner scan
-npx git-cli-scanner scan --show-sol   # Also show suggested fixes
+npx git-cli-scanner disable
 ```
 
-### `scan-all` — Scan an entire directory
+Removes the pre-commit hook. The scanner will no longer run automatically on `git commit`.
 
-Recursively walks through a directory and scans every file for vulnerabilities. Skips `.git`, `node_modules`, `dist`, and `build` directories automatically.
+### Scan staged files
 
 ```bash
-npx git-cli-scanner scan-all .              # Scan current directory
-npx git-cli-scanner scan-all ./src           # Scan only src/
-npx git-cli-scanner scan-all tests --show-sol  # Scan tests/ with solutions
+npx git-cli-scanner scan
+npx git-cli-scanner scan --show-sol
 ```
 
-### `explore` — Interactive file explorer TUI
+### Scan an entire directory
+
+```bash
+npx git-cli-scanner scan-all .
+npx git-cli-scanner scan-all ./src
+npx git-cli-scanner scan-all tests --show-sol
+```
 
-Launch a fully interactive Terminal UI to browse your project and scan files on the fly.
+### Interactive file explorer
 
 ```bash
 npx git-cli-scanner explore
 ```
 
-**Controls:**
 | Key | Action |
 |-----|--------|
-| `Up / Down` | Move cursor through files and folders |
-| `Right / Enter` | Open a folder or scan a file |
+| `Up / Down` | Move through files and folders |
+| `Right / Enter` | Open folder or scan file |
 | `Left` | Go back to parent directory |
-| `Ctrl+C` | Exit the explorer |
-
----
-
-## Flags
-
-| Flag | Available On | Description |
-|------|-------------|-------------|
-| `--show-sol` | `scan`, `scan-all` | Show actionable fix suggestions for each vulnerability |
-
----
-
-## What It Detects
-
-### HIGH Severity (Red)
-- AWS Access Keys & Secret Keys
-- Google Cloud API Keys
-- Slack Tokens & Webhooks
-- GitHub Personal Access Tokens & OAuth Tokens
-- Stripe API Keys
-- SendGrid, Mailgun, and Twilio Tokens
-- RSA, OpenSSH, and PGP Private Keys
-- Generic API keys, passwords, and passphrases (any format like `api_key`, `api-key`, `API_KEY`, etc.)
-
-### MEDIUM Severity (Yellow)
-- `.env` files not listed in `.gitignore`
-- Banned file types: `.pem`, `.key`, `.sqlite`, `.db`, `.log`, `.p12`, `.pfx`
-- `node_modules/` committed to the repo
-
-### Dummy Detection (Dimmed)
-The scanner has a strict dummy detection engine that automatically identifies obvious test/example secrets (like `AKIAIOSFODNN7EXAMPLE` or values containing `test`, `dummy`, `sample`, etc.) and downgrades them so they don't block your workflow.
-
----
-
-## Gitignore Awareness
-
-The scanner checks if banned files (like `.env`, `.sqlite`, `.pem`) are listed in your `.gitignore` or `.npmignore`. If they are, the issue is downgraded to a safe "IGNORED" status. If they are NOT, you get a loud warning:
-
-```
-DANGER: .env is NOT in .gitignore or .npmignore!
-```
+| `Ctrl+C` | Exit |
 
 ---
 
@@ -113,8 +93,8 @@ DANGER: .env is NOT in .gitignore or .npmignore!
 | Indicator | Level | Color | Meaning |
 |-----------|-------|-------|---------|
 | `●` | HIGH | Red | Hardcoded secrets that must be removed |
-| `●` | MEDIUM | Yellow | Risky files that should be in .gitignore |
-| `○` | IGNORED (DUMMY) | Dim | Detected but identified as a test/example value |
+| `●` | MEDIUM | Yellow | Risky files not in .gitignore |
+| `○` | IGNORED | Dim | Test/example values (auto-detected) |
 
 ---