Ghaymah_Cloud_Docs/getting-started.md

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

Step 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

Step 2: Check Your Shell

Run the following command to check which shell you are using:

echo $SHELL

** Supported shells:** bash, zsh, fish

Step 3: 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

Step 4: Verify 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!

---