Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Doc: Add Docker Image Info + Some Minor Fixes #24

Merged
merged 4 commits into from
Feb 26, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,29 @@ the actions necessary within those scenarios. See section _Usage_ for more detai
- SAPUI 7.53

### General Requirements
- JDK 8 to build this project (to run the client JRE 8 is sufficient)
- JDK 8 to build this project (to run the client JRE 8 is sufficient) OR
- a Docker environment to run the Docker image

# Download and Installation

- Download the command line interface package from [mavencentral](http://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli)
This command line client can be consumed either as a Java application from [maven.org](http://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli) or as a Docker image from [hub.docker.com](https://hub.docker.com/r/ppiper/cm-client).

## Installation from maven.org

- Download the command line interface package from [maven.org](http://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli)
- Extract the command line interface package into suitable folder

E.g.:
```
CM_VERSION=0.0.1
mkdir cm_client
curl "http://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli/${CM_VERSION}/dist.cli-${CM_VERSION}.tar.gz" \
|tar -C cm_client -xvf -
cm_client/bin/cmclient --version
cm_client/bin/cmclient --help
```

# Usage
Example:
```
CM_VERSION=0.0.1
mkdir cm_client
curl "http://repo1.maven.org/maven2/com/sap/devops/cmclient/dist.cli/${CM_VERSION}/dist.cli-${CM_VERSION}.tar.gz" \
|tar -C cm_client -xvf -
cm_client/bin/cmclient --version
cm_client/bin/cmclient --help
```

# Usage of the CLI
````
<CMD> [COMMON_OPTIONS...] <subcommand> [SUBCOMMAND_OPTIONS] <parameters...>
````
Expand Down Expand Up @@ -73,10 +78,8 @@ the actions necessary within those scenarios. See section _Usage_ for more detai
| `is-transport-modifiable` | CTS | Returns 'true' if the transport is modifiable. |
| `upload-file-to-transport` | CTS | Uploads a file to a transport. |


For more information about subcommands and subcommand options run `<CMD> <subcommand> --help`.


# How to obtain support

Feel free to open new issues for feature requests, bugs or general feedback on
Expand All @@ -87,7 +90,7 @@ the [GitHub issues page of this project][cm-cli-issues].
Read and understand our [contribution guidelines][contribution]
before opening a pull request.

# [License][license]
# License

Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved.
This file is licensed under the Apache Software License, v. 2 except as noted
Expand Down