Scanning Code Manually with OX CLI
Manual scans let you analyze your code on demand from the command line. Use the scan command to scan modified files, an entire directory, or selected security categories. By default, the OX CLI scans only modified files in the current directory.
Modified files
ox-cli scan
None
Scans only modified files in the current directory. This is the default behavior.
Scan the changes you're currently working on.
Specific directory
ox-cli scan <targetDir>
<targetDir>
Scans the specified directory. If no directory is specified, the current directory is scanned.
Scan a repository or project located outside the current directory.
Full scan
ox-cli scan --full-scan
--full-scan
Scans all files in the target directory instead of only modified files.
Validate the entire codebase, such as after cloning a repository or before a release.
Scan by category
ox-cli scan --category <categories>
--category <categories>
Scans only the specified security categories. Specify multiple categories as a comma-separated list.
Focus on specific security checks.
Full scan by category
ox-cli scan --full-scan --category <categories>
--full-scan--category <categories>
Scans all files in the target directory for the specified security categories.
Validate one or more security categories across the entire repository.
Compare against a Git remote
ox-cli scan --git-remote-name <remote>
--git-remote-name <remote>
Uses the specified Git remote when determining which files have changed.
Compare changes against a remote other than the default.
Use VibeSec authentication
ox-cli scan --use-vibesec-auth
--use-vibesec-auth
Uses the authentication token stored by a supported VibeSec IDE integration for the current scan.
Run a scan using your existing VibeSec authentication.
Supported scan categories
Use the --category option with one or more of the following values:
Code Security
code
Open Source Security
oss
Secrets and PII
secrets
Infrastructure as Code
iac
Software Bill of Materials
sbom
To scan multiple categories, specify a comma-separated list.
Example:
ox-cli scan --category code,secretsExamples
Scan modified files in the current directory:
Scan a specific directory:
Run a full scan:
Run a full scan for a specific directory:
Scan only Secrets and Infrastructure as Code issues:
Run a full scan for Open Source Security issues:
Scan Code Security and Secrets issues and display only Critical and High severity findings:
Last updated
