Skip to content

Commit 61e1243

Browse files
committed
Update README.md
1 parent 2a966c0 commit 61e1243

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GoSecretScanv2
22

3-
A next-generation, AI-powered security scanner that detects secrets, API keys, credentials, and security vulnerabilities with industry-leading precision. Built to outperform tools like gitleaks with advanced entropy analysis and context-aware detection.
3+
GoSecretScanv2 is an engineering-focused security scanner that detects secrets, API keys, credentials, and common security misconfigurations using deterministic analysis plus optional LLM-based verification.
44

55
## Features
66

@@ -38,21 +38,16 @@ A next-generation, AI-powered security scanner that detects secrets, API keys, c
3838
- Handles large files and minified code (1MB line buffer)
3939
- Pattern definition detection
4040

41-
### 🚀 LLM-Powered Verification (BETA)
42-
43-
**Revolutionary AI-powered secret verification using IBM Granite 4.0 Micro**
41+
### LLM-Powered Verification (beta)
4442

4543
- **LLM Verification**:
4644
- Uses IBM Granite 4.0 Micro (GGUF, Q4 quantized, ~450MB)
47-
- Code-specialized AI model for accurate verification
48-
- Reduces false positives to <1%
49-
- Provides reasoning for each decision
45+
- Provides structured reasoning for each decision
5046

5147
- **Semantic Embedding Search**:
5248
- Generates embeddings for each finding
53-
- Searches for similar patterns across codebase
54-
- Learns from historical verifications
55-
- Clusters related findings
49+
- Searches for similar patterns across the codebase
50+
- Reuses historical verifications for similar matches
5651

5752
- **Vector Store**:
5853
- SQLite-based vector database
@@ -112,17 +107,17 @@ export GOSECRETSCANNER_DB_PATH=.gosecretscanner/findings.db
112107

113108
### Performance
114109

115-
- **High Performance**:
110+
- **Runtime characteristics**:
116111
- Pre-compiled regex patterns for fast scanning
117112
- Concurrent file processing using goroutines
118-
- Thread-safe operations with proper synchronization
119-
- Zero external dependencies
113+
- Thread-safe result aggregation
114+
- Fallback paths that avoid external dependencies when optional components are unavailable
120115

121-
- **Easy to Use**:
122-
- Zero configuration required
116+
- **Operational notes**:
117+
- Minimal configuration required for local runs
123118
- Color-coded terminal output with confidence levels
124-
- Automatic recursive directory scanning
125-
- Grouped results by severity
119+
- Automatic recursive directory scanning with ignore rules
120+
- Results grouped by severity to aid triage
126121

127122
## Installation
128123

@@ -149,6 +144,11 @@ docker build -t gosecretscanner .
149144
# Run the scanner on current directory
150145
docker run --rm -v $(pwd):/workspace gosecretscanner
151146

147+
# Run on a specific directory
148+
docker run --rm -v /path/to/scan:/workspace gosecretscanner
149+
150+
```
151+
152152
### GitHub Actions
153153

154154
The bundled `action.yml` now supports full LLM verification. Key inputs:
@@ -172,10 +172,6 @@ Example workflow step:
172172
manage-llm-server: 'false'
173173
```
174174
175-
# Run on specific directory
176-
docker run --rm -v /path/to/scan:/workspace gosecretscanner
177-
```
178-
179175
## Usage
180176
181177
Navigate to the directory you want to scan and run:
@@ -229,7 +225,7 @@ Summary: 3 secrets found (Critical: 1, High: 1, Medium: 1)
229225
Please review and remove them before committing your code.
230226
```
231227

232-
**Key Features in Output:**
228+
**Output details:**
233229
- Results grouped by confidence level (Critical → High → Medium)
234230
- Entropy score shows randomness (higher = more likely real secret)
235231
- Context indicates where the secret was found (code, test_file, comment, etc.)
@@ -296,7 +292,7 @@ fi
296292

297293
### GitHub Actions
298294

299-
This tool is available as a reusable GitHub Action! You can use it in your workflows:
295+
The repository also exposes a reusable GitHub Action for CI pipelines:
300296

301297
```yaml
302298
name: Security Scan

0 commit comments

Comments
 (0)