Help Center/ CodeArts Pipeline/ CLI Reference/ CLI Command Reference
Updated on 2026-09-16 GMT+08:00

CLI Command Reference

Pipeline Template Management

API Name

Command

Description

Operation

Querying the Template List

hcloud CodeArtsPipeline ListTemplates

This interface is used to query the template list. Pagination query is supported. Fuzzy query by template name is supported.

Go debug

Querying Template Details

hcloud CodeArtsPipeline ShowTemplateDetail

Querying Template Details

Go debug

Pipeline Management

API Name

Command

Description

Operation

Quickly Creating Pipelines and Tasks in Pipelines Based on Templates

hcloud CodeArtsPipeline CreatePipelineByTemplate

Quickly Creating Pipelines and Tasks in Pipelines Based on Templates

Go debug

Checking the Pipeline Creation Status

hcloud CodeArtsPipeline ShowInstanceStatus

Checking the Pipeline Creation Status

Go debug

Execute Pipeline

hcloud CodeArtsPipeline StartNewPipeline

Execute Pipeline

Go debug

Stopping a Pipeline

hcloud CodeArtsPipeline StopPipelineNew

Stopping a Pipeline

Go debug

Obtaining Pipeline Status in Batches

hcloud CodeArtsPipeline BatchShowPipelinesStatus

Obtaining Pipeline Status and Phase Information in Batches

Go debug

Deleting a Pipeline

hcloud CodeArtsPipeline RemovePipeline

Deletes a pipeline based on the pipeline ID.

Go debug

Obtaining the Pipeline List

hcloud CodeArtsPipeline ListPipelineSimpleInfo

API for Obtaining the Pipeline List

Go debug

Obtaining the Pipeline Status

hcloud CodeArtsPipeline ShowPipleineStatus

Obtains the pipeline status, phase, and task information.

Go debug

Obtaining the Pipeline Execution Status of a Project

hcloud CodeArtsPipeline ListPipleineBuildResult

Obtaining the Pipeline Execution Status of a Project

Go debug

Querying pipeline details

hcloud CodeArtsPipeline ShowPipelineDetail

Querying pipeline details

Go debug

Update pipeline info

hcloud CodeArtsPipeline UpdatePipelineInfo

Update pipeline info

Go debug

Deleting the Running Details of a GitCode Pipeline

hcloud CodeArtsPipeline DeleteActionsRunPipeline

This API is used to delete the running details of a GitCode pipeline.

Go debug

Pipeline Management - New

API Name

Command

Description

Operation

Execute Pipeline

hcloud CodeArtsPipeline RunPipeline

Execute Pipeline

Go debug

Create Pipeline

hcloud CodeArtsPipeline CreatePipelineNew

Create Pipeline

Go debug

Retry Run Pipeline

hcloud CodeArtsPipeline RetryPipelineRun

Retry Run Pipeline

Go debug

Accept Manual Review

hcloud CodeArtsPipeline AcceptManualReview

Accept Manual Review

Go debug

Reject Manual Review

hcloud CodeArtsPipeline RejectManualReview

Reject Manual Review

Go debug

Obtaining Pipeline Status in Batches

hcloud CodeArtsPipeline BatchShowPipelinesLatestStatus

This interface is used to obtain pipeline status in batches. Only pipeline data with execution records is returned.

Go debug

Obtaining the Pipeline Status/Obtaining Pipeline Execution Details

hcloud CodeArtsPipeline ShowPipelineRunDetail

This interface is used to obtain the pipeline status or pipeline execution details. Only the pipeline data with execution records is returned.

Go debug

Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project

hcloud CodeArtsPipeline ListPipelines

Obtaining the Pipeline List/Obtaining the Pipeline Execution Status of a Project

Go debug

Deleting a Pipeline

hcloud CodeArtsPipeline DeletePipeline

Deleting a Pipeline

Go debug

Stopping a Pipeline

hcloud CodeArtsPipeline StopPipelineRun

Stopping a Pipeline

Go debug

Obtaining Pipeline Execution Records

hcloud CodeArtsPipeline ListPipelineRuns

Obtaining Pipeline Execution Records

Go debug

Create Pipeline Template

hcloud CodeArtsPipeline CreatePipelineTemplate

Create Pipeline Template

