Merge pull request #896 from MarathonLabs/docs/cloud_new_cli

docs(cloud): cloud documentation was updated according to the updated…

docs/cloud/cli/parameters.md

@@ -3,34 +3,97 @@ title: "Parameters"
 ---
 
 ###
-You can find all the available marathon-cli parameters by running the command `marathon-cloud --help.` 
-Below, you'll find a list of the parameters you can set.
+You can find all the available marathon-cli parameters by running the command `marathon-cloud help.` 
+Below, you'll find a list of the commands and options you can set.
 
 ```bash
-marathon-cloud --help
-  -app string
-        application filepath. Required
-        android example: /home/user/workspace/sample.apk 
-        ios example: /home/user/workspace/sample.zip
-  -testapp string
-        test apk file path. Required
-        android example: /home/user/workspace/testSample.apk 
-        ios example: /home/user/workspace/sampleUITests-Runner.zip
-  -platform string 
-        testing platform. Required
-        possible values: "Android" or "iOS"
-  -api-key string
-        api-key for client. Required
-  -os-version string
-        Android or iOS OS version
-  -link string
-        link to commit
-  -name string
-        name for run, for example it could be description of commit
-  -o string
-        allure raw results output folder
-  -system-image string
-        OS-specific system image. For Android one of [default,google_apis]. For iOS only [default]
-  -isolated bool
-        Run each test using isolated execution. Default is false.
+--> marathon-cloud help
+
+Command-line client for Marathon Cloud
+
+Usage: marathon-cloud [OPTIONS] [COMMAND]
+
+Commands:
+  run          Submit a test run
+  download     Download artifacts from a previous test run
+  completions  Output shell completion code for the specified shell (bash, zsh, fish)
+  help         Print this message or the help of the given subcommand(s)
+
+Options:
+  -v, --verbose...  Increase logging verbosity
+  -q, --quiet...    Decrease logging verbosity
+  -h, --help        Print help
+  -V, --version     Print version
+
+--> marathon-cloud run android -h
+
+Run tests for Android
+
+Usage: marathon-cloud run android [OPTIONS] --test-application <TEST_APPLICATION> --api-key <API_KEY>
+
+Options:
+  -a, --application <APPLICATION>
+          application filepath, example: /home/user/workspace/sample.apk
+  -t, --test-application <TEST_APPLICATION>
+          test application filepath, example: /home/user/workspace/testSample.apk
+      --os-version <OS_VERSION>
+          OS version [10, 11, 12, 13]
+      --system-image <SYSTEM_IMAGE>
+          Runtime system image [possible values: default, google-apis]
+  -v, --verbose...
+          More output per occurrence
+  -o, --output <OUTPUT>
+          Output folder for test run results
+  -q, --quiet...
+          Less output per occurrence
+      --isolated <ISOLATED>
+          Run each test in isolation, i.e. isolated batching. [possible values: true, false]
+      --filter-file <FILTER_FILE>
+          Test filters supplied as a YAML file following the schema at https://docs.marathonlabs.io/runner/configuration/filtering/#filtering-logic. For iOS see also https://docs.marathonlabs.io/runner/next/ios#test-plans
+      --wait
+          Wait for test run to finish if true, exits after triggering a run if false
+      --name <NAME>
+          name for run, for example it could be description of commit
+      --link <LINK>
+          link to commit
+      --api-key <API_KEY>
+          Marathon Cloud API key [env: MARATHON_CLOUD_API_KEY=]
+      --base-url <BASE_URL>
+          Base url for Marathon Cloud API [default: https://cloud.marathonlabs.io/api/v1]
+  -h, --help
+          Print help
+
+--> marathon-cloud run ios -h
+
+Run tests for iOS
+
+Usage: marathon-cloud run ios [OPTIONS] --application <APPLICATION> --test-application <TEST_APPLICATION> --api-key <API_KEY>
+
+Options:
+  -a, --application <APPLICATION>
+          application filepath, example: /home/user/workspace/sample.zip
+  -t, --test-application <TEST_APPLICATION>
+          test application filepath, example: /home/user/workspace/sampleUITests-Runner.zip
+  -o, --output <OUTPUT>
+          Output folder for test run results
+      --isolated <ISOLATED>
+          Run each test in isolation, i.e. isolated batching. [possible values: true, false]
+  -v, --verbose...
+          More output per occurrence
+      --filter-file <FILTER_FILE>
+          Test filters supplied as a YAML file following the schema at https://docs.marathonlabs.io/runner/configuration/filtering/#filtering-logic. For iOS see also https://docs.marathonlabs.io/runner/next/ios#test-plans
+  -q, --quiet...
+          Less output per occurrence
+      --wait
+          Wait for test run to finish if true, exits after triggering a run if false
+      --name <NAME>
+          name for run, for example it could be description of commit
+      --link <LINK>
+          link to commit
+      --api-key <API_KEY>
+          Marathon Cloud API key [env: MARATHON_CLOUD_API_KEY=]
+      --base-url <BASE_URL>
+          Base url for Marathon Cloud API [default: https://cloud.marathonlabs.io/api/v1]
+  -h, --help
+          Print help
 ```

docs/cloud/index.md

@@ -3,6 +3,7 @@ import TabItem from '@theme/TabItem';
 
 # Quick start
 
+
 ### Install
 The installation can be performed using [Homebrew](https://brew.sh/). Here’s how to add the MarathonLabs repository:
 ```shell
@@ -64,13 +65,15 @@ Now you can start running your tests. Use the following command to execute the C
 <TabItem value="iOS" label="iOS">
 
 ```shell
-marathon-cloud -api_key generated_api_key -apk sample.zip -testapk sampleUITests-Runner.zip -platform iOS
+export MARATHON_CLOUD_API_KEY=generated_api_key
+marathon-cloud run ios --application sample.zip --test-application sampleUITests-Runner.zip
 ```
 </TabItem>
 <TabItem value="Android" label="Android">
 
 ```shell
-marathon-cloud -api_key api_key -apk app.apk -testapk appTest.apk -platform Android
+export MARATHON_CLOUD_API_KEY=generated_api_key
+marathon-cloud run android --application app.apk --test-application appTest.apk
 ```
 </TabItem>
 </Tabs>

docs/cloud/intro/ios.md

@@ -22,10 +22,10 @@ Let's say our project is called "Sample". The code snippet below shows how to bu
 #          |--sample.xcodeproj
 
 xcodebuild build-for-testing \
-             -project sample.xcodeproj \
-             -scheme sample \
-             -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.1' \
-             -derivedDataPath ./build
+   -project sample.xcodeproj \
+   -scheme sample \
+   -destination 'platform=iOS Simulator,name=iPhone 14,OS=16.1' \
+   -derivedDataPath ./build
 ```
 
 Note the relative paths of applications, as they will be required for running the tests. In the context of our example and `debug` build, these files can be located at the following paths: