From 8f092391cecf246c72509c802d16b3ddd6d27546 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 5 Sep 2023 14:25:51 +0100 Subject: [PATCH 1/4] update amd --- .../cli-command-reference.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md index 500ffab9..8b06987f 100644 --- a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md +++ b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md @@ -13,13 +13,12 @@ The following versions of the Galasa CLI tool are available to download for diff | Operating system | Download | | :---- | :-------- | -| MacOSX | galasactl-darwin-amd64 | +| MacOSX | galasactl-darwin-x86_64 | | MacOSX | galasactl-darwin-arm64 | -| Linux amd64 | galasactl-linux-amd64 | +| Linux 64-bit x86 | galasactl-linux-x86_64 | +| Linux arm64 | galasactl-linux-arm64 | | zLinux | galasactl-linux-s390x | -| Windows | galasactl-windows-amd64.exe | - -*Note:* If you are using a Mac operating system, you can check which download you need by typing the command `uname -m` into your terminal. If a value `arm64` is returned, download `galasactl-darwin-arm64`. If a value `x86_64` or `amd64` is returned, download `galasactl-darwin-amd64`. +| Windows | galasactl-windows-x86_64.exe | ## Getting started @@ -28,10 +27,11 @@ Complete the following steps to start running the Galasa CLI tool: On Mac or Unix: -1. Download the binary and re-name it to `galasactl`. -2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. -3. Set execute permission on the binary by running the `chmod +x galasactl` command in the directory containing `galasactl`. -4. Set permission to open the CLI tool by running the `spctl --add galasactl` command in the directory containing `galasactl`. You are prompted by a security panel asking you to log in to show that you are issuing the command. +1. Find out the architecture of your machine by typing the command `uname -m` into your terminal. +2. Download the appropriate binary for your machine architecture and re-name it to `galasactl`. +3. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. +4. Set execute permission on the binary by running the `chmod +x galasactl` command in the directory containing `galasactl`. +5. Set permission to open the CLI tool by running the `spctl --add galasactl` command in the directory containing `galasactl`. You are prompted by a security panel asking you to log in to show that you are issuing the command. You are now able to run Galasa CLI commands from the command line. From 2fa1743b57506d397c765d7a838ce7165baf1528 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Tue, 5 Sep 2023 14:38:15 +0100 Subject: [PATCH 2/4] update requestor definition --- src/markdown-pages/docs/cli-command-reference/runs-get.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/docs/cli-command-reference/runs-get.md b/src/markdown-pages/docs/cli-command-reference/runs-get.md index d1cab635..fb11ca09 100644 --- a/src/markdown-pages/docs/cli-command-reference/runs-get.md +++ b/src/markdown-pages/docs/cli-command-reference/runs-get.md @@ -16,7 +16,7 @@ Use the tables provided to view the options for filtering test results, and for | Name | Description | | :---- | :-------- | | `--name` | Use the `--name` option to query the status of a particular test run. | -| `--requestor`| Use the `--requestor` option to view results of test runs that were submitted to the ecosystem by a specified user. The default is the current user name that is specified in the access token.| +| `--requestor`| Use the `--requestor` option to filter the results of test runs, so that only those tests that are submitted to the ecosystem by a specified user are shown. If not specified, the default behaviour is to show all the test results from any user. | | `--age`| Use the `--age` option to specify a time period in which the tests ran. The _age_ option is specified in the format _FROM:TO_. Units of time can be specified in weeks _w_, days _d_, hours _h_, or minutes _m_. The _FROM_ part is mandatory. The _TO_ part is optional, with a default set to `0`, which indicates the current time. The _FROM_ value specifies how far back in time the query is applied. The _FROM_ value must therefore always be a larger value than the _TO_ value. The returned times are in UTC (Coordinated Universal Time). If the `--name` option is specified, the `--age` parameter is not used. | | `--result` | Use the [`--result` option](#result) to return test runs based on test run results. You can select more than one result by using a comma-separated list. The `--result` flag cannot be used in conjunction with the `--active` flag. The two flags are mutually exclusive. | | `--active` | Use the `--active` option to query tests that have not finished, so that you can quickly see which tests are currently running. The `--active` flag cannot be used in conjunction with the `--result` flag. The two flags are mutually exclusive.| From da1274d0a2e3222f64045b562a358c87a3f5861e Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Wed, 6 Sep 2023 10:14:05 +0100 Subject: [PATCH 3/4] add comment --- .../docs/cli-command-reference/cli-command-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md index 8b06987f..90888542 100644 --- a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md +++ b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md @@ -39,7 +39,7 @@ You are now able to run Galasa CLI commands from the command line. On Windows (Powershell) 1. Download the binary and re-name it to `galasactl`. -2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. +2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. For example, ```export PATH=${PATH}:/my/folder/containing/galasactl```. 3. Open `cmd.exe` and type `start galasactl.exe` in the directory containing `galasactl`. You are now able to run Galasa CLI commands from the command line. From 6b8a39e190572f88a00c3461ff98d64aabf496b1 Mon Sep 17 00:00:00 2001 From: Caroline McNamara Date: Wed, 6 Sep 2023 11:45:48 +0100 Subject: [PATCH 4/4] add comment --- .../docs/cli-command-reference/cli-command-reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md index 90888542..efda9781 100644 --- a/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md +++ b/src/markdown-pages/docs/cli-command-reference/cli-command-reference.md @@ -29,7 +29,7 @@ On Mac or Unix: 1. Find out the architecture of your machine by typing the command `uname -m` into your terminal. 2. Download the appropriate binary for your machine architecture and re-name it to `galasactl`. -3. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. +3. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. For example, ```export PATH=${PATH}:/my/folder/containing/galasactl```. 4. Set execute permission on the binary by running the `chmod +x galasactl` command in the directory containing `galasactl`. 5. Set permission to open the CLI tool by running the `spctl --add galasactl` command in the directory containing `galasactl`. You are prompted by a security panel asking you to log in to show that you are issuing the command. @@ -39,7 +39,7 @@ You are now able to run Galasa CLI commands from the command line. On Windows (Powershell) 1. Download the binary and re-name it to `galasactl`. -2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. For example, ```export PATH=${PATH}:/my/folder/containing/galasactl```. +2. Add `galasactl` to your PATH to enable the tool to be called from the command line without having to specify the path to the directory in which it is stored. 3. Open `cmd.exe` and type `start galasactl.exe` in the directory containing `galasactl`. You are now able to run Galasa CLI commands from the command line.