4-minute read
This article was last updated over 476 days ago
← Back to overview
General Options
| Parameter | Short | Description | Example |
|---|
--ci_mode | -ci | Enables CI (Continuous Integration) mode. Suppresses prompts and waits for user input. | --ci_mode |
--pom_file | -pf | Specifies the path to the Maven POM file to process. | --pom_file path/to/pom.xml |
--find_artifact | -fa | Searches for a specific artifact. Provide the artifact in groupId:artifactId:version format. | --find_artifact com.example:lib:1.0 |
--config_file | -cfg | Specifies a custom configuration file for the script. | --config_file config.yml |
--log_level | -ll | Specifies log level. | --log_level debug |
Cache Control
| Parameter | Short | Description | Example |
|---|
--cache_off | -co | Disables caching to force fresh dependency checks. | --cache_off |
--cache_file | -cf | Specifies a custom path for the cache file (only for JSON backend). | --cache_file cache.json |
--cache_time | -ct | Specifies the cache expiration time in seconds. | --cache_time 1800 |
--cache_backend | -cb | Specifies the cache backend to use (json, redis, tarantool, memcached). | --cache_backend redis |
Redis Cache Backend
| Parameter | Short | Description | Example |
|---|
--redis_host | -rsh | Redis host (default: localhost). | --redis_host redis |
--redis_port | -rsp | Redis port (default: 6379). | --redis_port 6379 |
--redis_key | -rsk | Redis key (default: maven_check_versions_cache). | --redis_key mycache |
--redis_user | -rsu | Redis username (optional). | --redis_user user |
--redis_password | -rsup | Redis password (optional). | --redis_password pass |
| Parameter | Short | Description | Example |
|---|
--tarantool_host | -tlh | Tarantool host (default: localhost). | --tarantool_host tarantool |
--tarantool_port | -tlp | Tarantool port (default: 3301). | --tarantool_port 3301 |
--tarantool_space | -tls | Tarantool space (default: maven_check_versions_cache). | --tarantool_space myspace |
--tarantool_user | -tlu | Tarantool username (optional). | --tarantool_user user |
--tarantool_password | -tlup | Tarantool password (optional). | --tarantool_password pass |
Memcached Cache Backend
| Parameter | Short | Description | Example |
|---|
--memcached_host | -mch | Memcached host (default: localhost). | --memcached_host memcached |
--memcached_port | -mcp | Memcached port (default: 11211). | --memcached_port 11211 |
--memcached_key | -mck | Memcached key (default: maven_check_versions_cache). | --memcached_key mycache |
Logging Options
| Parameter | Short | Description | Example |
|---|
--logfile_off | -lfo | Disables logging to a file. Logs will only be shown in the terminal. | --logfile_off |
--log_file | -lf | Specifies the path to a custom log file. | --log_file my_log.log |
Error Handling and Validation
| Parameter | Short | Description | Example |
|---|
--fail_mode | -fm | Enables "fail mode." The script will terminate if dependency versions exceed specified thresholds. | --fail_mode |
--fail_major | -mjv | Specifies the major version difference threshold for failure. | --fail_major 1 |
--fail_minor | -mnv | Specifies the minor version difference threshold for failure. | --fail_minor 2 |
Dependency Search and Processing
| Parameter | Short | Description | Example |
|---|
--search_plugins | -sp | Includes Maven plugins in the dependency search process. | --search_plugins |
--process_modules | -sm | Processes modules listed in the POM file. | --process_modules |
--show_skip | -sk | Logs dependencies that are skipped. | --show_skip |
--show_search | -ss | Logs information about search actions. | --show_search |
--empty_version | -ev | Allows processing of dependencies without a version specified. | --empty_version |
--show_invalid | -si | Logs information about invalid dependencies. | --show_invalid |
| Parameter | Short | Description | Example |
|---|
--threading | -th | Enables multi-threading to process dependencies and modules concurrently. | --threading |
--max_threads | -mt | Specifies the maximum number of threads to use when threading is enabled. | --max_threads 8 |
Authentication
| Parameter | Short | Description | Example |
|---|
--user | -un | Specifies a username for basic authentication when accessing repositories. | --user my_username |
--password | -up | Specifies a password for basic authentication when accessing repositories. | --password my_password |