You've already forked sap-jenkins-library
							
							
				mirror of
				https://github.com/SAP/jenkins-library.git
				synced 2025-10-30 23:57:50 +02:00 
			
		
		
		
	Bootstrap documentation for Piper-NG CLI/GH Action (#1448)
This commit is contained in:
		
							
								
								
									
										14
									
								
								documentation/docs/cli/index.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								documentation/docs/cli/index.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,14 @@ | ||||
| # Project "Piper" CLI | ||||
|  | ||||
| The CLI is built using the go programming language and thus is distributed in a single binary file for Linux. | ||||
|  | ||||
| The latest released version can be downloaded via `wget https://github.com/SAP/jenkins-library/releases/latest/download/piper`. | ||||
|  | ||||
| Specific versions an be downloaded from the [GitHub releases](https://github.com/SAP/jenkins-library/releases) page. | ||||
|  | ||||
| Once available in `$PATH`, it is ready to use. | ||||
|  | ||||
| To verify the version you got, run `piper version`. | ||||
| To read the online help, run `piper help`. | ||||
|  | ||||
| If you're interested in using it with GitHub Actions, see [the Project "Piper" Action](https://github.com/SAP/project-piper-action) which makes the tool more convinient to use. | ||||
| @@ -13,6 +13,8 @@ To get you started quickly, project "Piper" offers you the following artifacts: | ||||
|     * [General Purpose Pipeline](stages/introduction/) | ||||
|     * [SAP Cloud SDK Pipeline][cloud-sdk-pipeline] | ||||
| * [A shared library][piper-library] that contains reusable step implementations, which enable you to customize our preconfigured pipelines, or to even build your own customized ones | ||||
| * A standalone [command line utility](cli) for Linux and a [GitHub Action](https://github.com/SAP/project-piper-action) | ||||
|     * Note: This version is still in early development. Feel free to use it and [provide feedback](https://github.com/SAP/jenkins-library/issues), but don't expect all the features of the Jenkins library | ||||
| * A set of [Docker images][devops-docker-images] to setup a CI/CD environment in minutes using sophisticated life-cycle management | ||||
|  | ||||
| To find out which offering is right for you, we recommend to look at the ready-made pipelines first. | ||||
|   | ||||
| @@ -97,6 +97,7 @@ nav: | ||||
|         - xsDeploy: steps/xsDeploy.md | ||||
|     - 'Library Steps (deprecated)': | ||||
|         - artifactSetVersion: steps/artifactSetVersion.md | ||||
|     - 'Command line tool': cli/index.md | ||||
|     - Resources: | ||||
|         - 'Custom Jenkins Setup': customjenkins.md | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user