From dce6c6e54f712d815a095401e0a1759813044a95 Mon Sep 17 00:00:00 2001
From: Martin Vogel <martin.vogel@sinc.de>
Date: Thu, 29 Jun 2023 14:29:49 +0200
Subject: [PATCH] chore(#664): update readme
---
cli/README.md | 59 ++++++++++++++++++++++++++++++++++++---------------
1 file changed, 42 insertions(+), 17 deletions(-)
diff --git a/cli/README.md b/cli/README.md
index 9d9ca485e..7c506fe50 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -5,24 +5,21 @@ The sdk provides a commandline-client as a runnable .jar, to be able to use the
#### Setup & Build
1. Build project root wih ``./mvnw clean package``
-2. Go to client/target and find a runnable jar ``fit-connect-client.jar``
+2. Go to client/target and find a runnable jar ``fit-connect-cli.jar``
3. Provide [config yaml](../config.yml):
- 1. set environment variable ``FIT_CONNECT_CONFIG``:
- 1. Linux/MacOS: ``export FIT_CONNECT_CONFIG=path/to/config.yml``
- 2. Windows: ``set FIT_CONNECT_CONFIG=C:\Path\To\config.yml``
- 2. Initialize client via ApplicationConfigLoader:
- ````java
- var config = ApplicationConfigLoader.loadConfig("absolute/path/to/config.yml");
- var senderClient = ClientFactory.senderClient(config);
- ````
- 3. put ``config.yml`` in same path as the .jar-file
-5. run client with ``java -jarfit-connect-client.jar [COMMAND] [OPTIONS]``
+ * a) set environment variable **FIT_CONNECT_CONFIG** or
+ * b) put ``config.yml`` in same path as the .jar-file
+4. run client with ``java -jarfit-connect-cli.jar [COMMAND] [OPTIONS]``
+
+> **Setting Env-Variables:** <br>
+ Linux/MacOS: ``export FIT_CONNECT_CONFIG=path/to/config.yml`` <br>
+ Windows: ``set FIT_CONNECT_CONFIG=C:\Path\To\config.yml``
#### SEND Single Submission Example
The send command submits a new submission to a destination. Apart from optional attachments, all options are mandatory.
````sh
-java -jar fit-connect-client.jar send
+java -jar fit-connect-cli.jar send
--destinationId=1b7d1a24-a6c8-4050-bb71-ae3749ec432f
--serviceName=Test
--leikaKey=urn:de:fim:leika:leistung:99400048079000
@@ -35,7 +32,7 @@ java -jar fit-connect-client.jar send
#### LIST Submissions Example
The list command lists all submissionIds for a given destinationID.
````sh
-java -jar fit-connect-client.jar list --destinationID=1b7d1a24-a6c8-4050-bb71-ae3749ec432f
+java -jar fit-connect-cli.jar list --destinationID=1b7d1a24-a6c8-4050-bb71-ae3749ec432f
````
#### GET Single Submission Example
The get command loads a submission by `submissionId` and stores data and attachments in the given target location. If no target is
@@ -43,13 +40,13 @@ set, the cmd-client saves the data into in a folder named by the `submissionId`
jar.
````sh
-java -jar fit-connect-client.jar get --submissionID=cc9b9b3c-d4b1-4ac7-a70b-e7ca76e88608 --target=Users/submissions/data
+java -jar fit-connect-cli.jar get --submissionID=cc9b9b3c-d4b1-4ac7-a70b-e7ca76e88608 --target=Users/submissions/data
````
#### Batch Mode
To send multiple submission with a single command, the client can be used in batch mode:
````sh
-java -jar fit-connect-client.jar batch --data=batch_data.csv
+java -jar fit-connect-cli.jar batch --data=batch_data.csv
````
Currently, the import of CSV is supported. Follow the schema below, setting up your data:
@@ -60,11 +57,26 @@ destinationId, serviceName, leikaKey, data, dataType, attachments
1b7d1a24-a6c8-4050-bb71-ae3749ec432d, Test2, "urn:de:fim:leika:leistung:99400048079000", /path/to/data/data2.xml, "XML", "path/to/attachment/report.pdf"
````
> Windows paths: escape windows paths with `\\`, e.g. `C:\\path\\to\\file\\file.txt` !
->
+
+#### Generate JWK Test Keys
+The CLI can generate public and private keys for testing purposes for both encryption and signing.
+If no ``outDir`` ist specified, the cli will create a temporary folder that is logged in the console output.
+
+````sh
+java -jar fit-connect-cli.jar keygen --outDir=C:\temp
+````
+```
+[main] INFO d.f.fitconnect.cli.CommandExecutor Generating JWKs ...
+[main] INFO d.f.fitconnect.cli.keygen.KeyWriter Writing keys to directory C:\temp
+[main] INFO d.f.fitconnect.cli.keygen.KeyWriter Wrote Encryption Public Key (key_use=wrapKey) as publicKey_encryption.json
+[main] INFO d.f.fitconnect.cli.keygen.KeyWriter Wrote Decryption Private Key (key_use=unwrapKey) as privateKey_decryption.json
+[main] INFO d.f.fitconnect.cli.keygen.KeyWriter Wrote Signature Verification Public Key (key_use=verify) as publicKey_signature_verification.json
+[main] INFO d.f.fitconnect.cli.keygen.KeyWriter Wrote Signing Private Key (key_use=sign) as privateKey_signing.json
+```
+
#### Usage And Commands
````shell
-Usage: <main class> [command] [command options]
Commands:
send Send a submission
Usage: send [options]
@@ -81,6 +93,8 @@ Usage: <main class> [command] [command options]
Unique destination identifier in UUID format
* --leikaKey
The LeikaKey of the service type
+ * --schemaUri
+ Schema URI to validate submission data
* --serviceName
Name of the service type
@@ -111,4 +125,15 @@ Usage: <main class> [command] [command options]
Options:
* --data
Path to submission data as csv
+
+ keygen Generates JWK test keys for encryption, decryption, signing
+ and signature validation
+ Usage: keygen [options]
+ Options:
+ --outDir
+ Output directory folder where the generated test keys are written
+ to
+ --withConfig
+ Generates config.yaml with paths of the generated keys
+ Default: false
````
--
GitLab