diff --git a/getting-started.md b/getting-started.md index 45359c7..f75f4a1 100644 --- a/getting-started.md +++ b/getting-started.md @@ -6,7 +6,7 @@ This topic describes how to install the latest release of **Ghaymah Command Line ## Ghaymah CLI Install Instructions - +### Installation #### **Step 1:** Download & Install Run the following command to install the latest release of the Ghaymah CLI: @@ -15,7 +15,34 @@ Run the following command to install the latest release of the Ghaymah CLI: curl -sSl https://cli.ghaymah.systems/install.sh | bash ``` -#### **Step 2:** Check Your Shell +#### **Step 2:** Update PATH +Add the CLI to your PATH and reload your shell configuration: + +```bash +echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc +source ~/.bashrc +``` + +#### **Step 3:** Verify Installation +Check that the CLI is installed correctly: + +```bash +gy version +``` + +You should see the version number of the installed Ghaymah CLI: + +```bash +Current version: xx.xx.xx +Latest version: xx.xx.xx +✅ You are using the latest version! +``` + +--- + +### Enable Auto-Completion + +#### **Step 1:** Check Your Shell Run the following command to check which shell you are using: ```bash @@ -24,7 +51,7 @@ echo $SHELL > ** Supported shells:** `bash`, `zsh`, `fish` -#### **Step 3:** Enable Shell Completion +#### **Step 2:** Enable Shell Completion Enable shell completion to get command suggestions and auto-completion. **For Bash**, run: @@ -41,20 +68,21 @@ echo "source ~/gy-completion.sh" >> ~/.bashrc > **Important:** Restart your terminal after completing this step -#### **Step 4:** Verify Installation -Check that the CLI is installed correctly: - -```bash -gy version -``` - -You should see the version number of the installed Ghaymah CLI: - -```bash -Current version: xx.xx.xx -Latest version: xx.xx.xx -✅ You are using the latest version! -``` - --- - + +### Authentication +Before using the Ghaymah CLI, you need to authenticate your account. + +If you don’t have an account yet, you can create one by visiting the Ghaymah website: +[Ghaymah systems](https://ghaymah.systems/) + +After creating your account, return to the CLI and run gy auth login to sign in. +```bash +gy auth login +``` + +You will be prompted to enter your email and password: +```bash +Email: +Password: +```