Author SHA1 Message Date
ahmedhesham301 a1ef213e13 added _sidebar.md 2025-09-11 16:40:47 +03:00
ahmedhesham301 ca4519ba8d added updated getting started 2025-09-11 16:40:12 +03:00
ahmedhesham301 cbdef4e410 added dockerfile and index.html 2025-09-11 16:33:06 +03:00
Abdelrahman 5e278db3c3 Updated 2025-09-11 09:47:29 +00:00
Abdelrahman 2390c1053e application updated 2025-09-11 12:43:20 +03:00
aelhady105 bfe2c40491 ghaymah project commands 2025-09-10 23:49:59 +03:00
ahmedgamalyousef 471e679333 Updating Project.md File 2025-09-10 19:03:29 +03:00
AhmedGamalYousef dfca1c588a Update Project.md 2025-09-10 15:47:33 +00:00
AhmedGamalYousef 6a6c84a061 Update Project.md 2025-09-10 15:43:43 +00:00
AhmedGamalYousef 9860eda638 Delete GhaymahCLI.md 2025-09-10 15:41:34 +00:00
AhmedGamalYousef 6f3ee9f989 Merge pull request 'updated Application.md' (#2) from ahmedhesham301/Ghaymah_Cloud_Docs:main into main
Reviewed-on: #2
2025-09-10 15:10:13 +00:00
ahmedhesham301 d441d9178d updated Application.md 2025-09-10 17:45:28 +03:00
ahmedgamalyousef baf438ef28 updated 2025-09-10 16:00:02 +03:00
ahmedgamalyousef fada2f4c1e Ghaymah CLI 2025-09-10 15:55:15 +03:00
AhmedGamalYousef d46ddc8036 Merge pull request 'added getting started, application, project' (#1) from ahmedhesham301/Ghaymah_Cloud_Docs:main into main
Reviewed-on: #1
2025-09-09 10:51:05 +00:00
ahmedhesham301 b4eb2088de added Application.md and Project.md 2025-09-09 11:47:45 +03:00
ahmedhesham301 26b0788d85 added getting started 2025-09-09 11:25:57 +03:00
AhmedGamalYousef d514afe72e Add README.md 2025-09-08 15:56:12 +00:00
12 changed files with 150 additions and 25 deletions
+54
View File
@@ -0,0 +1,54 @@
## What is an Application?
When working with the Ghaymah CLI, an **Application** is the central resource you’ll interact with.
It’s not just source code—it’s a deployable unit wrapped in a container, ready to run anywhere.
Think of an Application as the thing you **create, launch, update, and monitor** through the CLI.
Everything else—like containers, configs, and logs—revolves around it.
> **Note:** A **Project must be created first** before you can initialize or launch an Application.
> The Project acts as the parent workspace that organizes your Applications and related resources.
---
# Basic Usage
```bash
gy resource app [command]
```
Aliases: app, a
> **Tip:** You can use -h or --help to see all available options.
```bash
gy resource app --help
```
## creating an application
### step 1: Initialize the Application
Run the following command to create a new application:
```bash
gy resource app init -p project_id
```
>If you don’t know your project ID or haven’t created a project yet, see the [[Project]] documentation.
#### Flags
| Flag | what does it do | comment |
| ------------- | ------------------------- | ------------------------------------ |
| -p project_id | specifies the project id | required |
| -n name | Sets the application name | Optional, defaults to directory name |
### Step 2: Deploy the Application
#### deploying from a Dockerfile
To deploy using a **Dockerfile**, ensure that:
- A `Dockerfile` exists in the project directory.
- All necessary files referenced by the `Dockerfile` are present in the same directory.
Once these requirements are met, deploy the application with:
```bash
gy resource app launch
```
#### Deploying from a git repository
## Configuring the .ghaymah.json
-1
View File
@@ -4,4 +4,3 @@ RUN npm install -g docsify-cli
COPY . .
EXPOSE 3000
CMD ["docsify", "serve", ".","-p", "3000"]
+10 -2
View File
@@ -9,6 +9,7 @@ This topic describes how to install the latest release of **Ghaymah Command Line
### Installation
#### **Step 1:** Download & Install
Run the following command to install the latest release of the Ghaymah CLI:
```bash
@@ -16,6 +17,7 @@ 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
@@ -24,6 +26,7 @@ source ~/.bashrc
```
#### **Step 3:** Verify Installation
Check that the CLI is installed correctly:
```bash
@@ -43,15 +46,17 @@ 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`
> **Supported shells:** `bash`, `zsh`, `fish`
#### **Step 2:** Enable Shell Completion
Enable shell completion to get command suggestions and auto-completion.
**For Bash**, run:
@@ -71,17 +76,20 @@ echo "source ~/gy-completion.sh" >> ~/.bashrc
---
### 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:
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:
+39
View File
@@ -0,0 +1,39 @@
## Create project
```
gy resource project create --set .name="project_name"
```
Or
```bash
gy r p c --set .name="project_name"
```
## List the projects :
```bash
gy resource project get
```
Or
```bash
gy r p g
```
## Update on exiting project :
```bash
gy resource project update project_ID --set .name="new_name"
```
Or
```bash
gy r p u update project_ID --set .name="new_name"
```
## Delete project :
```bash
gy resource project delete project_ID
```
Or
```bash
gy r p d project_ID
```
+1 -1
View File
@@ -1 +1 @@
# Welcome to Ghaymah CLI Docs
بسم الله الرحمن الرحيم
-3
View File
@@ -7,6 +7,3 @@
- Features
- [Integrations](features/integrations.md)
- [Projects](features/Projects.md)
View File
View File
View File
+25
View File
@@ -0,0 +1,25 @@
create project
> gy resource project create --set .name="project_name"
Aliases:
> gy r p c --set .name="project_name"
list the projects:
> gy resource project get
Aliases:
> gy r p g
update om project:
> gy resource project update project_ID --set .name="new_name"
Aliases:
> gy r p u update project_ID --set .name="new_name"
Delete project:
> gy resource project delete project_ID
Aliases:
> gy r p d project_ID
+3
View File
@@ -1,11 +1,13 @@
<!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>
@@ -19,4 +21,5 @@
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>
View File