Skip to content

Commit f80ba5f

Browse files
Alex HolmbergAlex793x
authored andcommitted
feat: readme updates
1 parent 8a8949c commit f80ba5f

1 file changed

Lines changed: 111 additions & 25 deletions

File tree

docs/command-overview.md

Lines changed: 111 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ sync-ctl analyze . --display summary
2020

2121
# JSON output for scripts
2222
sync-ctl analyze . --json
23+
24+
# Analyze specific project path
25+
sync-ctl analyze /path/to/project
2326
```
2427

2528
### 2. Display Mode Comparison
@@ -40,14 +43,26 @@ sync-ctl analyze . --json
4043
- Port mappings and volume configurations
4144
- **Usage**: Use this view when you need complete information about your project
4245

46+
#### Summary View
47+
- **Best for**: CI/CD pipelines, quick status checks
48+
- **Features**: Brief overview with essential information only
49+
- **Usage**: Perfect for automated scripts and quick validation
50+
4351
## 🔍 Security & Vulnerability Commands
4452

45-
### 3. Security Analysis
53+
### 3. Security Analysis (Turbo Engine - 10-100x Faster)
4654

4755
```bash
48-
# Comprehensive security scan
56+
# Comprehensive security scan (default: thorough mode)
4957
sync-ctl security .
5058

59+
# Different scan modes for speed vs coverage
60+
sync-ctl security . --mode lightning # Fastest - critical files only
61+
sync-ctl security . --mode fast # Smart sampling
62+
sync-ctl security . --mode balanced # Good coverage
63+
sync-ctl security . --mode thorough # Comprehensive (default)
64+
sync-ctl security . --mode paranoid # Maximum coverage
65+
5166
# Include low-severity findings
5267
sync-ctl security . --include-low
5368

@@ -61,6 +76,16 @@ sync-ctl security . --output security-report.json --format json
6176
sync-ctl security . --fail-on-findings
6277
```
6378

79+
#### Security Scan Modes
80+
81+
| Mode | Speed | Coverage | Use Case |
82+
|------|-------|----------|----------|
83+
| **Lightning** | 🚀 Fastest | Critical files only | Pre-commit hooks, CI checks |
84+
| **Fast** | ⚡ Very Fast | Smart sampling | Development workflow |
85+
| **Balanced** | 🎯 Optimized | Good coverage | Regular security checks |
86+
| **Thorough** | 🔍 Complete | Comprehensive | Security audits (default) |
87+
| **Paranoid** | 🕵️ Maximum | Everything + low severity | Compliance, releases |
88+
6489
### 4. Vulnerability Scanning
6590

6691
```bash
@@ -69,9 +94,13 @@ sync-ctl vulnerabilities .
6994

7095
# Filter by severity
7196
sync-ctl vulnerabilities . --severity high
97+
sync-ctl vulnerabilities . --severity critical
7298

7399
# Export vulnerability report
74100
sync-ctl vulnerabilities . --format json --output vulns.json
101+
102+
# Check specific project path
103+
sync-ctl vulnerabilities /path/to/project
75104
```
76105

77106
### 5. Dependency Analysis
@@ -86,6 +115,9 @@ sync-ctl dependencies . --vulnerabilities
86115
# Production dependencies only
87116
sync-ctl dependencies . --prod-only
88117

118+
# Development dependencies only
119+
sync-ctl dependencies . --dev-only
120+
89121
# JSON output
90122
sync-ctl dependencies . --format json
91123
```
@@ -104,11 +136,17 @@ sync-ctl tools install
104136
# Install for specific languages
105137
sync-ctl tools install --languages rust,python
106138

139+
# Include OWASP Dependency Check (large download)
140+
sync-ctl tools install --include-owasp
141+
107142
# Verify tool functionality
108143
sync-ctl tools verify
109144

110145
# Get installation guide
111146
sync-ctl tools guide
147+
148+
# Platform-specific guides
149+
sync-ctl tools guide --platform linux
112150
```
113151

114152
## 🏗️ Generation Commands
@@ -118,6 +156,7 @@ sync-ctl tools guide
118156
```bash
119157
# Generate all IaC files
120158
sync-ctl generate .
159+
sync-ctl generate . --all
121160

122161
# Generate specific types
123162
sync-ctl generate . --dockerfile --compose
@@ -128,20 +167,23 @@ sync-ctl generate . --dry-run
128167

129168
# Custom output directory
130169
sync-ctl generate . --output ./infrastructure/
170+
171+
# Overwrite existing files
172+
sync-ctl generate . --force
131173
```
132174

133-
## 🔄 Validation Commands
175+
## 🔄 Validation Commands (Coming Soon)
134176

135-
### 8. IaC Validation (Coming Soon)
177+
### 8. IaC Validation
136178

137179
```bash
138-
# Validate generated IaC files
180+
# Validate generated IaC files (not yet implemented)
139181
sync-ctl validate .
140182

141-
# Validate specific types
183+
# Validate specific types (planned)
142184
sync-ctl validate . --types dockerfile,compose
143185

