Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d46ddc8036 | ||
|
|
b4eb2088de | ||
|
|
26b0788d85 | ||
|
|
d514afe72e |
@@ -0,0 +1,9 @@
|
|||||||
|
# Application
|
||||||
|
|
||||||
|
what is an application
|
||||||
|
|
||||||
|
## Requirement
|
||||||
|
|
||||||
|
## creating an application
|
||||||
|
|
||||||
|
## Configuring the .ghaymah.json
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
FROM node:18-alpine
|
|
||||||
WORKDIR /app
|
|
||||||
RUN npm install -g docsify-cli
|
|
||||||
COPY . .
|
|
||||||
EXPOSE 3000
|
|
||||||
CMD ["docsify", "serve", ".","-p", "3000"]
|
|
||||||
|
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
# بسم الله الرحمن الرحيم
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
> **Note:** Ghaymah CLI is currently supported only on **Linux**.
|
||||||
|
|
||||||
|
To install the cli , run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
## Authentication
|
||||||
|
|
||||||
|
## Command completion
|
||||||
|
|
||||||
|
### Step 1: Identify your shell
|
||||||
|
|
||||||
|
Run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
echo $SHELL
|
||||||
|
```
|
||||||
|
|
||||||
|
supported shells:
|
||||||
|
Supported shells: **bash**, **zsh**, **fish**
|
||||||
|
|
||||||
|
### Step 2: Generate the completion script
|
||||||
|
|
||||||
|
For Bash, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gy completion bash >> ~/gy-completion.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 3: Enable command completion
|
||||||
|
|
||||||
|
Run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
echo "source ~/gy-completion.sh" >> ~/.bashrc
|
||||||
|
```
|
||||||
|
|
||||||
|
Then restart your terminal
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Project
|
||||||
|
## Creating a project
|
||||||
|
## Getting a project ID
|
||||||
-12
@@ -1,12 +0,0 @@
|
|||||||
- [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)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
# 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:
|
|
||||||
```
|
|
||||||
-22
@@ -1,22 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<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">
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<div id="app">Loading...</div>
|
|
||||||
|
|
||||||
<script>
|
|
||||||
window.$docsify = {
|
|
||||||
name: 'Ghaymah Docs',
|
|
||||||
loadSidebar: true,
|
|
||||||
subMaxLevel: 3
|
|
||||||
}
|
|
||||||
</script>
|
|
||||||
|
|
||||||
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
Reference in New Issue
Block a user