diff --git a/getting-started.md b/getting-started.md index a713bb5..f96c4d8 100644 --- a/getting-started.md +++ b/getting-started.md @@ -1,123 +1,100 @@ # Getting Started with Ghaymah CLI - This topic describes how to install the latest release of **Ghaymah Command Line Interface (Ghaymah CLI)** on supported operating systems. - --- - ## Ghaymah CLI Install Instructions - ### Installation - #### **Linux** - #### **Debian** - Download & Install - Run the following command to install the latest release of the Ghaymah CLI: - ```bash curl -sSl https://cli.ghaymah.systems/install.sh | bash ``` - #### **Redhat** - 1.Download & Install - Run the following command to install the latest release of the Ghaymah CLI: - ```bash curl -sSl https://cli.ghaymah.systems/install.sh | bash ``` - 2.update PATH - Add the CLI to your PATH and reload your shell configuration: - ```bash echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc source ~/.bashrc ``` - +#### **macOS** +Since the Ghaymah CLI is built for Linux environments only, macOS users need to run it inside a Linux environment. -#### **Macos** - -Bonjour! - +**Using Virtualization** +* Install a hypervisor (e.g., UTM, VirtualBox, or Parallels). +* Create a Linux VM. +* Inside the VM, follow the Linux installation steps. #### **Windows** +Since Ghaymah CLI is built for Linux environments only, Windows users have two options to run it: -Ciao! +**Option 1: Using WSL** +1. Install WSL: + ``` + wsl --install + ``` +2. Choose a Linux distribution. + +3. Open the WSL terminal and follow the Linux installation steps. + +For more information check [WSL Documentation](https://learn.microsoft.com/en-us/windows/wsl/install) + +**Option 2: Using Virtualization** + +If you prefer a full Linux virtual machine: +* Install a hypervisor (e.g., VMware, VirtualBox, or Hyper-V). +* Create a Linux VM. +* Inside the VM, follow the Linux installation steps. ### Verifying 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 echo $SHELL ``` - > **Supported shells:** `bash`, `zsh`, `fish` - #### **Step 2:** Enable Shell Completion - Enable shell completion to get command suggestions and auto-completion. - **For Bash**, run: - ```bash gy completion bash >> ~/gy-completion.sh ``` - Then add the generated completion script to your shell configuration: - ```bash echo "source ~/gy-completion.sh" >> ~/.bashrc ``` - > **Important:** Restart your terminal after completing this step - --- - ### 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 the following command to log in. - ```bash gy auth login ``` - You will be prompted to enter your email and password: - ```bash Email: Password: -``` +```