---
title: influx template
description: The influx template command summarizes the specified InfluxDB template.
url: https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/template/
estimated_tokens: 1301
product: InfluxDB Cloud (TSM)
version: cloud
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb/cloud/reference/cli/influx/template/
date: '2025-04-02T15:54:32-06:00'
lastmod: '2025-04-02T15:54:32-06:00'
---

* influx CLI 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](/influxdb/cloud/reference/cli/influx/template/validate)|Validate a template|

## Flags

|Flag|                         |                           Description                            |Input Type |Maps to [?](/influxdb/cloud/reference/cli/influx/#view-mapped-environment-variables)|
|----|-------------------------|------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------|
|    |    `--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

#### Authentication credentials

The examples below assume your InfluxDB **host**, **organization**, and **token** are
provided by either the [active `influx` CLI configuration](/influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials) or by environment variables (`INFLUX_HOST`, `INFLUX_ORG`, and `INFLUX_TOKEN`).
If you do not have a CLI configuration set up or the environment variables set, include these required credentials for each command with the following flags:

* `--host`: [InfluxDB host](/influxdb/cloud/reference/urls/)
* `-o, --org` or `--org-id`: InfluxDB organization name or ID
* `-t, --token`: InfluxDB API token

**Summarize InfluxDB Templates:**

* [from a local file](#summarize-an-influxdb-template-from-a-local-file)
* [from multiple files](#summarize-influxdb-templates-from-multiple-files)
* [from a URL](#summarize-an-influxdb-template-from-a-url)
* [from a directory](#summarize-all-influxdb-templates-in-a-directory)
* [using a specific encoding](#specify-the-encoding-of-the-influxdb-template-to-summarize)

##### Summarize an InfluxDB template from a local file

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

##### Summarize InfluxDB templates from multiple files

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

##### Summarize an InfluxDB template from a URL

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

##### Summarize all InfluxDB templates in a directory

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

##### Specify the encoding of the InfluxDB template to summarize

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

#### Related

* [InfluxDB templates](/influxdb/cloud/tools/influxdb-templates/)
* [influx CLI—Provide required authentication credentials](/influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials)
* [influx CLI—Flag patterns and conventions](/influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions)

[templates](/influxdb/cloud/tags/templates/)
| Subcommand | Description |
| --- | --- |
| Subcommand | Description |
| validate | Validate a template |

| Flag |  | Description | Input Type | Maps to  ? |
| --- | --- | --- | --- | --- |
| Flag |  | Description | Input Type | Maps to  ? |
|  | --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 |  |  |