---
title: vela def doc-gen
---

Generate documentation of definitions (Only Terraform typed definitions are supported)

### Synopsis

Generate documentation of definitions

```
vela def doc-gen NAME [flags]
```

### Examples

```
1. Generate documentation for ComponentDefinition alibaba-vpc:
> vela def doc-gen alibaba-vpc -n vela-system
2. Generate documentation for local ComponentDefinition file alibaba-vpc.yaml:
> vela def doc-gen alibaba-vpc.yaml

```

### Options

```
  -h, --help               help for doc-gen
  -n, --namespace string   Specify the namespace of the definition.
```

### Options inherited from parent commands

```
  -y, --yes   Assume yes for all user prompts
```

### SEE ALSO

* [vela def](vela_def)	 - Manage Definitions

#### Go Back to [CLI Commands](vela) Homepage.


###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen).