Skip to main content
Dump fallow’s complete capability manifest as machine-readable JSON. This is the single source of truth an AI agent (or doc generator) can read to learn everything fallow can do: every command and flag, every issue type, every MCP tool, the built-in framework plugins, and the user-facing environment variables.
fallow schema
The output is always JSON, regardless of --format.
The manifest is also the source the agent-skill tables are generated from (the command, issue-type, and MCP-tool tables in the npm package’s bundled SKILL.md regenerate from it at release time), and this docs site serves an auto-generated llms.txt index alongside it for agent consumption.

Top-level blocks

BlockContents
manifest_versionManifest shape discriminator (currently "1"). Gate on it when generating docs from the output.
versionThe fallow CLI version that produced the manifest.
commands, global_flagsEvery CLI command and flag with type, default, and description, derived live from the CLI definition.
issue_typesOne row per reportable issue type across all analyses (see below).
mcp_toolsEvery 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.
pluginsBuilt-in framework plugin count and names, derived live from the plugin registry.
environment_variablesEvery user-facing FALLOW_* variable with a one-line description.
output_formats, exit_codes, severity_levels, suppression_commentsOutput and exit-code contract reference.

Issue type rows

Each issue_types entry describes one reportable issue type:
FieldMeaning
idBare issue-type identifier (e.g. unused-file, high-crap-score).
rule_idThe SARIF rule id (e.g. fallow/unused-file, security/sql-injection).
commandThe subcommand that reports it (dead-code, health, dupes, flags, security).
categoryCoarse grouping (Dead code, Dependencies, Architecture, Health, Duplication, Security, …).
filter_flagCLI flag that scopes output to this issue type, or null when none exists.
fixableWhether fallow fix can auto-fix it.
suppressible / suppress_commentWhether 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.
noteCaveats (production-mode-only types, shared filter flags, config prerequisites).
license / license_notefree or freemium; runtime-coverage rows carry the nuance that a single local capture is free while continuous monitoring requires a license.
docs_urlDeep link into these docs.
Nullable fields are always present (null when not applicable), never absent.

Examples

fallow schema | jq '{
  issue_types: (.issue_types | length),
  mcp_tools: (.mcp_tools.tools | length),
  plugins: .plugins.count
}'

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.