retina run command is the primary analysis command that scans your PocketMine-MP plugin directory to detect errors, issues, and potential problems.
Basic usage
Arguments
Path to the plugin directory to scan. If not specified, scans the current directory.
Options
Analysis options
Analysis strictness level ranging from 1 to 9, where higher values apply stricter analysis rules.
Level 6 is recommended for most plugins. Use higher levels for critical plugins that require stricter analysis.
Output format options
Output format for the generated report. Available formats:
md- Markdown report (default)json- JSON structured datatxt- Plain text reporthtml- HTML web-based report
Custom output file path. If not specified, defaults to
retina-report.<format> in the scanned directory.Output results to console only without generating a report file.
Useful for CI/CD pipelines where you only need exit codes and console output.
Generate a simplified report without code snippets and suggestions. Simple reports include only file paths, line numbers, categories, severity levels, and messages.
Disable progress output during analysis.
Filtering options
Comma-separated list of issue categories to exclude from the report.See Filtering options for available categories and presets.
Comma-separated list of analyzers to disable during analysis.See Filtering options for available analyzers.
Comma-separated list of severity levels to exclude from the report.Valid severity levels:
error, warning, info, hintExamples
Requirements
Configuration file
CLI options override settings fromretina.yml configuration files. If a retina.yml exists in the scanned directory, Retina will:
- Load default settings from
retina.yml - Override with any CLI options provided
- Use CLI filtering options if specified, otherwise fall back to config file filters
Exit codes
0- Success, no issues found1- Failure, issues found or scan error occurred