fallow explain

CLI reference for fallow explain. Print rule rationale, examples, fix guidance, and docs links for one issue type without running analysis.

Explain one issue type without running analysis. This is useful for agents and CI bots that need a compact rule guide before deciding whether to fix, suppress, or configure a finding.

fallow explain unused-export
fallow explain fallow/code-duplication --format json --quiet

Arguments

Argument	Description
<issue-type>	Issue type token or rule id, for example unused-export, fallow/unused-dependency, high-complexity, or code-duplication. Common plural aliases such as unused-exports are accepted.

Output

Format	Description
human	Rule id, summary, rationale, example, fix guidance, and docs URL.
json	Machine-readable object with the same fields. Use this from agents.

$ fallow explain unused-export --format json --quiet

{
  "id": "fallow/unused-export",
  "name": "Unused Exports",
  "summary": "Export is never imported",
  "rationale": "Named exports that are never imported by any other module in the project. Includes both direct exports and re-exports through barrel files. The export may still be used locally within the same file.",
  "example": "export const formatPrice = ... exists in src/money.ts, but no module imports formatPrice.",
  "how_to_fix": "Remove the export or make it file-local. If it is public API, import it from an entry point or add an intentional suppression with context.",
  "docs": "https://docs.fallow.tools/explanations/dead-code#unused-exports"
}

MCP tool

The fallow_explain MCP tool wraps fallow explain <issue-type> --format json --quiet:

Example request

{
  "tool": "fallow_explain",
  "arguments": {
    "issue_type": "unused-export"
  }
}

Use it when an agent needs rule-specific context before applying a fix or suppression.