Compare commits
17 الالتزامات
d46ddc8036
...
main
المؤلف | SHA1 | التاريخ | |
---|---|---|---|
78fc97dd09 | |||
d8703e829e | |||
e1d8319337 | |||
a1ef213e13 | |||
ca4519ba8d | |||
cbdef4e410 | |||
5e278db3c3 | |||
2390c1053e | |||
bfe2c40491 | |||
![]() |
471e679333 | ||
dfca1c588a | |||
6a6c84a061 | |||
9860eda638 | |||
6f3ee9f989 | |||
d441d9178d | |||
![]() |
baf438ef28 | ||
![]() |
fada2f4c1e |
@@ -1,9 +1,54 @@
|
|||||||
# Application
|
## What is an Application?
|
||||||
|
|
||||||
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
|
||||||
|
```
|
||||||
|
|
||||||
## Requirement
|
|
||||||
|
|
||||||
## creating an application
|
## 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
|
## Configuring the .ghaymah.json
|
||||||
|
6
Dockerfile
Normal file
6
Dockerfile
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
FROM node:18-alpine
|
||||||
|
WORKDIR /app
|
||||||
|
RUN npm install -g docsify-cli
|
||||||
|
COPY . .
|
||||||
|
EXPOSE 3000
|
||||||
|
CMD ["docsify", "serve", ".","-p", "3000"]
|
@@ -1,44 +1,96 @@
|
|||||||
# بسم الله الرحمن الرحيم
|
# Getting Started with Ghaymah CLI
|
||||||
|
|
||||||
## Installation
|
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
|
```bash
|
||||||
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
## Authentication
|
#### **Step 2:** Update PATH
|
||||||
|
|
||||||
## Command completion
|
Add the CLI to your PATH and reload your shell configuration:
|
||||||
|
|
||||||
### Step 1: Identify your shell
|
```bash
|
||||||
|
echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
|
||||||
|
source ~/.bashrc
|
||||||
|
```
|
||||||
|
|
||||||
Run
|
#### **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
|
```bash
|
||||||
echo $SHELL
|
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
|
```bash
|
||||||
gy completion bash >> ~/gy-completion.sh
|
gy completion bash >> ~/gy-completion.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### Step 3: Enable command completion
|
Then add the generated completion script to your shell configuration:
|
||||||
|
|
||||||
Run
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
echo "source ~/gy-completion.sh" >> ~/.bashrc
|
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:
|
||||||
|
```
|
||||||
|
42
Project.md
42
Project.md
@@ -1,3 +1,39 @@
|
|||||||
# Project
|
## Create project
|
||||||
## Creating a project
|
```
|
||||||
## Getting a project ID
|
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
|
||||||
|
```
|
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)
|
25
gy_project
Normal file
25
gy_project
Normal 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
|
||||||
|
|
||||||
|
|
39
index.html
Normal file
39
index.html
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<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>
|
||||||
|
<div id="app">Loading...</div>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
window.$docsify = {
|
||||||
|
name: "Ghaymah Docs",
|
||||||
|
loadSidebar: true,
|
||||||
|
subMaxLevel: 3,
|
||||||
|
};
|
||||||
|
</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>
|
المرجع في مشكلة جديدة
حظر مستخدم