Compare commits
5 الالتزامات
cbdef4e410
...
main
| المؤلف | SHA1 | التاريخ | |
|---|---|---|---|
| 78fc97dd09 | |||
| d8703e829e | |||
| e1d8319337 | |||
| 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:
|
||||
```
|
||||
|
||||
6
_sidebar.md
Normal file
6
_sidebar.md
Normal file
@@ -0,0 +1,6 @@
|
||||
- [Getting Started](Getting%20started.md)
|
||||
|
||||
- Features
|
||||
<!-- - [Integrations](features/integrations.md) -->
|
||||
- [Projects](Project.md)
|
||||
- [Application](Application.md)
|
||||
30
index.html
30
index.html
@@ -2,10 +2,19 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Ghaymah Docs</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple-dark.css">
|
||||
<meta charset="utf-8" />
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||||
<meta name="viewport"
|
||||
content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover" />
|
||||
<!-- <meta name="description" content=""> -->
|
||||
<title>Ghaymah cloud documentation</title>
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple-dark.css" />
|
||||
<!-- Custom Styles -->
|
||||
<style>
|
||||
:root {
|
||||
--sidebar-width: 20rem;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
@@ -13,13 +22,18 @@
|
||||
|
||||
<script>
|
||||
window.$docsify = {
|
||||
name: 'Ghaymah Docs',
|
||||
name: "Ghaymah Docs",
|
||||
loadSidebar: true,
|
||||
subMaxLevel: 3
|
||||
}
|
||||
subMaxLevel: 3,
|
||||
};
|
||||
</script>
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
|
||||
<!-- Required -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
|
||||
|
||||
<!-- Recommended -->
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
المرجع في مشكلة جديدة
حظر مستخدم