@@ -33,17 +33,19 @@ Perfect for continuous security monitoring and DevOps pipelines.
3333
3434## 📋 Table of Contents
3535
36- - [ Installation] ( #installation )
37- - [ Quick Start] ( #quick-start )
38- - [ Configuration] ( #configuration )
39- - [ Security Audits] ( #security-audits )
40- - [ Usage Examples] ( #usage-examples )
41- - [ Notifications] ( #notifications )
42- - [ Custom Audits] ( #custom-audits )
43- - [ Scheduling] ( #scheduling )
44- - [ CI/CD Integration] ( #cicd-integration )
45- - [ Advanced Features] ( #advanced-features )
46- - [ FAQ] ( #faq )
36+ - [ Installation] ( #-installation )
37+ - [ Quick Start] ( #-quick-start )
38+ - [ Command Reference] ( #-command-reference )
39+ - [ Configuration] ( #-configuration )
40+ - [ Security Audits] ( #-security-audits )
41+ - [ Usage Examples] ( #-usage-examples )
42+ - [ Notifications] ( #-notifications )
43+ - [ Custom Audits] ( #-custom-audits )
44+ - [ Scheduling] ( #-scheduling )
45+ - [ CI/CD Integration] ( #-cicd-integration )
46+ - [ Advanced Features] ( #-advanced-features )
47+ - [ FAQ] ( #-faq )
48+ - [ Troubleshooting] ( #-troubleshooting )
4749
4850---
4951
@@ -89,11 +91,32 @@ Generate machine-readable reports for automated pipelines:
8991php artisan warden:audit --output=json --severity=high
9092```
9193
92- ### Silent Mode ( No Notifications)
93- Perform audits without triggering notifications:
94+ ### No Notifications
95+ Run audits without sending notifications (useful for CI or local checks) :
9496``` bash
95- php artisan warden:audit --silent
97+ php artisan warden:audit --no-notify
9698```
99+ > ** Note:** ` --silent ` still works for backward compatibility.
100+
101+ ---
102+
103+ ## 📌 Command Reference
104+
105+ Quick reference for all commands and options.
106+
107+ | Command | Options | Description |
108+ | --------| ---------| -------------|
109+ | ` warden:audit ` | — | Run all security audits |
110+ | | ` --no-notify ` | Suppress notifications (CI/local use) |
111+ | | ` --npm ` | Include NPM dependency scan |
112+ | | ` --ignore-abandoned ` | Don't fail on abandoned packages |
113+ | | ` --output=json\|github\|gitlab\|jenkins ` | Machine-readable output |
114+ | | ` --severity=low\|medium\|high\|critical ` | Filter by minimum severity |
115+ | | ` --force ` | Clear cache and re-run all audits |
116+ | ` warden:syntax ` | — | PHP syntax validation only |
117+ | ` warden:schedule ` | ` --enable ` | Enable scheduled audits |
118+ | | ` --disable ` | Disable scheduled audits |
119+ | | ` --status ` | Show schedule status |
97120
98121---
99122
@@ -130,6 +153,11 @@ WARDEN_CACHE_DURATION=3600 # Cache for 1 hour
130153WARDEN_PARALLEL_EXECUTION=true # Enable parallel audits
131154```
132155
156+ #### 🔬 PHP Syntax Audit
157+ ``` env
158+ WARDEN_PHP_SYNTAX_AUDIT_ENABLED=false # Enable via warden:syntax or config
159+ ```
160+
133161#### ⏰ Scheduling
134162``` env
135163WARDEN_SCHEDULE_ENABLED=false
@@ -138,13 +166,6 @@ WARDEN_SCHEDULE_TIME=03:00
138166WARDEN_SCHEDULE_TIMEZONE=UTC
139167```
140168
141- #### 📊 Output & Filtering
142- ``` env
143- WARDEN_SEVERITY_FILTER= # null|low|medium|high|critical
144- WARDEN_OUTPUT_JSON=false
145- WARDEN_OUTPUT_JUNIT=false
146- ```
147-
148169---
149170
150171## 🔍 Security Audits
@@ -222,7 +243,7 @@ php artisan warden:audit --output=jenkins
222243
223244``` bash
224245# Combined options
225- php artisan warden:audit --npm --severity=high --output=json --silent
246+ php artisan warden:audit --npm --severity=high --output=json --no-notify
226247
227248# PHP syntax check
228249php artisan warden:syntax
@@ -308,6 +329,7 @@ class DatabasePasswordAudit implements CustomAudit
308329 {
309330 return [
310331 [
332+ 'source' => 'Database Password Security',
311333 'package' => 'environment',
312334 'title' => 'Weak Database Password',
313335 'severity' => 'critical',
@@ -397,7 +419,7 @@ jobs:
397419 - name : Setup PHP
398420 uses : shivammathur/setup-php@v2
399421 with :
400- php-version : ' 8.1 '
422+ php-version : ' 8.4 '
401423
402424 - name : Install dependencies
403425 run : composer install --no-progress --prefer-dist
@@ -409,11 +431,11 @@ jobs:
409431### GitLab CI
410432
411433` ` ` yaml
412- security_audit :
434+ security_audit :
413435 stage : test
414436 script :
415437 - composer install --no-progress --prefer-dist
416- - php artisan warden:audit --output=gitlab --silent > gl-dependency-scanning-report.json
438+ - php artisan warden:audit --output=gitlab --no-notify > gl-dependency-scanning-report.json
417439 artifacts :
418440 reports :
419441 dependency_scanning : gl-dependency-scanning-report.json
@@ -479,9 +501,7 @@ pipeline {
479501
480502'audits' => [
481503 'parallel_execution' => true,
482- 'timeout' => 300,
483- 'retry_attempts' => 3,
484- 'severity_filter' => 'medium',
504+ 'timeout' => 300, // seconds
485505],
486506
487507'cache' => [
@@ -496,6 +516,8 @@ pipeline {
496516],
497517```
498518
519+ > ** Output & severity:** Use ` --output ` and ` --severity ` CLI options (not config). See [ Command Reference] ( #-command-reference ) below.
520+
499521---
500522
501523## 📈 Roadmap
@@ -514,7 +536,7 @@ pipeline {
514536Warden extends beyond Composer audit with NPM scanning, environment checks, storage permissions, Laravel-specific configurations, and custom audit rules for comprehensive security monitoring.
515537
516538### Can Warden run in CI/CD without notifications?
517- Yes! Use the ` --silent ` flag to suppress notifications while still generating reports for your pipeline.
539+ Yes! Use ` --no-notify ` to suppress notifications while still generating reports for your pipeline. ( ` --silent ` also works.)
518540
519541### What are the performance impacts?
520542Minimal! Parallel execution and intelligent caching ensure audits complete in seconds, with configurable timeouts and retry logic.
0 commit comments