Skip to content
Fallow home
All docs pages

fallow plugin-schema: print the plugin JSON Schema

Print the JSON Schema of external fallow plugin files. Use it for editor autocomplete and validation while you write a fallow-plugin file.

fallow plugin-schema prints the JSON Schema of an external plugin definition. An external plugin is a fallow-plugin-* file, a file in .fallow/plugins/, or a path in the plugins config field. The schema describes every plugin field, for example enablers, entryPoints, and manifestEntries.

fallow plugin-schema
fallow plugin-schema > plugin-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 plugin file at the schema:

{
  "$schema": "./plugin-schema.json",
  "name": "acme",
  "enablers": ["@acme/framework"],
  "entryPoints": ["src/routes/**/*.ts"]
}

Use one of these values:

SourceValue of $schema
A local fileThe path of the file that fallow plugin-schema > plugin-schema.json wrote, relative to the plugin file.
The fallow repositoryhttps://raw.githubusercontent.com/fallow-rs/fallow/main/plugin-schema.json

The npm package does not include this schema. To get the schema of the fallow version that you installed, use the local file.

Options

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

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

See also