2.9 KiB
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:
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:
curl -sSl https://cli.ghaymah.systems/install.sh | bash
2.update PATH Add the CLI to your PATH and reload your shell configuration:
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.
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:
Option 1: Using WSL
-
Install WSL:
wsl --install -
Choose a Linux distribution.
-
Open the WSL terminal and follow the Linux installation steps.
For more information check WSL Documentation
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:
gy version
You should see the version number of the installed Ghaymah CLI:
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:
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:
gy completion bash >> ~/gy-completion.sh
Then add the generated completion script to your shell configuration:
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 After creating your account, return to the CLI and run the following command to log in.
gy auth login
You will be prompted to enter your email and password:
Email:
Password: