plakar-pkg-manifest.yaml

PLAKAR-PKG-MANIFEST.YAML(5) File Formats Manual PLAKAR-PKG-MANIFEST.YAML(5)

manifest.yaml — Manifest for plugin assemblation

The manifest.yaml file format describes how to package a plugin. No build or compilation is done, so all executables and other files have to be prepared beforehand. It must have a top-level YAML object with the following fields:

The name of the plugins
The plugin version, which doubles as the git tag as well. It must follow semantic versioning and have a ‘v’ prefix, e.g. ‘v1.2.3’.
A YAML array of objects with the following properties:
The connector type, one of importer, exporter, or store.
An array of YAML strings containing all the protocols that the connector supports.
An optional array of YAML strings describing some properties of the connector. These properties are:
Whether paths given to this connector have to be made absolute.
Whether this store backend handles a Kloset in a sigle file, for e.g. a ptar file.
Path to the plugin executable.
An optional array of YAML string. These are extra files that need to be included in the package.
The plugin homepage.
The plugin license.

A sample manifest for the “fs” plugin is as follows:

# manifest.yaml
name: fs
description: file storage but as external plugin
version: 1.0.0
connectors:
- type: importer
  executable: fs-importer
  homepage: https://github.com/PlakarKorp/integration-fs
  license: ISC
  protocols: [fs]
- type: exporter
  executable: fs-exporter
  homepage: https://github.com/PlakarKorp/integration-fs
  license: ISC
  protocols: [fs]
- type: storage
  executable: fs-store
  homepage: https://github.com/PlakarKorp/integration-fs
  license: ISC
  protocols: [fs]

plakar-pkg-create(1)

Plakar July 11, 2025 PLAKAR-PKG-MANIFEST.YAML(5)