Update getting-started.md

هذا الالتزام موجود في:
2025-09-11 10:30:16 +00:00
الأصل 17feae0491
التزام 1eaaf00f63

عرض الملف

@@ -6,7 +6,7 @@ This topic describes how to install the latest release of **Ghaymah Command Line
## Ghaymah CLI Install Instructions ## Ghaymah CLI Install Instructions
### Installation
#### **Step 1:** Download & Install #### **Step 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:
@@ -15,33 +15,15 @@ Run the following command to install the latest release of the Ghaymah CLI:
curl -sSl https://cli.ghaymah.systems/install.sh | bash curl -sSl https://cli.ghaymah.systems/install.sh | bash
``` ```
#### **Step 2:** Check Your Shell #### **Step 2:** Update PATH
Run the following command to check which shell you are using: Add the CLI to your PATH and reload your shell configuration:
```bash ```bash
echo $SHELL echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
``` ```
> ** Supported shells:** `bash`, `zsh`, `fish` #### **Step 3:** Verify Installation
#### **Step 3:** 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
#### **Step 4:** Verify Installation
Check that the CLI is installed correctly: Check that the CLI is installed correctly:
```bash ```bash
@@ -58,3 +40,49 @@ Latest version: xx.xx.xx
--- ---
### 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 dont 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:
```