add windows & macOS sections

هذا الالتزام موجود في:
Omar Ahmed
2025-09-15 15:41:38 +03:00
الأصل cfa09f6271
التزام ce8df38bc3

عرض الملف

@@ -1,122 +1,99 @@
# Getting Started with Ghaymah CLI # 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. This topic describes how to install the latest release of **Ghaymah Command Line Interface (Ghaymah CLI)** on supported operating systems.
--- ---
## Ghaymah CLI Install Instructions ## Ghaymah CLI Install Instructions
### Installation ### Installation
<!-- tabs:start --> <!-- tabs:start -->
#### **Linux** #### **Linux**
<!-- tabs:start --> <!-- tabs:start -->
#### **Debian** #### **Debian**
Download & Install Download & Install
Run the following command to install the latest release of the Ghaymah CLI: Run the following command to install the latest release of the Ghaymah CLI:
```bash ```bash
curl -sSl https://cli.ghaymah.systems/install.sh | bash curl -sSl https://cli.ghaymah.systems/install.sh | bash
``` ```
#### **Redhat** #### **Redhat**
1.Download & Install 1.Download & Install
Run the following command to install the latest release of the Ghaymah CLI: Run the following command to install the latest release of the Ghaymah CLI:
```bash ```bash
curl -sSl https://cli.ghaymah.systems/install.sh | bash curl -sSl https://cli.ghaymah.systems/install.sh | bash
``` ```
2.update PATH 2.update PATH
Add the CLI to your PATH and reload your shell configuration: Add the CLI to your PATH and reload your shell configuration:
```bash ```bash
echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
source ~/.bashrc source ~/.bashrc
``` ```
<!-- tabs:end --> <!-- tabs:end -->
#### **macOS**
Since the Ghaymah CLI is built for Linux environments only, macOS users need to run it inside a Linux environment.
#### **Macos** **Using Virtualization**
* Install a hypervisor (e.g., UTM, VirtualBox, or Parallels).
Bonjour! * Create a Linux VM.
* Inside the VM, follow the Linux installation steps.
#### **Windows** #### **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.
<!-- tabs:end --> <!-- tabs:end -->
### Verifying Installation ### Verifying Installation
Check that the CLI is installed correctly: Check that the CLI is installed correctly:
```bash ```bash
gy version gy version
``` ```
You should see the version number of the installed Ghaymah CLI: You should see the version number of the installed Ghaymah CLI:
```bash ```bash
Current version: xx.xx.xx Current version: xx.xx.xx
Latest version: xx.xx.xx Latest version: xx.xx.xx
✅ You are using the latest version! ✅ You are using the latest version!
``` ```
--- ---
### Enable Auto-Completion ### Enable Auto-Completion
#### **Step 1:** Check Your Shell #### **Step 1:** Check Your Shell
Run the following command to check which shell you are using: Run the following command to check which shell you are using:
```bash ```bash
echo $SHELL echo $SHELL
``` ```
> **Supported shells:** `bash`, `zsh`, `fish` > **Supported shells:** `bash`, `zsh`, `fish`
#### **Step 2:** Enable Shell Completion #### **Step 2:** Enable Shell Completion
Enable shell completion to get command suggestions and auto-completion. Enable shell completion to get command suggestions and auto-completion.
**For Bash**, run: **For Bash**, run:
```bash ```bash
gy completion bash >> ~/gy-completion.sh gy completion bash >> ~/gy-completion.sh
``` ```
Then add the generated completion script to your shell configuration: Then add the generated completion script to your shell configuration:
```bash ```bash
echo "source ~/gy-completion.sh" >> ~/.bashrc echo "source ~/gy-completion.sh" >> ~/.bashrc
``` ```
> **Important:** Restart your terminal after completing this step > **Important:** Restart your terminal after completing this step
--- ---
### Authentication ### Authentication
Before using the Ghaymah CLI, you need to authenticate your account. 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: If you don't have an account yet, you can create one by visiting the Ghaymah website:
[Ghaymah systems](https://ghaymah.systems/) [Ghaymah systems](https://ghaymah.systems/)
After creating your account, return to the CLI and run the following command to log in. After creating your account, return to the CLI and run the following command to log in.
```bash ```bash
gy auth login gy auth login
``` ```
You will be prompted to enter your email and password: You will be prompted to enter your email and password:
```bash ```bash
Email: Email:
Password: Password: