diff --git a/readme.md b/readme.md index 3cfb9730978f6cd53abf145b65bc46b5316edebb..401c28bee1b53c73013d5b18deec1835e38d874d 100644 --- a/readme.md +++ b/readme.md @@ -112,4 +112,24 @@ IMLCI_FILE= ``` Remark: using the cfg file is optional. It countains default values. -all values can be set by command line parameters. \ No newline at end of file +all values can be set by command line parameters. + +Usage of getfile.sh: +``` +SYNTAX: + -d enable debug infos + -e PHASE phase; overrides env variable IMLCI_PHASE + -f FILE filename to get; overrides env variable IMLCI_FILE + -o OUTFILE optional output file; default; given filename in current directory + -p PROJECT ci project id; overrides env variable IMLCI_PROJECT + -s SECRET override secret in IMLCI_PKG_SECRET + -u URL URL of iml ci server without trailing /; overrides env variable IMLCI_URL + +DEFAULTS: + You don't need to set all values by command line. Use a config to set defaults + ./getfile.sh.cfg + +EXAMPLES: + getfile.sh -u https://ci.example.com -f [FILE] + +``` \ No newline at end of file