infer-help(1)

💖 infer-help(1) 💖

Hiii bestie! Welcome to the Infer Help manual — aka infer-help(1) — the page that shows and generates documentation. It’s giving utility icon energy, and we’re gonna walk through every flag together. 🫶✨

---

✨ NAME ✨

infer-help — show and generate documentation, no cap 💅

🌸 SYNOPSIS 🌸

infer help
infer help --help-checker checker1 ... --help-checker checkerN
infer help --help-issue-type ISSUE_TYPE1 ... --help-issue-type ISSUE_TYPEN
infer help --list-checkers
infer help --list-issue-types
infer help --write-website website_root

🦋 DESCRIPTION 🦋

Okay so here’s the tea: with no arguments, infer-help shows you the Infer manual, just like infer --help does. Lowkey iconic. 👑

For each -help-checker or --help-issue-type option passed, it displays information about the given checker or issue type. If you’re like “bestie which one?”, the list options below have your back. 🎀

If --list-checkers is passed, it lists all available checkers. If --list-issue-types is passed, it lists all issue types. Simple, useful, slay. ✨

Use --write-website to build some of the documentation for the fbinfer.com website. It’s used in scripts, and fr fr it’s not meant to be used except when publishing content to fbinfer.com. 🙈

💅 OPTIONS 💅

• --help — Show this manual. The classic “help me help you” moment. 🫶
• --help-checker +checker-id — Show information about a checker, for example pulse. To see the list of all checkers, see --list-checkers. 👑
• --help-format { auto | groff | pager | plain } — Show this help in the specified format. auto sets the format to plain if the environment variable TERM is "dumb" or undefined, and to pager otherwise. 🦋
• --help-full — Show this manual with all internal options in the INTERNAL OPTIONS section. The full lore, bestie. ✨
• --help-issue-type +UNIQUE_ID — Show information about an issue type, for example NULL_DEREFERENCE. To see the list of all issue types, see --list-issue-types. 🎀
• --list-categories — Activates: Show the list of all categories of issue types that infer might report. (Conversely: --no-list-categories) 🌈
• --list-checkers — Activates: Show the list of all available checkers. (Conversely: --no-list-checkers) 🔥
• --list-issue-types — Activates: Show the list of all issue types that infer might report. (Conversely: --no-list-issue-types) ⭐
• --write-website path_to_website_dir — Use to write website files documenting issue types and checkers under path_to_website_dir/. Meant to be used within the Infer directory to generate its website at fbinfer.com at website/. 🧚

🌈 ENVIRONMENT 🌈

• INFER_ARGS, INFERCONFIG, INFER_STRICT_MODE — See the ENVIRONMENT section in the manual of infer(1). That’s the whole vibe check for env vars here. 🍓

🧚 FILES 🧚

• .inferconfig — See the FILES section in the manual of infer(1). 🎀

---

This page came from v1.3.0-unknown, dated 2026-10-27. Bye bestie — go show and generate those docs and serve main character energy 💅✨