144-
# Auto-fix issues
186+
# Auto-fix issues (planned)
145187
sync-ctl validate . --fix
146188
```
147189

@@ -158,6 +200,9 @@ sync-ctl support --frameworks
158200

159201
# Show all supported technologies
160202
sync-ctl support
203+
204+
# Detailed support information
205+
sync-ctl support --detailed
161206
```
162207

163208
## 🎯 Advanced Usage Examples
@@ -211,25 +256,38 @@ cd frontend && sync-ctl analyze . --display detailed
211256
cd ../backend && sync-ctl analyze . --display detailed
212257
```
213258

214-
## 🔧 Configuration Options
259+
## 🔧 Global Configuration Options
215260

216-
### Global Options
261+
### Global Flags (Available for all commands)
217262
- `--config <file>` - Custom configuration file
218-
- `--verbose` / `-v` - Verbose output
219-
- `--json` - JSON output format
263+
- `--verbose` / `-v` - Verbose output (-v info, -vv debug, -vvv trace)
264+
- `--quiet` - Suppress all output except errors
265+
- `--json` - JSON output format where applicable
266+
- `--clear-update-cache` - Force update check
220267

221-
### Analysis Options
268+
### Command-Specific Options
269+
270+
#### Analysis Options
222271
- `--display <mode>` - matrix (default), detailed, summary
223272
- `--only <components>` - Analyze specific components only
273+
- `--json` - JSON output for the analyze command
224274

225-
### Security Options
275+
#### Security Options
276+
- `--mode <scan-mode>` - lightning, fast, balanced, thorough, paranoid
226277
- `--include-low` - Include low-severity findings
227278
- `--no-secrets` - Skip secret detection
228279
- `--no-code-patterns` - Skip code pattern analysis
229-
- `--frameworks <list>` - Check specific frameworks
280+
- `--fail-on-findings` - Exit with error on security issues
281+
282+
#### Generation Options
283+
- `--output <directory>` - Custom output directory
284+
- `--dry-run` - Preview without creating files
285+
- `--force` - Overwrite existing files
286+
- `--all` - Generate all IaC types
230287

231-
### Tool Options
288+
#### Tool Options
232289
- `--languages <list>` - Target specific languages
290+
- `--include-owasp` - Include OWASP Dependency Check
233291
- `--dry-run` - Preview installation
234292
- `--yes` - Skip confirmation prompts
235293

@@ -238,14 +296,42 @@ cd ../backend && sync-ctl analyze . --display detailed
238296
1. **For Development**: Use `--display detailed` to see complete Docker analysis
239297
2. **For CI/CD**: Use `--display summary` for quick checks
240298
3. **For Security**: Run `sync-ctl security . --fail-on-findings` in CI/CD
241-
4. **For Debugging**: Use `--verbose` for detailed logs
242-
5. **For Automation**: Use `--json` output with other tools
243-
6. **For Teams**: Share vulnerability reports with `--output` option
299+
4. **For Performance**: Use `--mode lightning` for fastest security scans
300+
5. **For Debugging**: Use `--verbose` for detailed logs
301+
6. **For Automation**: Use `--json` output with other tools
302+
7. **For Teams**: Share vulnerability reports with `--output` option
303+
8. **For Updates**: Use `--clear-update-cache` to force update checks
304+
305+
## 🚀 Implementation Status
306+
307+
### ✅ Fully Implemented
308+
- **analyze** - Project analysis with multiple display modes
309+
- **security** - Turbo security engine with 5 scan modes
310+
- **vulnerabilities** - Dependency vulnerability scanning
311+
- **dependencies** - Comprehensive dependency analysis
312+
- **support** - Technology support information
313+
- **tools** - Vulnerability tool management
314+
315+
### 🚧 In Development
316+
- **validate** - IaC validation and best practices checking
317+
- **generate** - IaC file generation (Dockerfile, Compose, Terraform)
318+
- Enhanced monorepo generation with per-project IaC files
319+
- Advanced compliance framework checking
320+
321+
### 🔮 Coming Soon
322+
- **Cloud Integration** - Deploy directly to cloud platforms
323+
- **Monitoring Setup** - Automated monitoring configuration
324+
- **Performance Analysis** - Resource optimization recommendations
325+
- **Interactive Mode** - Guided setup and configuration wizard
326+
327+
## 📖 Getting Help
244328

245-
## 🚀 What's Coming Next
246-
247-
- **Validation Commands**: Validate generated IaC files
248-
- **Advanced Security**: Infrastructure security scanning
249-
- **Cloud Integration**: Deploy directly to cloud platforms
250-
- **Monitoring Setup**: Automated monitoring configuration
251-
- **Performance Analysis**: Resource optimization recommendations
329+
```bash
330+
# Get help with any command
331+
sync-ctl --help # Show all available commands
332+
sync-ctl analyze --help # Show analyze command options
333+
sync-ctl security --help # Show security scanning options
334+
sync-ctl vulnerabilities --help # Show vulnerability check options
335+
sync-ctl generate --help # Show generation options
336+
sync-ctl tools --help # Show tool management options
337+
```

0 commit comments

Comments
 (0)