Go debug

Creating a Pipeline Using a Template

hcloud CodeArtsPipeline CreatePipelineByTemplateId

Creating a Pipeline Using a Template

Go debug

Query pipeline logs

hcloud CodeArtsPipeline ShowPipelineLog

Query pipeline logs

Go debug

Show pipeline step execution outputs.

hcloud CodeArtsPipeline ShowStepOutputs

Show pipeline step execution outputs.

Go debug

Show pipeline artifacts

hcloud CodeArtsPipeline ShowPipelineArtifacts

Show pipeline artifacts

Go debug

Pipeline Template Management - New

API Name

Command

Description

Operation

Listing Templates

hcloud CodeArtsPipeline ListPipelineTemplates

Querying the Pipeline Template List

Go debug

Querying Template Details

hcloud CodeArtsPipeline ShowPipelineTemplateDetail

Querying Template Details

Go debug

Update Pipeline Template

hcloud CodeArtsPipeline UpdatePipelineTemplate

Updating a Pipeline Template

Go debug

Delete Pipeline Template

hcloud CodeArtsPipeline DeletePipelineTemplate

Delete Pipeline Template

Go debug

Pipeline Group Management

API Name

Command

Description

Operation

Create Pipeline Group

hcloud CodeArtsPipeline CreatePipelineGroup

Create Pipeline Group

Go debug

Update Pipeline Group

hcloud CodeArtsPipeline UpdatePipelineGroup

Update Pipeline Group

Go debug

Delete Pipeline Group

hcloud CodeArtsPipeline DeletePipelineGroup

Delete Pipeline Group

Go debug

Show Pipeline Group Tree

hcloud CodeArtsPipeline ShowPipelineGroupTree

Show Pipeline Group Tree

Go debug

Batch Move Pipeline To Group

hcloud CodeArtsPipeline BatchMovePipelineToGroup

Batch Move Pipeline To Group

Go debug

Rule Management

API Name

Command

Description

Operation

Show Rule Detail

hcloud CodeArtsPipeline ShowRule

Show Rule Detail

Go debug

List Rule

hcloud CodeArtsPipeline ListRule

List Rule

Go debug

Update Rule

hcloud CodeArtsPipeline UpdateRule

Update Rule

Go debug

Delete Rule

hcloud CodeArtsPipeline DeleteRule

Delete Rule

Go debug

CreateRule

hcloud CodeArtsPipeline CreateRule

CreateRule

Go debug

Project Strategy Management

API Name

Command

Description

Operation

List Project Strategy

hcloud CodeArtsPipeline ListProjectStrategy

List Project Strategy

Go debug

Show Project Strategy

hcloud CodeArtsPipeline ShowProjectStrategy

Show Project Strategy

Go debug

Tenant Strategy Management

API Name

Command

Description

Operation

Create Strategy

hcloud CodeArtsPipeline CreateStrategy

Create Strategy

Go debug

Update Strategy

hcloud CodeArtsPipeline UpdateStrategy

Update Strategy

Go debug

Show Strategy Detail

hcloud CodeArtsPipeline ShowStrategy

Show Strategy Detail

Go debug

List Strategy

hcloud CodeArtsPipeline ListStrategy

List Strategy

Go debug

Delete Strategy

hcloud CodeArtsPipeline DeleteStrategy

Delete Strategy

Go debug

Switch Strategy

hcloud CodeArtsPipeline SwitchStrategy

Switch Strategy

Go debug

Extension Management

API Name

Command

Description

Operation

Create Plugin Version

hcloud CodeArtsPipeline CreatePluginVersion

Create Plugin Version

Go debug

Create Plugin Draft

hcloud CodeArtsPipeline CreatePluginDraft

Create Plugin Draft

Go debug

Create Publisher

hcloud CodeArtsPipeline CreatePublisher

Create Publisher

Go debug

Update Plugin Draft

hcloud CodeArtsPipeline UpdatePluginDraft

Update Plugin Draft

Go debug

Publish Plugin Draft

hcloud CodeArtsPipeline PublishPluginDraft

Publish Plugin Draft

Go debug

Update Plugin Base Info

hcloud CodeArtsPipeline UpdatePluginBaseInfo

Update Plugin Base Info

Go debug

Publish Plugin

