FINDBUGS(1)

🦋 findbugs(1) 🦋

okay bestie, sit down, hydrate, because we are about to talk about findbugs — yes, the static Java code analyzer, and yes she is that girl. 💅

---

✨ NAME ✨

findbugs — Static Java Code Analyzer 👑

---

🌈 SYNOPSIS 🌈

findbugs [general options] -textui [command line options...]
[jar/zip/class files, directories...]

like… you give her some general options, you say -textui, you give her command line options, and then you hand her your jar/zip/class files and directories. that's the whole vibe. 🫶

---

💖 DESCRIPTION 💖

No files to be analyzed

(i know. i KNOW. that's literally what it says. mysterious, minimal, unbothered. she contains multitudes. 😭)

---

🎀 General options:

• -jvmArgs args — pass args straight through to the JVM, no notes
• -maxHeap size — biggest Java heap size, in megabytes (default=768) — she needs her space, okay?
• -javahome <dir> — tell her where the JRE lives

---

💜 General FindBugs options:

• -project <project> — analyze the project you named
• -home <home directory> — point her at the FindBugs home directory
• -pluginList <jar1[:jar2...]> — give her a list of plugin Jar files to load
• -effort[:min|less|default|more|max] — set the analysis effort level, pick your fighter
• -adjustExperimental — lower the priority of experimental Bug Patterns
• -workHard — make sure analysis effort is at least default, bestie is grinding
• -conserveSpace — same as -effort:min (it's here for backward compatibility, an icon of tradition)
• -showPlugins — show the list of available detector plugins
• -userPrefs <filename> — user preferences file, e.g. /path/to/project/.settings/edu.umd.cs.findbugs.core.prefs for Eclipse projects

---

🍓 Output options:

• -timestampNow — set the timestamp of results to the current time ⏰
• -quiet — suppress error messages (shhh, she's in her silent era)
• -longBugCodes — report long bug codes
• -progress — display progress in the terminal window so you're not just staring at nothing
• -release <release name> — set the release name of the analyzed application
• -experimental — report of any confidence level, including experimental bug patterns
• -low — report warnings of any confidence level
• -medium — report only medium and high confidence warnings [default] ✨
• -high — report only high confidence warnings
• -maxRank <rank> — only report issues with a bug rank at least as scary as the one you provided 😱
• -dontCombineWarnings — don't combine warnings that differ only in line number
• -sortByClass — sort warnings by class
• -xml[:withMessages] — XML output (optionally with messages)
• -xdocs — xdoc XML output to use with Apache Maven
• -html[:stylesheet] — generate HTML output (the default stylesheet is default.xsl)
• -emacs — use emacs reporting format
• -relaxed — Relaxed reporting mode (more false positives!)
• -train[:outputDir] — save training data (experimental); the output dir defaults to .
• -useTraining[:inputDir] — use training data (experimental); the input dir defaults to .
• -redoAnalysis <filename> — redo analysis using configuration from a previous analysis
• -sourceInfo <filename> — specify source info file (line numbers for fields/classes)
• -projectName <project name> — descriptive name of the project
• -reanalyze <filename> — redo analysis in the provided file
• -output <filename> — save output in the named file
• -nested[:true|false] — analyze nested jar/zip archives (default=true)

---

🌸 Output filtering options:

• -bugCategories <cat1[,cat2...]> — only report bugs in the categories you listed
• -onlyAnalyze <classes/packages> — only analyze the given classes and packages; end with .* to indicate classes in a package, .- to indicate a package prefix
• -excludeBugs <baseline bugs> — exclude bugs that are also reported in the baseline xml output
• -exclude <filter file> — exclude bugs matching the given filter
• -include <filter file> — include only bugs matching the given filter
• -applySuppression — exclude any bugs that match the suppression filter loaded from an fbp file

---

🧚 Detector (visitor) configuration options:

• -visitors <v1[,v2...]> — run only the named visitors
• -omitVisitors <v1[,v2...]> — omit the named visitors
• -chooseVisitors <+v1,-v2,...> — selectively enable/disable detectors
• -choosePlugins <+p1,-p2,...> — selectively enable/disable plugins
• -adjustPriority <v1=(raise|lower)[,...]> — raise/lower the priority of warnings for the given visitor(s)

---

👑 Project configuration options:

• -auxclasspath <classpath> — set the aux classpath for analysis
• -auxclasspathFromInput — read the aux classpath from standard input
• -auxclasspathFromFile <filepath> — read aux classpaths from a designated file
• -sourcepath <source path> — set the source path for the analyzed classes
• -exitcode — set the exit code of the process
• -noClassOk — output an empty warning file if no classes are specified
• -xargs — get the list of classfiles/jarfiles from standard input rather than the command line
• -analyzeFromFile <filepath> — get the list of class/jar files from a designated file
• -cloud <id> — set the cloud id ☁️
• -cloudProperty <key=value> — set a cloud property
• -bugReporters <name,name2,-name3> — bug reporter decorators to explicitly enable/disable
• -printConfiguration — print configuration and exit, without running analysis
• -version — print version, check for updates and exit, without running analysis

---

💀 SEE ALSO 💀

the full documentation for findbugs is maintained as a Texinfo manual. if the info and findbugs programs are properly installed at your site, then this command

info findbugs

should give you access to the complete manual. iykyk 🫶

---

and that's the whole page bestie, no cap, every flag accounted for 💖

this was findbugs 3.1.0-dev-20180312-UNK... from March 2018 — yeah she's vintage, she's archive-core, and she ate. mwah. 💅✨