Compare commits
2 الالتزامات
cbdef4e410
...
a1ef213e13
المؤلف | SHA1 | التاريخ | |
---|---|---|---|
a1ef213e13 | |||
ca4519ba8d |
@@ -1,36 +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.
|
||||
|
||||
> **Note:** Ghaymah CLI is currently supported only on **Linux**.
|
||||
---
|
||||
|
||||
To install the cli , run the following command:
|
||||
## 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
|
||||
```
|
||||
Run
|
||||
|
||||
#### **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:
|
||||
Supported shells: **bash**, **zsh**, **fish**
|
||||
> **Supported shells:** `bash`, `zsh`, `fish`
|
||||
|
||||
### Step 2: Generate the completion script
|
||||
#### **Step 2:** Enable Shell Completion
|
||||
|
||||
For Bash, run:
|
||||
Enable shell completion to get command suggestions and auto-completion.
|
||||
|
||||
**For Bash**, run:
|
||||
|
||||
```bash
|
||||
gy completion bash >> ~/gy-completion.sh
|
||||
```
|
||||
|
||||
### Step 3: Enable command completion
|
||||
|
||||
Run
|
||||
Then add the generated completion script to your shell configuration:
|
||||
|
||||
```bash
|
||||
echo "source ~/gy-completion.sh" >> ~/.bashrc
|
||||
```
|
||||
|
||||
Then restart your terminal
|
||||
> **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:
|
||||
```
|
||||
|
9
_sidebar.md
Normal file
9
_sidebar.md
Normal file
@@ -0,0 +1,9 @@
|
||||
- [About Ghaymah CLI](about-ghaymah-cli.md)
|
||||
|
||||
- [Getting Started](getting-started.md)
|
||||
|
||||
- [Using CLI](using-cli.md)
|
||||
|
||||
- Features
|
||||
- [Integrations](features/integrations.md)
|
||||
- [Projects](features/Projects.md)
|
المرجع في مشكلة جديدة
حظر مستخدم