Docs

amfelt template validate

Check the SQL templates you have customized.

Reads every template under the project’s templates/ directory and reports what is wrong with each one, without contacting a database or running a pipeline. Two things are checked: the template has to be valid, and everything it reads from the template context has to be part of the published contract. Relying on anything outside that contract is what breaks silently when a plugin is upgraded, which is exactly what this catches.

Checking the generated SQL against your actual warehouse needs credentials and is a separate step; this command is safe to run anywhere, including in CI.

Every problem found is printed and the command then fails, so a pull request that breaks a template is caught before it is deployed. Committing a broken template is never prevented — it stays in git where you can read it, diff it and revert it — but it will stop a pipeline run rather than be silently replaced by the plugin’s own template.

Usage  

amfelt template validate [flags]

Examples  

template validate
Checks the templates for the project in the current directory.

template validate --path pcf/PCF-postgres.yaml
Checks the templates for the project defined by the given project file.

Flags  

FlagTypeDefaultDescription
--pathstringamfelt.yamlpath of the Amfelt project file

Global flags  

FlagTypeDefaultDescription
--amfelt-dirstring.amfeltdirectory for workspace files (such as plugins); does not move agent identity (controlled by AMFELT_DIR)
--configstring—directory or filename of the application configuration
-f, --formatstringdefaultlog format to use; either default, pretty, or json
-l, --levelstringinfominimum log level to display; either error, warn, info, or debug
-v, --verboseboolfalsetrigger to use verbose logging

See also  


Generated from amfelt v5.6.3.


Last updated on November 1, 2026