mod
Every mod must contain a mod.fp file with a single mod block.
The mod block contains metadata for the mod (including metadata used in the hub site and social media), as well as dependency data. A mod author may edit the mod block directly, but Flowpipe will also edit the file, adding, removing, and modifying dependencies in the file when users add and remove mods via the flowpipe mod commands. For this reason, it is recommended that the mod.fp only contain a mod block; do not add other mod resources (trigger, pipeline, etc) to this file.
The block label is the mod name. Mod names use lower_snake_case. They may contain lowercase chars, numbers, or underscores, and must start with a letter.
Example - Library mod with Hub Metadata
Example - Composite Mod with Dependency
Argument Reference
| Name | Type | Required? | Description |
|---|---|---|---|
| categories | List(String) | Optional | A list of labels, used to categorize mods (such as on the Flowpipe Hub). |
| color | String | Optional | A hexadecimal RGB value to use as the color scheme for the mod on hub.flowpipe.io. |
| database | String | Optional | The database to use as the default for query steps and query triggers. The database may be a connection reference (connection.steampipe.default), a connection string (postgres://steampipe@127.0.0.1:9193/steampipe), or a Pipes workspace (acme/anvils). If not set, the default is the local Steampipe database instance. |
| description | String | Optional | A string containing a short description. |
| documentation | String (Markdown) | Optional | A markdown string containing a long form description, used as documentation for the mod on hub.flowpipe.io. |
| icon | String | Optional | The URL of an icon to use for the mod on hub.flowpipe.io. |
| opengraph | Block | Optional | Block of metadata for use in social media applications that support Opengraph metadata. |
| require | Block | Optional | A block that specifies one or more mod dependencies. |
| tags | Map | Optional | A map of key:value metadata for the mod, used to categorize, search, and filter. |
| title | String | Optional | The display title of the mod. |
opengraph
The opengraph block is an optional block of metadata for use in social media applications that support Opengraph metadata.
| Name | Type | Description |
|---|---|---|
| description | String | The Opengraph description (og:description) of the mod, for use in social media applications. |
| title | String | The Opengraph display title (og:title) of the mod, for use in social media applications. |
Mod Dependencies
A mod may contain a require block to specify version dependencies for the Flowpipe CLI and other mods. While it is possible to edit this section manually, Flowpipe will also modify it (including reordering and removing comments) when you run a flowpipe mod command to install, update, or uninstall a mod.
A mod may specify a dependency on the Flowpipe CLI. Flowpipe will evaluate the dependency when the mod is loaded and will error if the constraint is not met, but it will not install or upgrade the CLI. A flowpipe constraint specifies a minimum version, and does not support semver syntax:
A mod may specify dependencies on other mods. While you can manually edit the mod dependencies in the mod.fp, they are more commonly managed by Flowpipe when you install, update, or uninstall mods via the flowpipe mod commands. The version can be an exact version or a semver string: