CLI Overview
Quick Start Guide
wheels info
wheels reload
wheels deps
wheels destroy
wheels watch
wheels generate app
wheels generate app-wizard
wheels generate controller
wheels generate model
wheels generate view
wheels generate property
wheels generate route
wheels generate resource
wheels generate api-resource
wheels generate frontend
wheels generate test
wheels generate snippets
wheels scaffold
wheels db create
wheels db drop
wheels db setup
wheels db reset
wheels db status
wheels db version
wheels db rollback
wheels db seed
wheels db dump
wheels db restore
wheels db shell
wheels db schema
wheels dbmigrate info
wheels dbmigrate latest
wheels dbmigrate up
wheels dbmigrate down
wheels dbmigrate reset
wheels dbmigrate exec
wheels dbmigrate create blank
wheels dbmigrate create table
wheels dbmigrate create column
wheels dbmigrate remove table
wheels test
wheels test run
wheels test coverage
wheels test debug
wheels config list
wheels config set
wheels config env
wheels env
wheels env setup
wheels env list
wheels env switch
wheels environment
wheels console
wheels runner
wheels server
wheels server start
wheels server stop
wheels server restart
wheels server status
wheels server log
wheels server open
wheels plugins
wheels plugins list
wheels plugins install
wheels plugins remove
wheels analyze
wheels analyze code
wheels analyze performance
wheels analyze security
wheels security
wheels security scan
wheels optimize
wheels optimize performance
wheels docs
wheels docs generate
wheels docs serve
wheels ci init
wheels docker init
wheels docker deploy
wheels deploy
wheels deploy audit
wheels deploy exec
wheels deploy hooks
wheels deploy init
wheels deploy lock
wheels deploy logs
wheels deploy proxy
wheels deploy push
wheels deploy rollback
wheels deploy secrets
wheels deploy setup
wheels deploy status
wheels deploy stop
Configuration Management
Creating Commands
Service Architecture
Migrations Guide
Testing Guide
Object Relational Mapping
Creating Records
Reading Records
Updating Records
Deleting Records
Column Statistics
Dynamic Finders
Getting Paginated Data
Associations
Nested Properties
Object Validation
Object Callbacks
Calculated Properties
Transactions
Dirty Records
Soft Delete
Automatic Time Stamps
Using Multiple Data Sources
deploy audit (Coming Soon)
This command may not work as expected. A complete and stable version is coming soon.
Audit deployment configuration and security settings to ensure compliance and best practices.
Synopsis
wheels deploy audit [options]
Description
The wheels deploy audit command performs a comprehensive security and configuration audit of your deployment setup. It checks for common misconfigurations, security vulnerabilities, and compliance issues in your deployment environment.
Options
--environment, -e- Target environment to audit (default: production)--report-format- Output format for audit report (json, html, text) (default: text)--output, -o- Save audit report to file--severity- Minimum severity level to report (low, medium, high, critical)--fix- Attempt to automatically fix issues where possible--verbose, -v- Show detailed audit information
Examples
Basic audit
wheels deploy audit
Audit staging environment
wheels deploy audit --environment staging
Generate HTML report
wheels deploy audit --report-format html --output audit-report.html
Show only high severity issues
wheels deploy audit --severity high
Auto-fix issues
wheels deploy audit --fix
Audit Checks
The command performs the following audit checks:
Security
- SSL/TLS configuration
- Exposed sensitive files
- Default credentials
- Authentication mechanisms
- Authorization settings
- Input validation
- Session management
- Error handling
Configuration
- Environment variables
- Database connections
- API endpoints
- File permissions
- Resource limits
- Logging configuration
- Backup settings
- Monitoring setup
Compliance
- Data protection requirements
- Access control policies
- Audit trail completeness
- Retention policies
- Encryption standards
Output
The audit generates a detailed report including:
- Summary of findings
- Issue severity levels
- Affected components
- Remediation recommendations
- Compliance status
- Performance metrics
Use Cases
Pre-deployment audit
# Run comprehensive audit before deploying
wheels deploy audit --severity low
wheels deploy push --if-audit-passes
Scheduled audits
# Run regular audits in CI/CD
wheels deploy audit --output reports/audit-$(date +%Y%m%d).json
Compliance reporting
# Generate compliance report
wheels deploy audit --report-format html --output compliance.html
Best Practices
- Regular audits: Run audits regularly, not just before deployments
- Fix critical issues: Always address critical and high severity issues
- Document exceptions: Keep records of accepted risks and exceptions
- Automate checks: Integrate audits into your CI/CD pipeline
- Review reports: Have security team review audit reports
Integration
The audit command integrates with:
- CI/CD pipelines for automated security checks
- Monitoring systems for continuous compliance
- Issue tracking systems for remediation workflow
- Reporting tools for compliance documentation
See Also
- deploy status - Check deployment status
- security scan - Run security scans
- deploy setup - Setup deployment environment