Skip to content

Commit 751b588

Browse files
committed
add documentation
1 parent ab3ae4f commit 751b588

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,42 @@
11
[![REUSE status](https://api.reuse.software/badge/github.com/openmcp-project/bootstrapper)](https://api.reuse.software/info/github.com/openmcp-project/bootstrapper)
22

3-
# bootstrapper
3+
# openmcp bootstrapper
44

55
## About this project
66

77
The openmcp bootstrapper is a command line tool that is able to set up an openmcp landscape initially and to update existing openmcp landscapes with new versions of the openmcp project.
88

9+
Supported commands:
10+
* `ocmTransfer`: Transfers the specified OCM component version from the source location to the destination location.
11+
12+
### `ocmTransfer`
13+
14+
The `ocmTransfer` command is used to transfer an OCM component version from a source location to a destination location.
15+
The `ocmTransfer` requires the following parameters:
16+
* `source`: The source location of the OCM component version to be transferred.
17+
* `destination`: The destination location where the OCM component version should be transferred to.
18+
19+
Optional parameters:
20+
* `--config`: Path to the OCM configuration file.
21+
22+
```shell
23+
bootstrapper ocmTransfer --source <source-location> --destination <destination-location> --config <path-to-ocm-config>
24+
```
25+
26+
This command internally calls the OCM cli with the following command and arguments:
27+
28+
```shell
29+
ocm transfer componentversion --recursive --copy-resources --copy-sources <source-location> <destination-location> --config <path-to-ocm-config>
30+
```
31+
32+
Example:
33+
```shell
34+
ocmTransfer ghcr.io/openmcp-project/components//github.com/openmcp-project/openmcp:v0.0.11 ./ctf
35+
ocmTransfer ghcr.io/openmcp-project/components//github.com/openmcp-project/openmcp:v0.0.11 ghcr.io/my-github-user
36+
```
37+
38+
39+
940
## Requirements and Setup
1041

1142
This project uses the [cobra library](https://github.com/spf13/cobra) for command line parsing.

0 commit comments

Comments
 (0)