pipeline get-template

Returns code as a YAML template or an Orchestration Flow JSON that contains the specified pipeline's description, parameters, and metadata. You must specify either project_id or space_id.

Syntax

cpd-cli pipeline get-template \
--pipeline-id=<pipeline-identifier> \
[--format=<pipeline-format>] \
[--project-id=<project-id>]\
[--space-id=<space-identifier>] \
[--version=<version>] \
[--volatile=<placeholder-text>]

Options

Table 1: Command options
Option Description
--format The format of the code to retrieve.
Status
Optional.
Syntax
--format=<pipeline-format>
Default value
The default value is template. Allowable values are template, flow, all.
Input type
string
--pipeline-id Specify a pipeline identifier.
Status
Required.
Syntax
--pipeline-id=<pipeline-identifier>
Default value
No default.
Input type
string
--project-id Specify an IBM Software Hub project instance.
Status
Optional.
Syntax
--project-id=<project-id>
Default value
No default.
Input type
string
Valid values
A valid project identifier.
--space-id Specify a space identifier.
Status
Optional.
Syntax
--space-id=<space-identifier>
Default value
No default.
Input type
string
--version Display the cpdctl command version information.
Status
Optional.
Syntax
--version=<version>
Default value
No default.
Input type
string
--volatile Work-in-progress pipeline versions can be updated, with this option set to true, multiple times before committed as a finished state. When set to true, indicates that the version is a work-in-progress. If the --volatile option is used while the default version is already volatile, it updates that version instead of creating a new one. If the --volatile option is not used while a volatile version is the default one, upload fails with an error.
Status
Optional.
Syntax
--volatile=<placeholder-text>
Default value
No default.
Input type
Boolean