Author SHA1 Message Date
ahmedhesham301 473527e6ad Merge pull request 'updated sidebar width' (#6) from ahmedhesham301/Ghaymah_Cloud_Docs:main into main
Reviewed-on: #6
2025-09-11 14:55:18 +00:00
ahmedhesham301 78fc97dd09 updated sidebar width 2025-09-11 17:51:35 +03:00
ahmedhesham301 ba5ea34a42 Merge pull request 'main' (#5) from ahmedhesham301/Ghaymah_Cloud_Docs:main into main
Reviewed-on: #5
2025-09-11 14:39:53 +00:00
ahmedhesham301 d8703e829e added some settings and added search bar 2025-09-11 17:15:40 +03:00
ahmedhesham301 e1d8319337 fixed sidebar paths 2025-09-11 17:15:06 +03:00
ahmedhesham301 cc70331a6c Merge pull request 'added files' (#4) from ahmedhesham301/Ghaymah_Cloud_Docs:main into main
Reviewed-on: #4
2025-09-11 13:45:55 +00:00
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 167 additions and 31 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 -2
View File
@@ -3,5 +3,4 @@ WORKDIR /app
RUN npm install -g docsify-cli RUN npm install -g docsify-cli
COPY . . COPY . .
EXPOSE 3000 EXPOSE 3000
CMD ["docsify", "serve", ".","-p", "3000"] CMD ["docsify", "serve", ".","-p", "3000"]
+12 -4
View File
@@ -4,11 +4,12 @@ This topic describes how to install the latest release of **Ghaymah Command Line
--- ---
## Ghaymah CLI Install Instructions ## Ghaymah CLI Install Instructions
### Installation ### Installation
#### **Step 1:** Download & Install #### **Step 1:** Download & Install
Run the following command to install the latest release of the Ghaymah CLI: Run the following command to install the latest release of the Ghaymah CLI:
```bash ```bash
@@ -16,6 +17,7 @@ curl -sSl https://cli.ghaymah.systems/install.sh | bash
``` ```
#### **Step 2:** Update PATH #### **Step 2:** Update PATH
Add the CLI to your PATH and reload your shell configuration: Add the CLI to your PATH and reload your shell configuration:
```bash ```bash
@@ -24,6 +26,7 @@ source ~/.bashrc
``` ```
#### **Step 3:** Verify Installation #### **Step 3:** Verify Installation
Check that the CLI is installed correctly: Check that the CLI is installed correctly:
```bash ```bash
@@ -43,15 +46,17 @@ Latest version: xx.xx.xx
### Enable Auto-Completion ### Enable Auto-Completion
#### **Step 1:** Check Your Shell #### **Step 1:** Check Your Shell
Run the following command to check which shell you are using: Run the following command to check which shell you are using:
```bash ```bash
echo $SHELL echo $SHELL
``` ```
> ** Supported shells:** `bash`, `zsh`, `fish` > **Supported shells:** `bash`, `zsh`, `fish`
#### **Step 2:** Enable Shell Completion #### **Step 2:** Enable Shell Completion
Enable shell completion to get command suggestions and auto-completion. Enable shell completion to get command suggestions and auto-completion.
**For Bash**, run: **For Bash**, run:
@@ -66,22 +71,25 @@ Then add the generated completion script to your shell configuration:
echo "source ~/gy-completion.sh" >> ~/.bashrc echo "source ~/gy-completion.sh" >> ~/.bashrc
``` ```
> **Important:** Restart your terminal after completing this step > **Important:** Restart your terminal after completing this step
--- ---
### Authentication ### Authentication
Before using the Ghaymah CLI, you need to authenticate your account. 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/) [Ghaymah systems](https://ghaymah.systems/)
After creating your account, return to the CLI and run the following command to log in. After creating your account, return to the CLI and run the following command to log in.
```bash ```bash
gy auth login gy auth login
``` ```
You will be prompted to enter your email and password: You will be prompted to enter your email and password:
```bash ```bash
Email: Email:
Password: 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 بسم الله الرحمن الرحيم
+4 -10
View File
@@ -1,12 +1,6 @@
- [About Ghaymah CLI](about-ghaymah-cli.md) - [Getting Started](Getting%20started.md)
- [Getting Started](getting-started.md)
- [Using CLI](using-cli.md)
- Features - Features
- [Integrations](features/integrations.md) <!-- - [Integrations](features/integrations.md) -->
- [Projects](features/Projects.md) - [Projects](Project.md)
- [Application](Application.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
+31 -14
View File
@@ -1,22 +1,39 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<meta charset="UTF-8"> <meta charset="utf-8" />
<title>Ghaymah Docs</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport"
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple-dark.css"> 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> </head>
<body> <body>
<div id="app">Loading...</div> <div id="app">Loading...</div>
<script> <script>
window.$docsify = { window.$docsify = {
name: 'Ghaymah Docs', name: "Ghaymah Docs",
loadSidebar: true, loadSidebar: true,
subMaxLevel: 3 subMaxLevel: 3,
} };
</script> </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> </body>
</html>
</html>
View File