Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update getting started #689

Merged
merged 7 commits into from
Aug 22, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,20 @@ The following versions of the Galasa CLI tool are available to download for diff
| zLinux | galasactl-linux-s390x |
| Windows | galasactl-windows-amd64.exe |

After downloading the binary, re-name it to `galasactl` (for Mac or Unix) or `galasactl.exe` (for Windows) and put it on your PATH.
If you are using a Mac operating system, you can check which download you need by opening the Apple menu and choosing `About this Mac`. Click `More Info`, then scroll down and click the `System Report` button.
Check the `Processor Name` on the Hardware Overview panel. If your Mac has a M1 or M2 chip, a Processor Name is not listed; instead, a Model Number and Chip is displayed. If you are using a Mac with an M1 or M2 chip, choose the `galasactl-darwin-arm64` download. If you are using an Intel processor, choose the `galasactl-darwin-amd64` download. Alternatively, you can type the command `uname -m` into your terminal. If a value `arm64` is returned, download `galasactl-darwin-arm64`. If a value `x86_64` is returned, download `galasactl-darwin-amd64`.


## Getting started

After downloading the binary, re-name it to `galasactl`. If you are using a Mac and get an error that is similar to the following example: `"galasactl" cannot be opened because it is from an unidentified developer`, click `OK`, go to `Privacy & Security` in your System Settings, and click `Open Anyway`. Alternatively, control-click the downloaded icon, choose `Open` from the pop-up menu and then click `Open`. If you are using Windows, you need to open `cmd.exe` and type `start galasactl.exe` in the same directory in which you downloaded the tool.

It is useful to put the Galasa CLI tool that you downloaded on your PATH, so that you can call the tool from the command line without having to provide the path to where it is located. If you are using a Mac, you can find `PATH`, and the directories stored within it, by entering the command `echo $PATH | tr ":" "\n"` in your terminal. If you are using Windows, type the command `C:\> echo %PATH%`. To make the Galasa CLI tool available anywhere, either add that binary into a directory that is in your PATH, or add a new directory that contains the tool to your PATH.

If you are using a Mac or Unix, remember to run the `chmod +x galasactl` command in the directory containing the `galasactl` binary that you downloaded in order to set execute permission to enable you to run the Galasa CLI tool.

## About Galasa CLI commands

Galasa CLI commands start with `galasactl`. Example commands are provided for running on Mac or Unix, and Windows Powershell. The Windows Powershell uses the backtick (`) for line continuation characters. If you are using Windows command-shell, the line continuation character is the caret (^).

You can view the Galasa CLI command syntax, including parameter descriptions, in the <a href=https://github.com/galasa-dev/cli/blob/main/docs/generated/galasactl.md target="_blank"> cli repository</a> in GitHub.
Expand Down
6 changes: 1 addition & 5 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,7 @@ const IndexPage = () => (
</p>
<br></br>
<div className={heroButtons}>
<Button
target={"/docs/getting-started"}
flash={true}
isPrimary={true}
>
<Button target={"/docs"} flash={true} isPrimary={true}>
Get started
</Button>
<Button target={"/about"} flash={true} isPrimary={true}>
Expand Down