The output is always JSON, regardless of
--format.Top-level blocks
| Block | Contents |
|---|---|
manifest_version | Manifest shape discriminator (currently "1"). Gate on it when generating docs from the output. |
version | The fallow CLI version that produced the manifest. |
commands, global_flags | Every CLI command and flag with type, default, and description, derived live from the CLI definition. |
issue_types | One row per reportable issue type across all analyses (see below). |
mcp_tools | Every MCP server tool with a kind grouping (analysis, trace, fix, introspection, runtime-coverage, composition), a one-line description, key_params (a curated subset; the live MCP list_tools schemas are authoritative), license plus license_note, and read_only. |
plugins | Built-in framework plugin count and names, derived live from the plugin registry. |
environment_variables | Every user-facing FALLOW_* variable with a one-line description. |
output_formats, exit_codes, severity_levels, suppression_comments | Output and exit-code contract reference. |
Issue type rows
Eachissue_types entry describes one reportable issue type:
| Field | Meaning |
|---|---|
id | Bare issue-type identifier (e.g. unused-file, high-crap-score). |
rule_id | The SARIF rule id (e.g. fallow/unused-file, security/sql-injection). |
command | The subcommand that reports it (dead-code, health, dupes, flags, security). |
category | Coarse grouping (Dead code, Dependencies, Architecture, Health, Duplication, Security, …). |
filter_flag | CLI flag that scopes output to this issue type, or null when none exists. |
fixable | Whether fallow fix can auto-fix it. |
suppressible / suppress_comment | Whether an inline suppression comment applies, and the exact copy-pasteable comment. The token is verified to round-trip through fallow’s suppression parser, so a copied comment never silently no-ops. |
note | Caveats (production-mode-only types, shared filter flags, config prerequisites). |
license / license_note | free or freemium; runtime-coverage rows carry the nuance that a single local capture is free while continuous monitoring requires a license. |
docs_url | Deep link into these docs. |
null when not applicable), never absent.
Examples
See also
fallow explain
Rationale, examples, and fix guidance for one issue type.
MCP server
The MCP tools the manifest describes, with full input schemas.
Environment variables
Prose reference for the variables in the manifest.
fallow list
Project-specific introspection: discovered files, entry points, active plugins.