Skip to content
FilerFiler Developers

filer-plugins.json

filer-plugins.json sits at the root of a plugin source repository and lists the plugins it publishes:

{
  "name": "my-filer-plugins",
  "displayName": "My Filer Plugins",
  "owner": { "name": "you", "url": "https://github.com/you" },
  "version": "0.1.0",
  "plugins": [
    {
      "name": "word-count",
      "source": "./plugins/word-count",
      "description": "Counts the words in a text file.",
      "version": "0.1.0",
      "category": "utility",
      "tags": ["files"]
    }
  ]
}
Field Required Meaning
name yes source id; kebab-case
displayName, owner { name, url? }, version no shown in Connect
plugins[].name yes must equal the plugin manifest’s name
plugins[].source yes string path to the plugin folder, relative to the repository root ("./plugins/word-count")
plugins[].version yes semver; drives the Updates tab
plugins[].description, category, tags[], fileExtensions[] no listing metadata

plugins[].source is always a string — that’s the only form the installer resolves. See Use your own plugin source for how this file fits into publishing a source, and Manifest reference for the plugin’s own filer-plugin.json that source points at.

Next

Section titled “Next”