hcloud CodeArtsPipeline PublishPlugin

Publish Plugin

Go debug

Plugin binding publisher

hcloud CodeArtsPipeline PublishPluginBind

Plugin binding publisher

Go debug

Update plugin icon

hcloud CodeArtsPipeline UploadPluginIcon

Update plugin icon

Go debug

Update publisher icon

hcloud CodeArtsPipeline UploadPublisherIcon

Update publisher icon

Go debug

Delete plugin draft

hcloud CodeArtsPipeline DeletePluginDraft

Delete plugin draft

Go debug

Query publisher list

hcloud CodeArtsPipeline ListPublisher

Query publisher list

Go debug

List Available Publisher

hcloud CodeArtsPipeline ListAvailablePublisher

List Available Publisher

Go debug

List Stage Plugins

hcloud CodeArtsPipeline ListStagePlugins

List Stage Plugins

Go debug

List Base Plugins

hcloud CodeArtsPipeline ListBasePlugins

List Base Plugins

Go debug

List Base Plugins New Post

hcloud CodeArtsPipeline ListBasePluginsNewPost

List Base Plugins New Post

Go debug

List Plugins

hcloud CodeArtsPipeline ListPlugins

List Plugins

Go debug

Show Plugin Metrics

hcloud CodeArtsPipeline ShowPluginMetrics

Show Plugin Metrics

Go debug

Show Plugin Inputs

hcloud CodeArtsPipeline ShowPluginInputs

Show Plugin Inputs

Go debug

Show Plugin Outputs

hcloud CodeArtsPipeline ShowPluginOutputs

Show Plugin Outputs

Go debug

Query all version information of plugins

hcloud CodeArtsPipeline ListPLuginVersion

Query all version information of plugins

Go debug

Show plugin version details

hcloud CodeArtsPipeline ShowPluginVersion

Show plugin version details

Go debug

List Plugin Version Number

hcloud CodeArtsPipeline ListPluginVersionNumber

List Plugin Version Number

Go debug

Delete Publisher

hcloud CodeArtsPipeline DeletePublisher

Delete Publisher

Go debug

Show Publisher Detail

hcloud CodeArtsPipeline ShowPublisher

Show Publisher Detail

Go debug

Create Basic Plugin

hcloud CodeArtsPipeline CreateBasicPlugin

Create Basic Plugin

Go debug

Update Basic Plugin

hcloud CodeArtsPipeline UpdateBasicPlugin

Update Basic Plugin

Go debug

Delete Basic Plugin

hcloud CodeArtsPipeline DeleteBasicPlugin

Delete Basic Plugin

Go debug

Upload Basic Plugin

hcloud CodeArtsPipeline UploadBasicPlugin

Upload Basic Plugin

Go debug

Show Basic Plugin

hcloud CodeArtsPipeline ShowBasicPlugin

Show Basic Plugin

Go debug

GitCode Pipeline

API Name

Command

Description

Operation

Querying the Running Details of a GitCode Pipeline

hcloud CodeArtsPipeline ShowActionsRunsDetail

This API is used to query the running details of a GitCode pipeline.

Go debug

Running a GitCode Pipeline

hcloud CodeArtsPipeline RunActionsPipeline

This API is used to run a GitCode pipeline.

Go debug

Retrying Running a GitCode Pipeline

hcloud CodeArtsPipeline RetryRunActionsPipeline

This API is used to retry running a GitCode pipeline.

Go debug

Querying GitCode Pipeline Execution Records

hcloud CodeArtsPipeline ListActionsPipelineRuns

This API is used to query GitCode pipeline execution records.

Go debug

Querying the GitCode Pipeline Action List

hcloud CodeArtsPipeline ListActionsPipelineRunsByRunIds

This API is used to query the GitCode pipeline action list.

Go debug

Extension Point Management

API Name

Command

Description

Operation

Query Plugin List

hcloud CodeArtsPipeline ListModulesDetail

Query plugin list

Go debug

Query Extension Point List

hcloud CodeArtsPipeline ListEndpointsDetails

Query extension point list

Go debug

Endpoint

API Name

Command

Description

Operation

Proxy Call to External Service Interface

hcloud CodeArtsPipeline InvokeEndpointProxy

Proxy call to external service interface.

Go debug