Author SHA1 Message Date
Omar-268 b01c0a64be Update getting-started.md 2025-09-11 10:44:12 +00:00
Omar-268 1eaaf00f63 Update getting-started.md 2025-09-11 10:30:16 +00:00
Omar-268 17feae0491 Update index.html 2025-09-10 18:13:59 +00:00
Omar-268 dee9c1b220 Update getting-started.md 2025-09-10 17:51:39 +00:00
Omar Ahmed 6714506b3f Add Dockerfile to serve docs with Docsify on port 3000 2025-09-10 19:41:30 +03:00
12 changed files with 31 additions and 167 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
+1
View File
@@ -4,3 +4,4 @@ RUN npm install -g docsify-cli
COPY . . COPY . .
EXPOSE 3000 EXPOSE 3000
CMD ["docsify", "serve", ".","-p", "3000"] CMD ["docsify", "serve", ".","-p", "3000"]
-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 -1
View File
@@ -1 +1 @@
بسم الله الرحمن الرحيم # Welcome to Ghaymah CLI Docs
+10 -4
View File
@@ -1,6 +1,12 @@
- [Getting Started](Getting%20started.md) - [About Ghaymah CLI](about-ghaymah-cli.md)
- [Getting Started](getting-started.md)
- [Using CLI](using-cli.md)
- Features - Features
<!-- - [Integrations](features/integrations.md) --> - [Integrations](features/integrations.md)
- [Projects](Project.md) - [Projects](features/Projects.md)
- [Application](Application.md)
View File
View File
View File
+4 -12
View File
@@ -4,12 +4,11 @@ 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
@@ -17,7 +16,6 @@ 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
@@ -26,7 +24,6 @@ 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
@@ -46,17 +43,15 @@ 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:
@@ -71,25 +66,22 @@ 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:
-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
+13 -30
View File
@@ -1,39 +1,22 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head> <head>
<meta charset="utf-8" /> <meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge" /> <title>Ghaymah Docs</title>
<meta name="viewport" <meta name="viewport" content="width=device-width, initial-scale=1.0">
content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover" /> <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable/dist/css/theme-simple-dark.css">
<!-- <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>
<!-- Required --> <script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<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