docs-v2/content/influxdb/v2/reference/cli/influx/template/_index.md

title	description	menu	weight	influxdb/v2/tags	aliases	cascade
influx template	The `influx template` command summarizes the specified InfluxDB template.	influxdb_v2 name parent influx template influx	101	templates	/influxdb/v2/reference/cli/influx/pkg/summary/	related metadata /influxdb/v2/tools/influxdb-templates/ /influxdb/v2/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials /influxdb/v2/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions influx CLI 2.0.1+ InfluxDB 2.0.1+

The influx template command summarizes the specified InfluxDB template. The command returns information about all resources included in the template.

Usage

influx template [flags]
influx template [command]

Subcommands

Subcommand	Description
validate	Validate a template

Flags

Flag		Description	Input Type	{{< cli/mapped >}}
	--disable-color	Disable color in output
	--disable-table-borders	Disable table borders
-e	--encoding	Template encoding (yaml,yml,json, or jsonnet)	string
-f	--file	Path to template file (supports HTTP(S) URLs or file paths)	stringArray
-h	--help	Help for the template command
	--json	Output data as JSON (default false)		INFLUX_OUTPUT_JSON
-R	--recurse	Recurse through files in the directory specified in -f, --file

Examples

{{< cli/influx-creds-note >}}

Summarize InfluxDB Templates:

• from a local file
• from multiple files
• from a URL
• from a directory
• using a specific encoding

Summarize an InfluxDB template from a local file

influx template --file /path/to/template.yml

Summarize InfluxDB templates from multiple files

influx template \
  --file /path/to/template1.yml \
  --file /path/to/template2.yml

Summarize an InfluxDB template from a URL

influx template --file https://example.com/path/to/template.yml

Summarize all InfluxDB templates in a directory

influx template \
  --file /path/to/template/dir/ \
  --recurse

Specify the encoding of the InfluxDB template to summarize

influx template \
  --file /path/to/template \
  --encoding json