2020-11-14 09:20:07 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "description" content = "Sums up the first steps to set up a CLI installation and get started using PMD" >
< meta name = "keywords" content = "getting_starteduserdocs, pmdcpdoptionscommandauxclasspath" >
< title > Installation and basic CLI usage | PMD Source Code Analyzer< / title >
< link rel = "stylesheet" href = "css/syntax.css" >
< link rel = "stylesheet" type = "text/css" href = "https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css" >
<!-- <link rel="stylesheet" type="text/css" href="css/bootstrap.min.css"> -->
< link rel = "stylesheet" href = "css/modern-business.css" >
< link rel = "stylesheet" href = "css/lavish-bootstrap.css" >
< link rel = "stylesheet" href = "css/customstyles.css" >
< link rel = "stylesheet" href = "css/theme-blue.css" >
< link rel = "stylesheet" href = "css/pmd-customstyles.css" >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js" > < / script >
< script src = "js/jquery.navgoco.min.js" > < / script >
< script src = "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js" > < / script >
< script src = "js/toc.js" > < / script >
< script src = "js/customscripts.js" > < / script >
< link rel = "shortcut icon" href = "images/favicon.ico" type = "image/x-icon" >
< link rel = "icon" href = "images/favicon.ico" type = "image/x-icon" >
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!-- [if lt IE 9]>
< script src = "https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js" > < / script >
< script src = "https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js" > < / script >
<![endif]-->
< link rel = "alternate" type = "application/rss+xml" title = "" href = "https://pmd.github.io/pmd/feed.xml" >
< script >
$(document).ready(function() {
// Initialize navgoco with default options
$("#mysidebar").navgoco({
caretHtml: '',
accordion: true,
openClass: 'active', // open
save: false, // leave false or nav highlighting doesn't work right
cookie: {
name: 'navgoco',
expires: false,
path: '/'
},
slide: {
duration: 400,
easing: 'swing'
}
});
$("#collapseAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', false);
});
$("#expandAll").click(function(e) {
e.preventDefault();
$("#mysidebar").navgoco('toggle', true);
});
});
< / script >
< script >
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
< / script >
< script >
$(document).ready(function() {
$("#tg-sb-link").click(function() {
$("#tg-sb-sidebar").toggle();
$("#tg-sb-content").toggleClass('col-md-9');
$("#tg-sb-content").toggleClass('col-md-12');
$("#tg-sb-icon").toggleClass('fa-toggle-on');
$("#tg-sb-icon").toggleClass('fa-toggle-off');
});
});
< / script >
< / head >
< body >
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding - top rule in modern - business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
< div id = "topbar-content-offset" >
<!-- Navigation -->
< nav class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "container topnavlinks" >
< div class = "navbar-header" >
< button type = "button" class = "navbar-toggle" data-toggle = "collapse" data-target = "#bs-example-navbar-collapse-1" >
< span class = "sr-only" > Toggle navigation< / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / button >
< a class = "fa fa-home fa-lg navbar-brand" href = "index.html" > < span class = "projectTitle" > PMD Source Code Analyzer Project< / span > < / a >
< / div >
< div class = "collapse navbar-collapse" id = "bs-example-navbar-collapse-1" >
< ul class = "nav navbar-nav navbar-right" >
<!-- toggle sidebar button -->
< li > < a id = "tg-sb-link" href = "#" > < i id = "tg-sb-icon" class = "fa fa-toggle-on" > < / i > Nav< / a > < / li >
<!-- entries without drop - downs appear here -->
< li > < a href = "https://github.com/pmd/pmd/releases/latest" target = "_blank" > Download< / a > < / li >
< li > < a href = "https://github.com/pmd/pmd" target = "_blank" > Fork us on github< / a > < / li >
<!-- entries with drop - downs appear here -->
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file. -->
<!-- comment out this block if you want to hide search -->
< li >
<!-- start search -->
< div id = "search-demo-container" >
< input type = "text" id = "search-input" placeholder = "search..." >
< ul id = "results-container" > < / ul >
< / div >
< script src = "js/jekyll-search.js" type = "text/javascript" > < / script >
< script type = "text/javascript" >
SimpleJekyllSearch.init({
searchInput: document.getElementById('search-input'),
resultsContainer: document.getElementById('results-container'),
dataSource: 'search.json',
searchResultTemplate: '< li > < a href = "{url}" title = "Installation and basic CLI usage" > {title}< / a > < / li > ',
noResultsText: 'No results found.',
limit: 10,
fuzzy: true,
})
< / script >
<!-- end search -->
< / li >
< / ul >
< / div >
< / div >
<!-- /.container -->
< / nav >
<!-- Page Content -->
2022-02-25 09:51:51 +00:00
< div class = "container-toc-wrapper" >
< div class = "container" >
< div class = "col-lg-12" > < / div >
<!-- Content Row -->
< div class = "row" >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Sidebar Column -->
< div class = "col-md-3" id = "tg-sb-sidebar" >
2020-11-14 09:20:07 +00:00
< ul id = "mysidebar" class = "nav" >
2023-01-28 09:59:31 +00:00
< li class = "sidebarTitle" > PMD 6.54.0< / li >
2022-12-31 18:08:22 +00:00
< div class = "sidebarTitleDate" > Release date: 28-January-2023< / div >
2020-11-14 09:20:07 +00:00
< li >
< a href = "#" > About< / a >
< ul >
< li > < a href = "index.html" > Home< / a > < / li >
< li > < a href = "pmd_release_notes.html" > Release notes< / a > < / li >
< li > < a href = "pmd_next_major_development.html" > PMD 7.0.0 development< / a > < / li >
< li > < a href = "pmd_about_help.html" > Getting help< / a > < / li >
< / ul >
< / li >
< li >
< a href = "#" > User Documentation< / a >
< ul >
< li class = "active" > < a href = "pmd_userdocs_installation.html" > Installation and basic CLI usage< / a > < / li >
< li > < a href = "pmd_userdocs_making_rulesets.html" > Making rulesets< / a > < / li >
< li > < a href = "pmd_userdocs_configuring_rules.html" > Configuring rules< / a > < / li >
< li > < a href = "pmd_userdocs_best_practices.html" > Best practices< / a > < / li >
< li > < a href = "pmd_userdocs_suppressing_warnings.html" > Suppressing warnings< / a > < / li >
< li > < a href = "pmd_userdocs_incremental_analysis.html" > Incremental analysis< / a > < / li >
< li > < a href = "pmd_userdocs_cli_reference.html" > PMD CLI reference< / a > < / li >
< li > < a href = "pmd_userdocs_report_formats.html" > PMD Report formats< / a > < / li >
2022-09-29 15:04:50 +00:00
< li > < a href = "pmd_userdocs_3rdpartyrulesets.html" > 3rd party rulesets< / a > < / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > CPD reference< / a >
< ul >
< li > < a href = "pmd_userdocs_cpd.html" > Copy-paste detection< / a > < / li >
< li > < a href = "pmd_userdocs_cpd_report_formats.html" > CPD Report formats< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Extending PMD< / a >
< ul >
< li > < a href = "pmd_userdocs_extending_writing_rules_intro.html" > Introduction to writing rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_your_first_rule.html" > Your first rule< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_xpath_rules.html" > XPath rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_writing_java_rules.html" > Java rules< / a > < / li >
< li > < a href = "pmd_userdocs_extending_designer_reference.html" > Rule designer reference< / a > < / li >
< li > < a href = "pmd_userdocs_extending_defining_properties.html" > Defining rule properties< / a > < / li >
< li > < a href = "pmd_userdocs_extending_metrics_howto.html" > Using and defining code metrics< / a > < / li >
< li > < a href = "pmd_userdocs_extending_rule_guidelines.html" > Rule guidelines< / a > < / li >
< li > < a href = "pmd_userdocs_extending_testing.html" > Testing your rules< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Tools / Integrations< / a >
< ul >
< li > < a href = "pmd_userdocs_tools_maven.html" > Maven PMD Plugin< / a > < / li >
< li > < a href = "pmd_userdocs_tools_gradle.html" > Gradle< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ant.html" > Ant< / a > < / li >
< li > < a href = "pmd_userdocs_tools_java_api.html" > PMD Java API< / a > < / li >
< li > < a href = "pmd_userdocs_tools_ci.html" > CI integrations< / a > < / li >
< li > < a href = "pmd_userdocs_tools.html" > Other Tools / Integrations< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Rule Reference< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Apex Rules< / a >
< ul >
< li > < a href = "pmd_rules_apex.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_apex_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_apex_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_apex_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_apex_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_apex_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_apex_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_apex_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Ecmascript Rules< / a >
< ul >
< li > < a href = "pmd_rules_ecmascript.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_ecmascript_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
2022-04-28 13:34:56 +00:00
< li class = "subfolders" >
< a href = "#" > HTML Rules< / a >
< ul >
< li > < a href = "pmd_rules_html.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_html_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > Java Rules< / a >
< ul >
< li > < a href = "pmd_rules_java.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_java_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_java_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_java_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_java_documentation.html" > Documentation< / a > < / li >
< li > < a href = "pmd_rules_java_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_java_multithreading.html" > Multithreading< / a > < / li >
< li > < a href = "pmd_rules_java_performance.html" > Performance< / a > < / li >
< li > < a href = "pmd_rules_java_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Java Server Pages Rules< / a >
< ul >
< li > < a href = "pmd_rules_jsp.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_jsp_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_jsp_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_jsp_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_jsp_errorprone.html" > Error Prone< / a > < / li >
< li > < a href = "pmd_rules_jsp_security.html" > Security< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Maven POM Rules< / a >
< ul >
< li > < a href = "pmd_rules_pom.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_pom_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Modelica Rules< / a >
< ul >
< li > < a href = "pmd_rules_modelica.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_modelica_bestpractices.html" > Best Practices< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > PLSQL Rules< / a >
< ul >
< li > < a href = "pmd_rules_plsql.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_plsql_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_plsql_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_plsql_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_plsql_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Salesforce VisualForce Rules< / a >
< ul >
< li > < a href = "pmd_rules_vf.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vf_security.html" > Security< / a > < / li >
< / ul >
< / li >
2022-11-18 15:25:16 +00:00
< li class = "subfolders" >
< a href = "#" > Scala Rules< / a >
< ul >
< li > < a href = "pmd_rules_scala.html" > Index< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > VM Rules< / a >
< ul >
< li > < a href = "pmd_rules_vm.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_vm_bestpractices.html" > Best Practices< / a > < / li >
< li > < a href = "pmd_rules_vm_design.html" > Design< / a > < / li >
< li > < a href = "pmd_rules_vm_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
2022-11-18 15:25:16 +00:00
< li class = "subfolders" >
< a href = "#" > WSDL Rules< / a >
< ul >
< li > < a href = "pmd_rules_wsdl.html" > Index< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > XML Rules< / a >
< ul >
< li > < a href = "pmd_rules_xml.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xml_errorprone.html" > Error Prone< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > XSL Rules< / a >
< ul >
< li > < a href = "pmd_rules_xsl.html" > Index< / a > < / li >
< li > < a href = "pmd_rules_xsl_codestyle.html" > Code Style< / a > < / li >
< li > < a href = "pmd_rules_xsl_performance.html" > Performance< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Language Specific Documentation< / a >
< ul >
< li > < a href = "pmd_languages_jsp.html" > JSP Support< / a > < / li >
2022-03-27 15:04:13 +00:00
< li class = "subfolders" >
< a href = "#" > Java Support< / a >
< ul >
< li > < a href = "pmd_languages_java.html" > Java Versions< / a > < / li >
< li > < a href = "pmd_java_metrics_index.html" > Java Code Metrics< / a > < / li >
< / ul >
< / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_apex_metrics_index.html" > Apex code metrics< / a > < / li >
2021-03-26 08:22:23 +00:00
< li > < a href = "pmd_languages_plsql.html" > PLSQL< / a > < / li >
2021-10-29 17:50:40 +00:00
< li > < a href = "pmd_languages_visualforce.html" > Visualforce< / a > < / li >
2022-03-25 07:44:53 +00:00
< li > < a href = "pmd_languages_xml.html" > XML and XML dialects< / a > < / li >
2022-04-28 13:34:56 +00:00
< li > < a href = "pmd_languages_html.html" > HTML< / a > < / li >
2022-07-01 07:55:16 +00:00
< li > < a href = "pmd_languages_gherkin.html" > Gherkin< / a > < / li >
2020-11-14 09:20:07 +00:00
< / ul >
< / li >
< li >
< a href = "#" > Developer Documentation< / a >
< ul >
< li > < a href = "pmd_devdocs_development.html" > Developer resources< / a > < / li >
< li > < a href = "pmd_devdocs_building.html" > Building PMD from source< / a > < / li >
< li > < a href = "https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target = "_blank" > Contributing< / a > < / li >
< li > < a href = "pmd_devdocs_writing_documentation.html" > Writing documentation< / a > < / li >
< li > < a href = "pmd_devdocs_roadmap.html" > Roadmap< / a > < / li >
< li > < a href = "pmd_devdocs_how_pmd_works.html" > How PMD works< / a > < / li >
< li > < a href = "pmd_devdocs_pmdtester.html" > Pmdtester< / a > < / li >
< li > < a href = "pmd_devdocs_rule_deprecation_policy.html" > Rule Deprecation Policy< / a > < / li >
< li class = "subfolders" >
< a href = "#" > Major contributions< / a >
< ul >
2021-08-27 14:58:36 +00:00
< li > < a href = "pmd_devdocs_major_rule_guidelines.html" > Rule Guidelines< / a > < / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_devdocs_major_adding_new_language.html" > Adding a new language< / a > < / li >
< li > < a href = "pmd_devdocs_major_adding_new_cpd_language.html" > Adding a new CPD language< / a > < / li >
< li > < a href = "pmd_devdocs_major_adding_new_metrics_framework.html" > Adding metrics support to a language< / a > < / li >
< / ul >
< / li >
< li class = "subfolders" >
< a href = "#" > Experimental features< / a >
< ul >
< li > < a href = "pmd_devdocs_experimental_ast_dump.html" > Creating (XML) dump of the AST< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li >
< a href = "#" > Project documentation< / a >
< ul >
< li class = "subfolders" >
< a href = "#" > Trivia about PMD< / a >
< ul >
< li > < a href = "pmd_projectdocs_trivia_news.html" > PMD in the press< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_products.html" > Products & books related to PMD< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_similarprojects.html" > Similar projects< / a > < / li >
< li > < a href = "pmd_projectdocs_trivia_meaning.html" > What does 'PMD' mean?< / a > < / li >
< / ul >
< / li >
< li > < a href = "pmd_projectdocs_faq.html" > FAQ< / a > < / li >
< li > < a href = "license.html" > License< / a > < / li >
< li > < a href = "pmd_projectdocs_credits.html" > Credits< / a > < / li >
< li > < a href = "pmd_release_notes_old.html" > Old release notes< / a > < / li >
2022-09-30 10:03:06 +00:00
< li > < a href = "pmd_projectdocs_decisions.html" > Decisions< / a > < / li >
2020-11-14 09:20:07 +00:00
< li class = "subfolders" >
< a href = "#" > Project management< / a >
< ul >
2021-04-23 20:35:51 +00:00
< li > < a href = "pmd_projectdocs_committers_infrastructure.html" > Infrastructure< / a > < / li >
2020-11-14 09:20:07 +00:00
< li > < a href = "pmd_projectdocs_committers_releasing.html" > Release process< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_merging_pull_requests.html" > Merging pull requests< / a > < / li >
< li > < a href = "pmd_projectdocs_committers_main_landing_page.html" > Main Landing page< / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
<!-- if you aren't using the accordion, uncomment this block:
< p class = "external" >
< a href = "#" id = "collapseAll" > Collapse All< / a > | < a href = "#" id = "expandAll" > Expand All< / a >
< / p >
-->
< / ul >
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted. -->
< script > $ ( "li.active" ) . parents ( 'li' ) . toggleClass ( "active" ) ; < / script >
2022-02-25 09:51:51 +00:00
< / div >
2020-11-14 09:20:07 +00:00
2022-02-25 09:51:51 +00:00
<!-- Content Column -->
< div class = "col-md-9" id = "tg-sb-content" >
2022-03-24 11:42:13 +00:00
< header >
< div class = "row" >
< div class = "col-lg-12" >
< a href = "./" role = "button"
>< i class = "fa fa-home fa-lg" > < /i
>< / a >
» Installation and basic CLI usage
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/installation.md"
class="pull-right"
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< / div >
< hr / >
< / header >
< div class = "post-header" >
2020-11-14 09:20:07 +00:00
< h1 class = "post-title-main" > Installation and basic CLI usage< / h1 >
< / div >
2022-03-24 11:42:13 +00:00
< div class = "post-content" data-github-edit-url = "https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/installation.md" >
2020-11-14 09:20:07 +00:00
< div class = "summary" > Sums up the first steps to set up a CLI installation and get started using PMD< / div >
2022-02-25 09:51:51 +00:00
< div id = "inline-toc" > <!-- empty, move TOC here when screen size too small --> < / div >
2020-11-14 09:20:07 +00:00
< h2 id = "how-to-install-pmd-and-cpd" > How to install PMD and CPD< / h2 >
< h3 id = "requirements" > Requirements< / h3 >
< ul >
2021-05-21 09:34:27 +00:00
< li >
< p > < a href = "http://www.oracle.com/technetwork/java/javase/downloads/index.html" > Java JRE< / a > ,
OpenJDK from < a href = "https://www.azul.com/downloads/zulu-community/" > Azul< / a >
or < a href = "https://adoptopenjdk.net/" > AdoptOpenJDK< / a > 1.7 or higher.< / p >
2022-10-06 16:23:23 +00:00
< p > < strong > Note:< / strong > For analyzing Apex, HTML, JavaScript, Scala or VisualForce or running the < a href = "pmd_userdocs_extending_designer_reference.html" > Designer< / a >
2021-05-21 09:34:27 +00:00
at least Java 8 is required.< / p >
< / li >
2020-11-14 09:20:07 +00:00
< li >
< p > A zip archiver, e.g.:< / p >
< ul >
< li > For Windows: < a href = "http://winzip.com" > Winzip< / a > or the free < a href = "http://www.7-zip.org/" > 7-zip< / a > < / li >
< li > For Linux / Unix: < a href = "http://infozip.sourceforge.net/" > InfoZip< / a > < / li >
< / ul >
< / li >
< / ul >
2022-11-10 15:52:28 +00:00
< div class = "alert alert-info" role = "alert" > < i class = "fa fa-info-circle" > < / i > < b > Note:< / b > For executing the Designer (./run.sh designer) using < a href = "http://jdk.java.net" > OpenJDK< / a > or Java 11, you need additionally < a href = "https://gluonhq.com/products/javafx/" > JavaFX< / a > . Download it, extract it and set the environment variable JAVAFX_HOME pointing at that directory.< / div >
2020-11-14 09:20:07 +00:00
< h3 id = "installation" > Installation< / h3 >
< p > PMD is distributed as a zip archive, which includes both < a href = "#running-pmd-via-command-line" > PMD< / a > and < a href = "pmd_userdocs_cpd.html" > CPD< / a > .
You can download the latest binary distribution from < a href = "https://github.com/pmd/pmd/releases" > the github releases page< / a > .< / p >
< p > Unzip it into any directory, optionally add the < code class = "language-plaintext highlighter-rouge" > bin< / code > subdirectory in your < code class = "language-plaintext highlighter-rouge" > PATH< / code > , and you’ < / p >
< h2 id = "running-pmd-via-command-line" > Running PMD via command line< / h2 >
< div class = "bs-callout bs-callout-primary" > PMD comes with several command line utilities, like CPD, the rule designer or PMD itself.
On Unix, you can run any of them using the script < code class = "language-plaintext highlighter-rouge" > run.sh< / code > , located inside the < code class = "language-plaintext highlighter-rouge" > bin/< / code >
directory of the PMD distribution. The first argument is the name of the utility you want
to execute (‘ ’ ‘ ’ < code class = "language-plaintext highlighter-rouge" > run.sh pmd< / code > . The rest of
the arguments are specific to the utility used.< br / > < br / >
On Windows, each utility has its own startup script, e.g. < code class = "language-plaintext highlighter-rouge" > pmd.bat< / code > , < code class = "language-plaintext highlighter-rouge" > cpd.bat< / code > .< / div >
< p > The PMD command (< code class = "language-plaintext highlighter-rouge" > pmd.bat< / code > or < code class = "language-plaintext highlighter-rouge" > run.sh pmd< / code > ) requires two options:< / p >
< ul >
2022-12-31 14:44:28 +00:00
< li > < code class = "language-plaintext highlighter-rouge" > -d < path> < / code > : Root directory for sources to be analyzed. This can be a single file name, a directory,
or a jar or zip file containing the sources.< / li >
2020-11-14 09:20:07 +00:00
< li > < code class = "language-plaintext highlighter-rouge" > -R < path> < / code > : the ruleset file you want to use. PMD uses xml configuration files, called < em > rulesets< / em > , which specify
which rules to execute on your sources. You can also run a single rule by referencing it using its < em > category< / em > and
name (more details < a href = "pmd_userdocs_making_rulesets.html#referencing-a-single-rule" > here< / a > ). For example, you can check for unnecessary
modifiers on Java sources with < code class = "language-plaintext highlighter-rouge" > -R category/java/codestyle.xml/UnnecessaryModifier< / code > .< / li >
< / ul >
< div class = "alert alert-info" role = "alert" > < i class = "fa fa-info-circle" > < / i > < b > Note:< / b > At the moment the formerly provided rulesets (eg < code class = "language-plaintext highlighter-rouge" > rulesets/java/basic.xml< / code > ) are deprecated,
though you can still use them. PMD includes a quickstart ruleset for some languages (currently, Java)
as base configurations, which you can reference as e.g. < code class = "language-plaintext highlighter-rouge" > rulesets/java/quickstart.xml< / code > . You’
encouraged to < a href = "pmd_userdocs_making_rulesets.html" > create your own ruleset< / a > from the start though.< / div >
< p > Additionally, the following options, are specified most of the time even though they’ < / p >
< ul >
< li > < code class = "language-plaintext highlighter-rouge" > -f < format> < / code > : report format. PMD supports many report formats out of the box. You may want to start with the basic
< code class = "language-plaintext highlighter-rouge" > text< / code > format (default) or < code class = "language-plaintext highlighter-rouge" > xml< / code > format. The supported formats are < a href = "pmd_userdocs_cli_reference.html#available-report-formats" > documented here< / a > .< / li >
2021-11-26 08:47:44 +00:00
< li > < code class = "language-plaintext highlighter-rouge" > --aux-classpath < classpath> < / code > : class path containing the compiled class files of the analysed Java sources, if any.
2020-11-14 09:20:07 +00:00
Setting this up correctly allows PMD to do much deeper analysis using reflection. Some rules, such as < a href = "pmd_rules_java_bestpractices.html#missingoverride" > MissingOverride< / a > ,
require it to function properly.< / li >
< / ul >
< div class = "alert alert-success" role = "alert" > < i class = "fa fa-check-square-o" > < / i > < b > Tip:< / b > A full CLI reference, including report formats, is available under < a href = "pmd_userdocs_cli_reference.html" > PMD CLI Reference< / a > < / div >
< h3 id = "sample-usage" > Sample usage< / h3 >
< p > The following shows a sample run of PMD with the < code class = "language-plaintext highlighter-rouge" > text< / code > format:< / p >
< div class = "text-left" >
< ul class = "nav nav-tabs" role = "tablist" >
< li role = "presentation" class = "active" > < a href = "#linux" aria-controls = "linux / unix" role = "tab" data-toggle = "tab" > Linux / Unix< / a > < / li >
< li role = "presentation" > < a href = "#windows" aria-controls = "windows" role = "tab" data-toggle = "tab" > Windows< / a > < / li >
< / ul >
< div class = "tab-content" >
< div role = "tabpanel" class = "tab-pane active" id = "linux" >
2023-01-28 09:59:31 +00:00
< figure class = "highlight" > < pre > < code class = "language-bash" data-lang = "bash" > < span class = "gp" > ~ $ < / span > < span class = "s2" > cd< / span > ~/bin/pmd-bin-6.54.0/bin
2020-11-14 09:20:07 +00:00
< span class = "gp" > ~/.../bin $ < / span > < span class = "s2" > ./run.sh< / span > pmd -d ../../../src/main/java/ -f text -R rulesets/java/quickstart.xml
.../src/main/java/com/me/RuleSet.java:123 These nested if statements could be combined
.../src/main/java/com/me/RuleSet.java:231 Useless parentheses.
.../src/main/java/com/me/RuleSet.java:232 Useless parentheses.
.../src/main/java/com/me/RuleSet.java:357 These nested if statements could be combined
.../src/main/java/com/me/RuleSetWriter.java:66 Avoid empty catch blocks< / code > < / pre > < / figure >
< / div >
< div role = "tabpanel" class = "tab-pane" id = "windows" >
2023-01-28 09:59:31 +00:00
< figure class = "highlight" > < pre > < code class = "language-bash" data-lang = "bash" > < span class = "gp" > C:\ > < / span > < span class = "s2" > cd< / span > C:\pmd-bin-6.54.0\bin
2020-11-14 09:20:07 +00:00
< span class = "gp" > C:\...\bin > < / span > < span class = "s2" > .\pmd.bat< / span > -d ..\..\src\main\java\ -f text -R rulesets/java/quickstart.xml
.../src/main/java/com/me/RuleSet.java:123 These nested if statements could be combined
.../src/main/java/com/me/RuleSet.java:231 Useless parentheses.
.../src/main/java/com/me/RuleSet.java:232 Useless parentheses.
.../src/main/java/com/me/RuleSet.java:357 These nested if statements could be combined
.../src/main/java/com/me/RuleSetWriter.java:66 Avoid empty catch blocks< / code > < / pre > < / figure >
< / div >
< / div >
< / div >
< h2 id = "running-cpd-via-command-line" > Running CPD via command line< / h2 >
< div class = "alert alert-info" role = "alert" > < i class = "fa fa-info-circle" > < / i > < b > Note:< / b > CPD supports Java, JSP, C, C++, C#, Fortran and PHP source code, among other languages.
For the full list, see < a href = "pmd_userdocs_cpd.html#supported-languages" > Supported Languages< / a > .< / div >
< p > Like for PMD, CPD is started on Unix by < code class = "language-plaintext highlighter-rouge" > run.sh cpd< / code > and on Windows by < code class = "language-plaintext highlighter-rouge" > cpd.bat< / code > .< / p >
< p > There are two required parameters:< / p >
< ul >
< li > < code class = "language-plaintext highlighter-rouge" > --files < path> < / code > : path to the sources to analyse. This can be a file name, a
directory or a jar or zip file containing the sources.< / li >
< li > < code class = "language-plaintext highlighter-rouge" > --minimum-tokens < number> < / code > : the minimum token length which should be reported as a duplicate.< / li >
< / ul >
< div class = "alert alert-success" role = "alert" > < i class = "fa fa-check-square-o" > < / i > < b > Tip:< / b > CPD’
< a href = "pmd_userdocs_cpd.html" > CPD documentation page< / a > < / div >
< h3 id = "sample-usage-1" > Sample usage< / h3 >
< p > The following shows a sample run of CPD with the < code class = "language-plaintext highlighter-rouge" > text< / code > format:< / p >
< div class = "text-left" >
< ul class = "nav nav-tabs" role = "tablist" >
< li role = "presentation" class = "active" > < a href = "#cpd-linux" aria-controls = "linux / unix" role = "tab" data-toggle = "tab" > Linux / Unix< / a > < / li >
< li role = "presentation" > < a href = "#cpd-windows" aria-controls = "windows" role = "tab" data-toggle = "tab" > Windows< / a > < / li >
< / ul >
< div class = "tab-content" >
< div role = "tabpanel" class = "tab-pane active" id = "cpd-linux" >
2023-01-28 09:59:31 +00:00
< figure class = "highlight" > < pre > < code class = "language-bash" data-lang = "bash" > < span class = "gp" > ~ $ < / span > < span class = "s2" > cd< / span > ~/bin/pmd-bin-6.54.0/bin
2020-11-14 09:20:07 +00:00
< span class = "gp" > ~/.../bin $ < / span > < span class = "s2" > ./run.sh< / span > cpd --minimum-tokens 100 --files /home/me/src
Found a 7 line (110 tokens) duplication in the following files:
Starting at line 579 of /home/me/src/test/java/foo/FooTypeTest.java
Starting at line 586 of /home/me/src/test/java/foo/FooTypeTest.java
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());< / code > < / pre > < / figure >
< / div >
< div role = "tabpanel" class = "tab-pane" id = "cpd-windows" >
2023-01-28 09:59:31 +00:00
< figure class = "highlight" > < pre > < code class = "language-bash" data-lang = "bash" > < span class = "gp" > C:\ > < / span > < span class = "s2" > cd< / span > C:\pmd-bin-6.54.0\bin
2020-11-14 09:20:07 +00:00
< span class = "gp" > C:\...\bin > < / span > < span class = "s2" > .\cpd.bat< / span > --minimum-tokens 100 --files c:\temp\src
Found a 7 line (110 tokens) duplication in the following files:
Starting at line 579 of c:\temp\src\test\java\foo\FooTypeTest.java
Starting at line 586 of c:\temp\src\test\java\foo\FooTypeTest.java
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());
assertEquals(Boolean.TYPE, expressions.get(index++).getType());< / code > < / pre > < / figure >
< / div >
< / div >
< / div >
< div class = "tags" >
< b > Tags: < / b >
< a href = "tag_getting_started.html" class = "btn btn-default navbar-btn cursorNorm" role = "button" > getting_started< / a >
< a href = "tag_userdocs.html" class = "btn btn-default navbar-btn cursorNorm" role = "button" > userdocs< / a >
< / div >
< / div >
< footer >
2022-03-24 11:42:13 +00:00
< hr / >
< div >
This documentation is written in markdown. < br / >
If there is something missing or can be improved, edit this page on
github and create a PR:
< a
target="_blank"
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/userdocs/installation.md"
role="button"
>< i class = "fa fa-github fa-lg" > < / i > Edit on GitHub< /a
>
< / div >
< hr / >
< div class = "row" >
< div class = "col-lg-12 footer" >
2023-01-01 04:26:09 +00:00
© 2023 PMD Open Source Project. All rights
2022-03-24 11:42:13 +00:00
reserved. < br / >
2023-01-28 09:59:31 +00:00
Site last generated: Jan 28, 2023 < br / >
2022-03-24 11:42:13 +00:00
< p >
< img src = "images/pmd-logo-small.png" alt = "Company
logo"/>
< / p >
< / div >
< / div >
2020-11-14 09:20:07 +00:00
< / footer >
2022-02-25 09:51:51 +00:00
< / div >
<!-- /.row -->
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.container -->
< / div >
<!-- Sticky TOC column -->
< div class = "toc-col" >
2022-03-24 11:42:13 +00:00
< div id = "toc" > < / div >
2020-11-14 09:20:07 +00:00
< / div >
2022-02-25 09:51:51 +00:00
<!-- /.toc - container - wrapper -->
2020-11-14 09:20:07 +00:00
< / div >
< / div >
< / body >
< / html >
