codeslick-cli 1.0.3 → 1.0.4

package/README.md

@@ -15,6 +15,22 @@ Catch security vulnerabilities before they enter your codebase with automated pr
 - **CI/CD Ready** - JSON output mode for automation
 - **OWASP Top 10:2025 Compliant** - 268 comprehensive security checks
 
+## Prerequisites
+
+**Git is required** - CodeSlick CLI works with any git repository (local or remote):
+
+```bash
+# Initialize git in your project (if not already done)
+git init
+```
+
+**Note**: You do NOT need GitHub, GitLab, or any remote hosting. CodeSlick works with local git repositories, GitHub repositories, GitLab, Bitbucket, or any git-based workflow.
+
+**System Requirements**:
+- Node.js 18.0.0 or higher
+- Git (any version)
+- macOS, Linux, or Windows
+
 ## Installation
 
 ### Option 1: Use `npx` (Recommended - No Installation Required)
@@ -60,10 +76,18 @@ npx codeslick-cli init
 
 ## Quick Start
 
-### 1. Initialize CodeSlick in Your Repository
+### 1. Make Sure You Have Git Initialized
 
 ```bash
 cd your-project/
+
+# If not already a git repository, initialize it first:
+git init
+```
+
+### 2. Initialize CodeSlick in Your Repository
+
+```bash
 npx codeslick-cli init
 # or if you installed globally:
 codeslick init  # or: cs init
@@ -71,18 +95,18 @@ codeslick init  # or: cs init
 
 This will:
 - Create `.codeslick.json` configuration file
-- Install pre-commit hook
+- Install pre-commit hook in `.git/hooks/`
 - Configure automatic scanning
 
-### 2. Configure Severity Threshold (Optional)
+### 3. Configure Severity Threshold (Optional)
 
 ```bash
-cs config set severity critical  # Block only CRITICAL issues
-cs config set severity high      # Block HIGH+ issues (recommended)
-cs config set severity medium    # Block MEDIUM+ issues (default)
+npx codeslick-cli config set severity critical  # Block only CRITICAL issues
+npx codeslick-cli config set severity high      # Block HIGH+ issues (recommended)
+npx codeslick-cli config set severity medium    # Block MEDIUM+ issues (default)
 ```
 
-### 3. Commit as Usual
+### 4. Commit as Usual
 
 ```bash
 git add .
@@ -350,12 +374,22 @@ codeslick init --force  # Re-install hook
 
 **Problem**: Running `codeslick init` in a non-git directory.
 
+**Why this happens**: CodeSlick CLI requires git to:
+- Install pre-commit hooks in `.git/hooks/` directory
+- Track staged files for scanning
+- Work with your existing git workflow
+
 **Solution**: Initialize git first:
 ```bash
+# Initialize git in your project
 git init
-codeslick init
+
+# Now run CodeSlick init
+npx codeslick-cli init
 ```
 
+**Note**: You do NOT need GitHub or any remote repository. CodeSlick works with local git repositories.
+
 ### "No staged files found" error
 
 **Problem**: Running `codeslick scan --staged` with no staged files.

package/bin/codeslick.cjs

@@ -25,6 +25,7 @@ const { scanCommand } = require('../dist/packages/cli/src/commands/scan');
 const { initCommand } = require('../dist/packages/cli/src/commands/init');
 const { configCommand } = require('../dist/packages/cli/src/commands/config');
 const { loginCommand, logoutCommand, whoamiCommand } = require('../dist/packages/cli/src/commands/auth');
+const { version } = require('../package.json');
 
 // Detect if running as 'cs' or 'codeslick'
 const scriptName = process.argv[1].includes('/cs') ? 'cs' : 'codeslick';
@@ -146,7 +147,7 @@ yargs(hideBin(process.argv))
   .demandCommand(1, 'You must provide a command')
   .help()
   .alias('help', 'h')
-  .version('1.0.0')
+  .version(version)
   .alias('version', 'v')
   .epilog('For more information, visit https://codeslick.dev/docs/cli')
   .strict()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeslick-cli",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "CodeSlick CLI tool for pre-commit security scanning",
   "main": "dist/index.js",
   "bin": {