Skip to content
Fallow home
All docs pages

fallow config-schema: print the config JSON Schema

Print the JSON Schema of the fallow config file. Use it for editor autocomplete and validation of .fallowrc.json, .fallowrc.jsonc, and fallow.toml.

fallow config-schema prints the JSON Schema of the fallow configuration. The schema describes every config field, with its type, default, and description. Editors use it for autocomplete and validation. An agent reads it to learn the valid keys before it writes a config.

fallow config-schema
fallow config-schema > schema.json

The output is always JSON on stdout, whatever the value of --format. The command does not read your project or your config file.

Use the schema in your editor

Point the $schema field of a JSON config file at one of these sources:

SourceValue of $schema
The npm package./node_modules/fallow/schema.json. This file matches the fallow version that you installed.
The fallow repositoryhttps://raw.githubusercontent.com/fallow-rs/fallow/main/schema.json
A local fileThe path of the file that fallow config-schema > schema.json wrote.
{
  "$schema": "./node_modules/fallow/schema.json",
  "entry": ["src/index.ts"]
}

The npm package also exports the file as fallow/schema.json. The output of fallow config-schema is equal to the file in the npm package of the same version.

Options

fallow config-schema has no flags of its own. The global flags do not change the output.

CommandPrints the schema of
fallow config-schemaThe fallow config file.
fallow plugin-schemaExternal plugin files.
fallow rule-pack-schemaRule pack files.
fallow schemaNot a JSON Schema: the capability manifest of the CLI.

The MCP server serves the same schema as the fallow://schema/config resource.

See also