Skip to content

flow template generate

Generate workspace executables and scaffolding from a flowfile template.

Synopsis

Add rendered executables from a flowfile template to a workspace.

The WORKSPACE_NAME is the name of the workspace to initialize the flowfile template in. The FLOWFILE_NAME is the name to give the flowfile (if applicable) when rendering its template.

One of -f or -t must be provided and must point to a valid flowfile template. The -d flag can be used to specify an output directory within the workspace to create the flowfile and its artifacts in.

shell
flow template generate FLOWFILE_NAME [-w WORKSPACE ] [-d OUTPUT_DIR] [-f FILE | -t TEMPLATE] [flags]

Options

FlagTypeDescription
-d, --dirstringOutput directory (within the workspace) to create the flow file and its artifacts. If the directory does not exist, it will be created.
-f, --filestringPath to the template file. It must be a valid flow file template.
-h, --helphelp for generate
-o, --outputstringOutput format. One of: yaml, json, or tui.
-s, --setstringArraySet a form field value by key (KEY=value). Repeat for multiple fields. Fields with a matching key will skip the interactive prompt.
-t, --templatestringRegistered template name. Templates can be registered in the flow configuration file or with 'flow template add'.
-w, --workspacestringWorkspace to create the flow file and its artifacts. Defaults to the current workspace.

Options inherited from parent commands

FlagTypeDescription
-L, --log-levelstringLog verbosity level (debug, info, fatal) (default "info")
--syncSync flow cache and workspaces

See also