Author SHA1 Message Date
AhmedGamalYousef 138a9f0b5c Delete gy_project 2025-09-10 15:48:02 +00:00
aelhady105 67c3c04c2c editeghaymah project commands 2025-09-10 18:21:01 +03:00
aelhady105 9960d4dcb3 ghaymah project commands 2025-09-10 09:45:35 +03:00
7 changed files with 0 additions and 186 deletions
-54
View File
@@ -1,54 +0,0 @@
## 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
-6
View File
@@ -1,6 +0,0 @@
FROM node:18-alpine
WORKDIR /app
RUN npm install -g docsify-cli
COPY . .
EXPOSE 3000
CMD ["docsify", "serve", ".","-p", "3000"]
-36
View File
@@ -1,36 +0,0 @@
# بسم الله الرحمن الرحيم
> **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
```
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
-39
View File
@@ -1,39 +0,0 @@
## 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
View File
@@ -1 +0,0 @@
بسم الله الرحمن الرحيم
-25
View File
@@ -1,25 +0,0 @@
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
-25
View File
@@ -1,25 +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>