Update Project.md and Application.md

هذا الالتزام موجود في:
Omar Ahmed
2025-09-11 18:21:43 +03:00
الأصل 473527e6ad
التزام 5519f0629c
4 ملفات معدلة مع 96 إضافات و37 حذوفات

96
getting-started.md Normal file
عرض الملف

@@ -0,0 +1,96 @@
# 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
#### **Step 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
```
#### **Step 2:** Update PATH
Add the CLI to your PATH and reload your shell configuration:
```bash
echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
```
#### **Step 3:** Verify 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:
```