Skip to content

Commit 96d4141

Browse files
authored
Merge pull request #124 from Green-Software-Foundation/if-merge
Add documentation about if-merge
2 parents 9aad440 + 2dec7fc commit 96d4141

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/reference/cli.md

+18
Original file line numberDiff line numberDiff line change
@@ -677,3 +677,21 @@ tree:
677677
mem/energy: 6
678678
energy: 94
679679
```
680+
681+
## `if-merge`
682+
683+
`if-merge` is a command line tool that takes multiple output files and merges them into one single file.
684+
685+
### commands
686+
687+
- `--manifests` or `-m`: (required) the path to an executed manifest
688+
- `--output` or `-o`: (optional) the path to save your output data
689+
- `name` or `n`: (optional) the value of the `name` property in the merged manifest
690+
- `description` or `d`: (optional) the value of the `description` property in the merged manifest
691+
- `help` or `h`: (optional) provides information about all available commands in order to help you easily find the command you need.
692+
693+
This cli helps for systems to generate their own manifests independently, then later merge all the manifests from the different components together for time-syncing, aggregation and reporting purposes.
694+
695+
```sh
696+
if-merge -m manifest1.yml manifest2.yml -n "merged-manifest" -d "description of my manifest" -o merged-manifest.yml
697+
```

0 commit comments

Comments
 (0)