Update Application.md

Application.md

@@ -1,4 +1,4 @@
-## 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.  
@@ -11,44 +11,96 @@ Everything else like containers, configs, and logs revolves around it.
 
 ---
 
-# Basic Usage
+## 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
 
-## creating an application
+### Step 1: Initialize the 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 [Projects](Project.md) 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
+### Step 2: 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
+
+Example `.ghaymah.json`
+
+```json
+{
+  "id": "ac2d8eb7-ff49-4b8d-9a8e-92cd3aae22a6",
+  "name": "nginx",
+  "projectId": "b887e332-3ecd-4187-bdfb-17d8a437833e",
+  "ports": [
+    {
+      "expose": true,
+      "number": 80
+    }
+  ],
+  "publicAccess": {
+    "enabled": true,
+    "domain": "auto"
+  },
+  "resourceTier": "t1",
+  "dockerFileName": "Dockerfile"
+}
+```
+
+### Changing values
+
+You can change **name**, exposed port, and **dockerFileName** freely.
+>you can only have one port per application.
+>
+### Adding environment variables
+
+Add an `env` object to the top-level JSON.Example:
+
+```json
+"env": {
+ "foo": "bar",
+ "port": 8080
+}
+```
+
+### Tutorial
+This is a walkthrough on dealing with applications using the Ghaymah CLI:
+
+![Applications](application.gif)
+
+
+

Project.md

@@ -25,6 +25,8 @@ gy r p c --set .name="my-awesome-project"
 gy resource project create --set .name="web-app-frontend"
 ```
 
+![Creating a Project](project_recorded/createprojct.gif)
+
 ### Listing Projects
 
 View all existing projects:
@@ -38,6 +40,8 @@ gy resource project get
 gy r p g
 ```
 
+**Example:**
+![List Projects](project_recorded/getproject.gif)
 
 ### Updating a Project
 
@@ -57,6 +61,7 @@ gy r p u <PROJECT_ID> --set .name="updated-name"
 # Update project name
 gy resource project update proj_123abc --set .name="web-app-backend"
 ```
+![Update Projects](project_recorded/updateproject.gif)
 
 ### Deleting a Project
 
@@ -76,6 +81,7 @@ gy r p d <PROJECT_ID>
 # Delete project by ID
 gy resource project delete proj_123abc
 ```
+![Delete Projects](project_recorded/deleteproject.gif) 
 
 > ⚠️ **Warning**: Deleting a project will permanently remove all associated resources. This action cannot be undone.
 
@@ -95,4 +101,3 @@ gy resource project delete proj_123abc
 
 ---
  
- 

_sidebar.md

@@ -1,6 +1,4 @@
 - [Getting Started](getting-started.md)
-
-- Features
   <!-- - [Integrations](features/integrations.md) -->
 - [Projects](Project.md)
 - [Application](Application.md)

application.demo

@@ -0,0 +1,180 @@
+{"version": 2, "width": 80, "height": 24, "timestamp": 1758103540, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.448856, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~\u001b[00m$ "]
+[1.942344, "o", "c"]
+[2.097692, "o", "d"]
+[3.069807, "o", " "]
+[3.335368, "o", "w"]
+[3.500968, "o", "e"]
+[3.721606, "o", "ather-app/"]
+[4.605521, "o", "\r\n\u001b[?2004l\r"]
+[4.605981, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[5.204404, "o", "l"]
+[5.376409, "o", "s"]
+[5.887837, "o", " "]
+[6.650595, "o", "-"]
+[6.794424, "o", "a"]
+[7.242553, "o", "\r\n\u001b[?2004l\r"]
+[7.247615, "o", "\u001b[0m\u001b[01;34m.\u001b[0m  \u001b[01;34m..\u001b[0m  app.py  Dockerfile  requirements.txt\r\n"]
+[7.249415, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[9.959339, "o", "g"]
+[10.183644, "o", "y"]
+[10.475922, "o", " "]
+[10.688863, "o", "r"]
+[10.901449, "o", " "]
+[12.06135, "o", "p"]
+[12.58191, "o", " "]
+[12.794738, "o", "c"]
+[13.005356, "o", " "]
+[13.743015, "o", "-"]
+[13.868148, "o", "-"]
+[14.019606, "o", "s"]
+[14.28088, "o", "e"]
+[14.69363, "o", "t"]
+[15.195441, "o", " "]
+[15.732329, "o", "."]
+[16.14627, "o", "n"]
+[16.291728, "o", "a"]
+[16.415219, "o", "m"]
+[16.611245, "o", "e"]
+[17.296813, "o", "="]
+[17.813805, "o", "\""]
+[17.950287, "o", "\""]
+[18.288871, "o", "\b"]
+[18.846551, "o", "w\"\b"]
+[19.024313, "o", "e\"\b"]
+[19.204428, "o", "a\"\b"]
+[19.590124, "o", "t\"\b"]
+[19.891767, "o", "h\"\b"]
+[20.012755, "o", "e\"\b"]
+[20.200964, "o", "r\"\b"]
+[21.000461, "o", "-\"\b"]
+[21.212936, "o", "a\"\b"]
+[21.514149, "o", "p\"\b"]
+[21.649459, "o", "p\"\b"]
+[22.386388, "o", "\r\n\u001b[?2004l\r"]
+[24.198038, "o", "time=2025-09-17T13:06:05.085+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[25.431459, "o", "time=2025-09-17T13:06:06.318+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[25.433381, "o", "\u001b[36mCreating project...\r\n\u001b[0m"]
+[26.192595, "o", "\u001b[32;1m✓ project created successfully. ID: 5b508706-a257-4dc9-ab9d-91af914e8ef2\r\n\u001b[0m\u001b[36mWaiting for creation to complete...\r\n\u001b[0m"]
+[27.693594, "o", "\u001b[32;1m✓ Creation completed successfully\r\n\u001b[0m"]
+[27.698042, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[30.293559, "o", "g"]
+[30.792912, "o", "y"]
+[31.450071, "o", " "]
+[32.16648, "o", "r"]
+[37.205028, "o", " "]
+[37.452683, "o", "a"]
+[37.669281, "o", "p"]
+[37.796858, "o", "p"]
+[38.326284, "o", " "]
+[39.16243, "o", "i"]
+[39.362248, "o", "n"]
+[39.533128, "o", "i"]
+[39.885741, "o", "t"]
+[40.959953, "o", " "]
+[41.726428, "o", "-"]
+[42.049775, "o", "p"]
+[42.386307, "o", " "]
+[46.847238, "o", "\u001b[7m5b508706-a257-4dc9-ab9d-91af914\u001b[27m\u001b[7me\u001b[27m\u001b[7m8ef2\u001b[27m"]
+[47.720417, "o", "\u001b[A\r\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ \u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C\u001b[C5b508706-a257-4dc9-ab9d-91af914e8ef2\r\n\u001b[?2004l\r"]
+[48.341306, "o", "\u001b[36mInitializing Ghaymah app in: \u001b[35;1m/home/jemy/weather-app\u001b[0;22m\r\n\u001b[0m"]
+[49.188509, "o", "time=2025-09-17T13:06:30.075+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[50.239613, "o", "time=2025-09-17T13:06:31.126+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[50.266843, "o", "\u001b[32;1m✓ App initialized successfully!\r\n\u001b[0m\u001b[36mConfig saved at: \u001b[35;1m/home/jemy/weather-app/.ghaymah.json\u001b[0;22m\r\n\u001b[0m\u001b[36mRun \u001b[35;1m'gy resource app launch'\u001b[0;22m to build and deploy.\r\n"]
+[50.267024, "o", "\u001b[0m"]
+[50.270292, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[51.235508, "o", "l"]
+[51.447786, "o", "s"]
+[52.136569, "o", " "]
+[52.581375, "o", "-"]
+[52.73776, "o", "a"]
+[53.195271, "o", "\r\n\u001b[?2004l\r"]
+[53.200045, "o", "\u001b[0m\u001b[01;34m.\u001b[0m  \u001b[01;34m..\u001b[0m  app.py  Dockerfile  .ghaymah.json  requirements.txt\r\n"]
+[53.200977, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[55.256794, "o", "v"]
+[55.445024, "o", "i"]
+[55.856467, "o", "m"]
+[56.064442, "o", " "]
+[56.813931, "o", "."]
+[57.347449, "o", "g"]
+[57.509265, "o", "h"]
+[57.655743, "o", "a"]
+[57.958825, "o", "ymah.json "]
+[58.800377, "o", "\r\n\u001b[?2004l\r"]
+[58.91728, "o", "\u001b[?1049h\u001b[22;0;0t\u001b[>4;2m\u001b[?1h\u001b=\u001b[?2004h\u001b[?1004h\u001b[1;24r\u001b[?12h\u001b[?12l\u001b[22;2t\u001b[22;1t"]
+[58.918178, "o", "\u001b[27m\u001b[23m\u001b[29m\u001b[m\u001b[H\u001b[2J\u001b[?25l\u001b[24;1H\".ghaymah.json\""]
+[58.918326, "o", " [noeol] 17L, 326B"]
+[58.930415, "o", "\u001b[2;1H▽\u001b[6n\u001b[2;1H  \u001b[3;1H\u001bPzz\u001b\\\u001b[0%m\u001b[6n\u001b[3;1H           \u001b[1;1H\u001b[>c\u001b]10;?\u0007\u001b]11;?\u0007"]
+[58.93412, "o", "\u001b[1;1H\u001b[35m{\u001b[m\r\n  \"\u001b[38;5;130mid\u001b[m\": \"\u001b[31m73d37fd4-692a-40b7-92bb-0137ad9cc790\u001b[m\",\u001b[2;48H\u001b[K\u001b[3;1H  \"\u001b[38;5;130mname\u001b[m\": \"\u001b[31mweather-app\u001b[m\",\u001b[3;25H\u001b[K\u001b[4;3H\"\u001b[38;5;130mprojectId\u001b[m\": \"\u001b[31m5b508706-a257-4dc9-ab9d-91af914e8ef2\u001b[m\",\r\n  \"\u001b[38;5;130mports\u001b[m\": \u001b[35m[\r\n\u001b[m    \u001b[35m{\u001b[m\u001b[7;7H\"\u001b[38;5;130mexpose\u001b[m\": \u001b[31mtrue\u001b[m,\u001b[8;7H\"\u001b[38;5;130mnumber\u001b[m\": \u001b[31m80\u001b[m\r\n    \u001b[35m}\r\n\u001b[m  \u001b[35m]\u001b[m,\r\n  \"\u001b[38;5;130mpublicAccess\u001b[m\": \u001b[35m{\u001b[m\r\n    \"\u001b[38;5;130menabled\u001b[m\": \u001b[31mtrue\u001b[m,\r\n    \"\u001b[38;5;130mdomain\u001b[m\": \"\u001b[31mauto\u001b[m\"\r\n  \u001b[35m}\u001b[m,\r\n  \"\u001b[38;5;130mresourceTier\u001b[m\": \"\u001b[31mt1\u001b[m\",\r\n  \"\u001b[38;5;130mdockerFileName\u001b[m\": \"\u001b[31mDockerfile\u001b[m\"\r\n\u001b[35m}\u001b[m\r\n\u001b[94m~                                                                               \u001b[19;1H~                                                                               \u001b[20;1H~                                                                               \u001b[21;1H~                                                                               \u001b[22;1H~                                                                               \u001b[23;1H~                                                                               \u001b[m\u001b[24;63H8,18\u001b[10CAll\u001b[8;18H\u001b[?25h\u001b[?4m"]
+[58.936286, "o", "\u001bP+q436f\u001b\\\u001bP+q6b75\u001b\\\u001bP+q6b64\u001b\\\u001bP+q6b72\u001b\\\u001bP+q6b6c\u001b\\\u001bP+q2332\u001b\\\u001bP+q2334\u001b\\\u001bP+q2569\u001b\\\u001bP+q2a37\u001b\\\u001bP+q6b31\u001b\\\u001bP$q q\u001b\\\u001b[?12$p"]
+[58.936613, "o", "\u001b[?25l\u001b[24;53H0\u001b[8;18H\u001b[24;54H3\u001b[8;18H\u001b[24;55H0\u001b[8;18H\u001b[24;56H/\u001b[8;18H\u001b[24;57H0\u001b[8;18H\u001b[24;58Ha\u001b[8;18H\u001b[24;59H0\u001b[8;18H\u001b[24;60Ha\u001b[8;18H\u001b[24;61H/\u001b[8;18H\u001b[24;62H2\u001b[8;18H"]
+[58.94312, "o", "\u001b[24;53H          \u001b[8;18H\u001b[27m\u001b[23m\u001b[29m\u001b[m\u001b[H\u001b[2J\u001b[1;1H\u001b[38;5;224m{\u001b[m\r\n  \"\u001b[93mid\u001b[m\": \"\u001b[95m73d37fd4-692a-40b7-92bb-0137ad9cc790\u001b[m\",\r\n  \"\u001b[93mname\u001b[m\": \"\u001b[95mweather-app\u001b[m\",\r\n  \"\u001b[93mprojectId\u001b[m\": \"\u001b[95m5b508706-a257-4dc9-ab9d-91af914e8ef2\u001b[m\",\r\n  \"\u001b[93mports\u001b[m\": \u001b[38;5;224m[\r\n\u001b[m    \u001b[38;5;224m{\u001b[m\u001b[7;7H\"\u001b[93mexpose\u001b[m\": \u001b[95mtrue\u001b[m,\u001b[8;7H\"\u001b[93mnumber\u001b[m\": \u001b[95m80\u001b[m\r\n    \u001b[38;5;224m}\r\n\u001b[m  \u001b[38;5;224m]\u001b[m,\r\n  \"\u001b[93mpublicAccess\u001b[m\": \u001b[38;5;224m{\u001b[m\r\n    \"\u001b[93menabled\u001b[m\": \u001b[95mtrue\u001b[m,\r\n    \"\u001b[93mdomain\u001b[m\": \"\u001b[95mauto\u001b[m\"\r\n  \u001b[38;5;224m}\u001b[m,\r\n  \"\u001b[93mresourceTier\u001b[m\": \"\u001b[95mt1\u001b[m\",\r\n  \"\u001b[93mdockerFileName\u001b[m\": \"\u001b[95mDockerfile\u001b[m\"\r\n\u001b[38;5;224m}\u001b[m\r\n\u001b[94m~                                                                               \u001b[19;1H~                                                                               \u001b[20;1H~                                                                               \u001b[21;1H~                                                                               \u001b[22;1H~                                                                               \u001b[23;1H~                                                                               \u001b[m\u001b[24;63H8,18\u001b[10CAll\r\".ghaymah.json\" [noeol] 17L, 326B\u001b[8;18H\u001b[?25h"]
+[60.845625, "o", "\u001b[?25l\u001b[24;53Hi\u001b[8;18H"]
+[60.845833, "o", "\u001b[24;53H \u001b[8;18H\u001b[24;1H\u001b[1m-- INSERT --\u001b[m\u001b[24;13H\u001b[K\u001b[24;63H8,18\u001b[10CAll\u001b[8;18H\u001b[?25h"]
+[61.506699, "o", "\u001b[?25l\u001b[6;5H\u001b[38;5;224m\u001b[46m{\u001b[9;5H}\u001b[m\u001b[24;63H9,6 \u001b[9;6H\u001b[?25h"]
+[62.154331, "o", "\u001b[?25l\u001b[6;5H\u001b[38;5;224m{\u001b[9;5H}\u001b[m\u001b[24;63H8,18\u001b[8;18H\u001b[?25h"]
+[62.651179, "o", "\u001b[?25l\u001b[24;66H9\u001b[8;19H\u001b[?25h"]
+[63.911391, "o", "\u001b[?25l\u001b[95m8\u001b[m\u001b[24;65H20\u001b[8;20H\u001b[?25h"]
+[66.327344, "o", "\u001b[?25l\u001b[95m0\u001b[m\u001b[24;66H1\u001b[8;21H\u001b[?25h"]
+[68.115028, "o", "\u001b[24;1H\u001b[K\u001b[8;20H\u001b[?25l\u001b[24;53H^[\u001b[8;20H"]
+[68.215362, "o", "\u001b[24;53H  \u001b[8;21H"]
+[68.215969, "o", "\u001b[24;63H8,20\u001b[10CAll\u001b[8;20H\u001b[?25h"]
+[68.445294, "o", "\u001b[?25l\u001b[24;53H:\u001b[8;20H\u001b[24;53H\u001b[K\u001b[24;1H:\u001b[?25h"]
+[69.005831, "o", "w"]
+[69.452055, "o", "q"]
+[70.145428, "o", "\r"]
+[70.145538, "o", "\u001b[?25l\u001b[?2004l\u001b[>4;m\".ghaymah.json\""]
+[70.149842, "o", " 17L, 329B written"]
+[70.15082, "o", "\r\u001b[23;2t\u001b[23;1t\r\r\n\u001b[?1004l\u001b[?2004l\u001b[?1l\u001b>\u001b[?1049l\u001b[23;0;0t\u001b[?25h\u001b[>4;m"]
+[70.152203, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[72.223776, "o", "c"]
+[72.370572, "o", "a"]
+[72.800203, "o", "t"]
+[72.973348, "o", " "]
+[74.288251, "o", "."]
+[74.755535, "o", "g"]
+[74.990332, "o", "h"]
+[75.330394, "o", "a"]
+[75.661096, "o", "ymah.json "]
+[76.335969, "o", "\r\n\u001b[?2004l\r"]
+[76.339399, "o", "{\r\n  \"id\": \"73d37fd4-692a-40b7-92bb-0137ad9cc790\",\r\n  \"name\": \"weather-app\",\r\n  \"projectId\": \"5b508706-a257-4dc9-ab9d-91af914e8ef2\",\r\n  \"ports\": [\r\n    {\r\n      \"expose\": true,\r\n      \"number\": 8080\r\n    }\r\n  ],\r\n  \"publicAccess\": {\r\n    \"enabled\": true,\r\n    \"domain\": \"auto\"\r\n  },\r\n  \"resourceTier\": \"t1\",\r\n  \"dockerFileName\": \"Dockerfile\"\r\n}\r\n"]
+[76.340166, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[84.102749, "o", "g"]
+[84.230756, "o", "y"]
+[84.53191, "o", " "]
+[84.684268, "o", "r"]
+[84.879961, "o", "e"]
+[85.213488, "o", "s"]
+[85.571058, "o", "o"]
+[85.810956, "o", "u"]
+[86.052719, "o", "r"]
+[86.355172, "o", "c"]
+[86.563186, "o", "e"]
+[87.102993, "o", " "]
+[87.652437, "o", "a"]
+[87.874949, "o", "p"]
+[88.025019, "o", "p"]
+[88.507908, "o", " "]
+[88.900018, "o", "l"]
+[89.072591, "o", "a"]
+[89.349566, "o", "u"]
+[89.585889, "o", "n"]
+[89.822095, "o", "c"]
+[90.0091, "o", "h"]
+[90.745415, "o", "\r\n\u001b[?2004l\r"]
+[91.581488, "o", "\u001b[36mLaunching app from: \u001b[35;1m/home/jemy/weather-app\u001b[0;22m\r\n\u001b[0m"]
+[92.709493, "o", "time=2025-09-17T13:07:13.596+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[93.525435, "o", "time=2025-09-17T13:07:14.412+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[93.911351, "o", "\u001b[36mGenerating app prefix...\r\n\u001b[0m\u001b[36mCreating artifact...\r\n\u001b[0m"]
+[93.912788, "o", "\u001b[36mUploading artifact...\r\n\u001b[0m"]
+[94.970389, "o", "\u001b[32;1m✓ Artifact uploaded successfully\r\n\u001b[0m\u001b[36mDeploying app \u001b[35;1mweather-app\u001b[0;22m...\r\n\u001b[0m"]
+[95.779417, "o", "\u001b[32;1m✓ App deployment initiated\r\n\u001b[0m\u001b[36mWaiting for deployment to complete...\r\n\u001b[0m"]
+[222.780587, "o", "\u001b[32;1m✓ App deployed successfully!\r\n\u001b[0m\u001b[35;1m\r\nYour app is available at: https://weather-app-12093abac772.hosted.ghaymah.systems\r\n\u001b[0m"]
+[222.781062, "o", "time=2025-09-17T13:09:23.668+03:00 level=INFO msg=\"Subscription handler stopped\" component=resource-manager\r\n"]
+[222.784734, "o", "\u001b[?2004h\u001b]0;jemy@Ahmed-Gamal: ~/weather-app\u0007\u001b[01;32mjemy@Ahmed-Gamal\u001b[00m:\u001b[01;34m~/weather-app\u001b[00m$ "]
+[226.905008, "o", "e"]
+[227.222206, "o", "x"]
+[227.409361, "o", "i"]
+[227.792557, "o", "t"]
+[228.040359, "o", "\r\n\u001b[?2004l\r"]
+[228.04048, "o", "exit\r\n"]

getting-started.md

@@ -1,96 +1,105 @@
 # Getting Started with Ghaymah CLI
-
 This topic describes how to install the latest release of **Ghaymah Command Line Interface (Ghaymah CLI)** on supported operating systems.
-
 ---
-
 ## Ghaymah CLI Install Instructions
-
 ### Installation
-
+<!-- tabs:start -->
-#### **Step 1:** Download & Install
+#### **Linux**
-
+<!-- tabs:start -->
+#### **Debian**
+Download & Install
 Run the following command to install the latest release of the Ghaymah CLI:
-
 ```bash
 curl -sSl https://cli.ghaymah.systems/install.sh | bash
 ```
-
+#### **Redhat**
-#### **Step 2:** Update PATH
+1.Download & Install
-
+Run the following command to install the latest release of the Ghaymah CLI:
+```bash
+curl -sSl https://cli.ghaymah.systems/install.sh | bash
+```
+2.update PATH
 Add the CLI to your PATH and reload your shell configuration:
-
 ```bash
 echo 'export PATH=$HOME/bin:$PATH' >> ~/.bashrc
 source ~/.bashrc
 ```
+<!-- tabs:end -->
+#### **macOS**
+Since the Ghaymah CLI is built for Linux environments only, macOS users need to run it inside a Linux environment.
 
-#### **Step 3:** Verify Installation
+**Using Virtualization**
+* Install a hypervisor (e.g., UTM, VirtualBox, or Parallels).
+* Create a Linux VM.
+* Inside the VM, follow the Linux installation steps.
+#### **Windows**
+Since Ghaymah CLI is built for Linux environments only, Windows users have two options to run it:
 
+**Option 1: Using WSL**
+1. Install WSL:
+   ```
+   wsl --install
+   ```
+
+2. Choose a Linux distribution.
+
+3. Open the WSL terminal and follow the Linux installation steps.
+
+For more information check [WSL Documentation](https://learn.microsoft.com/en-us/windows/wsl/install)
+
+**Option 2: Using Virtualization**
+
+If you prefer a full Linux virtual machine:
+* Install a hypervisor (e.g., VMware, VirtualBox, or Hyper-V).
+* Create a Linux VM.
+* Inside the VM, follow the Linux installation steps.
+<!-- tabs:end -->
+### Verifying 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
 echo $SHELL
 ```
-
 > **Supported shells:** `bash`, `zsh`, `fish`
-
 #### **Step 2:** Enable Shell Completion
-
 Enable shell completion to get command suggestions and auto-completion.
-
 **For Bash**, run:
-
 ```bash
 gy completion bash >> ~/gy-completion.sh
 ```
-
 Then add the generated completion script to your shell configuration:
-
 ```bash
 echo "source ~/gy-completion.sh" >> ~/.bashrc
 ```
-
 > **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:
 ```
+
+### Tutorial
+Here’s a quick walkthrough of installing and using the Ghaymah CLI:
+
+![Ghaymah CLI Tutorial](demo.gif) 

index.html

@@ -24,7 +24,7 @@
         window.$docsify = {
             name: "Ghaymah Docs",
             loadSidebar: true,
-            subMaxLevel: 3,
+            subMaxLevel: 2,
         };
     </script>
 
@@ -32,8 +32,10 @@
     <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 -->
+    Recommended
     <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
 </body>
 
 </html>

project_recorded/createprojct

@@ -0,0 +1,46 @@
+{"version": 2, "width": 120, "height": 30, "timestamp": 1757955296, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.075078, "o", "bash: /bin/brew: No such file or directory\r\n"]
+[0.079149, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[1.661826, "o", "g"]
+[3.970349, "o", "y"]
+[4.343867, "o", " "]
+[6.963861, "o", "r"]
+[7.099623, "o", " "]
+[7.435739, "o", "p"]
+[7.652828, "o", " "]
+[8.499591, "o", "c"]
+[8.747204, "o", " "]
+[9.608241, "o", "-"]
+[9.881941, "o", "-"]
+[10.097505, "o", "s"]
+[10.330202, "o", "e"]
+[10.55086, "o", "t"]
+[10.714278, "o", " "]
+[11.950514, "o", "."]
+[12.347723, "o", "n"]
+[12.867006, "o", "a"]
+[13.019412, "o", "m"]
+[13.258761, "o", "e"]
+[14.524417, "o", "="]
+[14.950114, "o", "\""]
+[16.212716, "o", "p"]
+[16.383322, "o", "r"]
+[16.549484, "o", "o"]
+[18.132696, "o", "j"]
+[18.229738, "o", "e"]
+[19.733462, "o", "c"]
+[20.020822, "o", "t"]
+[20.791926, "o", "n"]
+[20.896581, "o", "a"]
+[21.028746, "o", "m"]
+[21.17364, "o", "e"]
+[22.174199, "o", "\""]
+[23.291719, "o", "\r\n\u001b[?2004l\r"]
+[26.513058, "o", "time=2025-09-15T19:55:23.417+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[27.528445, "o", "time=2025-09-15T19:55:24.433+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[27.534116, "o", "\u001b[36mCreating project...\r\n\u001b[0m"]
+[28.349391, "o", "\u001b[32;1m✓ project created successfully. ID: 5e579218-176a-430d-979f-5e2419ac8d27\r\n\u001b[0m\u001b[36mWaiting for creation to complete...\r\n\u001b[0m"]
+[29.85039, "o", "\u001b[32;1m✓ Creation completed successfully\r\n\u001b[0m"]
+[29.850623, "o", "time=2025-09-15T19:55:26.755+03:00 level=INFO msg=\"Subscription handler stopped\" component=resource-manager\r\n"]
+[29.85632, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[30.990695, "o", "\u001b[?2004l\r\r\nexit\r\n"]

project_recorded/deleteproject

@@ -0,0 +1,52 @@
+{"version": 2, "width": 125, "height": 31, "timestamp": 1757960173, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.06284, "o", "bash: /bin/brew: No such file or directory\r\n"]
+[0.066012, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[0.810701, "o", "g"]
+[1.047306, "o", "y"]
+[1.163156, "o", " "]
+[1.723776, "o", "r"]
+[1.855369, "o", " "]
+[2.118609, "o", "p"]
+[2.312717, "o", " "]
+[3.592143, "o", "g"]
+[3.740691, "o", "\r\n\u001b[?2004l\r"]
+[6.417885, "o", "time=2025-09-15T21:16:20.244+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[7.496442, "o", "time=2025-09-15T21:16:21.322+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[7.507018, "o", "[\r\n  {\r\n    \"id\": \"469e81f3-59c6-4e85-a171-1a032ec2b3c9\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"updated_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"game_shell\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  },\r\n  {\r\n    \"id\": \"b1f0fce2-0592-458a-8349-6f7161d5857b\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-09-15T18:15:50.227727+00:00\",\r\n    \"updated_at\": \"2025-09-15T18:15:50.227727+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"test\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  },\r\n  {\r\n    \"id\": \"85e86e9a-e7a9-41f6-a05b-0007c73b7e18\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"updated_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"update_project\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  }\r\n]\r\n"]
+[7.513168, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[14.117644, "o", " "]
+[14.892691, "o", "g"]
+[15.051782, "o", "y"]
+[15.163903, "o", " "]
+[15.532255, "o", "r"]
+[15.684281, "o", " "]
+[15.865025, "o", "p"]
+[16.002365, "o", " "]
+[16.624448, "o", "d"]
+[16.755364, "o", " "]
+[17.372299, "o", "\u001b[7m\"b1f0fce2-0592-458a-8349-6f7161d5857b\"\u001b[27m"]
+[17.647728, "o", "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\"b1f0fce2-0592-458a-8349-6f7161d5857b\"\r\n\u001b[?2004l\r"]
+[19.657511, "o", "time=2025-09-15T21:16:33.483+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[20.649957, "o", "time=2025-09-15T21:16:34.476+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[20.650971, "o", "\u001b[36m"]
+[20.651262, "o", "Deleting project b1f0fce2-0592-458a-8349-6f7161d5857b...\r\n\u001b[0m"]
+[21.368382, "o", "\u001b[32;1m✓ Project deleted successfully\r\n\u001b[0m"]
+[21.369264, "o", "time=2025-09-15T21:16:35.195+03:00 level=INFO msg=\"Subscription handler stopped\" component=resource-manager\r\n"]
+[21.373129, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[22.94785, "o", "g"]
+[23.081845, "o", "y"]
+[23.183821, "o", " "]
+[24.006142, "o", "r"]
+[24.472046, "o", " "]
+[24.759753, "o", "p"]
+[24.868071, "o", " "]
+[25.379954, "o", "d"]
+[25.799372, "o", "\b\u001b[K"]
+[25.913744, "o", "g"]
+[26.07575, "o", "\r\n\u001b[?2004l\r"]
+[28.741413, "o", "time=2025-09-15T21:16:42.567+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[30.685348, "o", "time=2025-09-15T21:16:44.511+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[30.687476, "o", "[\r\n  {\r\n    \"id\": \"469e81f3-59c6-4e85-a171-1a032ec2b3c9\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"updated_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"game_shell\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  },\r\n  {\r\n    \"id\": \"85e86e9a-e7a9-41f6-a05b-0007c73b7e18\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"updated_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"update_project\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  }\r\n]\r\n"]
+[30.688258, "o", "time=2025-09-15T21:16:44.514+03:00 level=INFO msg=\"Subscription handler stopped\" component=resource-manager\r\n"]
+[30.691594, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[33.823737, "o", "\u001b[?2004l\r\r\nexit\r\n"]

project_recorded/updateproject

@@ -0,0 +1,66 @@
+{"version": 2, "width": 125, "height": 31, "timestamp": 1757960047, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.048666, "o", "bash: /bin/brew: No such file or directory\r\n"]
+[0.051261, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[0.609823, "o", "g"]
+[0.780965, "o", "y"]
+[0.970518, "o", " "]
+[2.061787, "o", "r"]
+[2.22819, "o", " "]
+[2.42857, "o", "p"]
+[2.53565, "o", " "]
+[3.582318, "o", "g"]
+[3.712193, "o", "\r\n\u001b[?2004l\r"]
+[6.195821, "o", "time=2025-09-15T21:14:14.176+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[7.545711, "o", "time=2025-09-15T21:14:15.526+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[7.547234, "o", "[\r\n  {\r\n    \"id\": \"469e81f3-59c6-4e85-a171-1a032ec2b3c9\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"updated_at\": \"2025-08-26T18:35:03.090341+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"game_shell\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  },\r\n  {\r\n    \"id\": \"85e86e9a-e7a9-41f6-a05b-0007c73b7e18\",\r\n    \"user_id\": \"3176d82e-5b75-43cb-a518-90cf2722836a\",\r\n    \"chart_name\": \"ghaymah-project\",\r\n    \"chart_version\": \"0.0\",\r\n    \"status\": \"synced\",\r\n    \"message\": \"Successfully deployed\",\r\n    \"created_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"updated_at\": \"2025-09-08T08:46:27.270791+00:00\",\r\n    \"deleted\": false,\r\n    \"values\": {\r\n      \"name\": \"my_first_project\",\r\n      \"userId\": \"00000000-0000-0000-0000-000000000000\"\r\n    }\r\n  }\r\n]\r\n"]
+[7.552597, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[13.516811, "o", " "]
+[13.769507, "o", "g"]
+[13.94546, "o", "y"]
+[14.053542, "o", " "]
+[15.451276, "o", "r"]
+[15.615605, "o", " "]
+[15.801603, "o", "p"]
+[15.892314, "o", " "]
+[16.875364, "o", "u"]
+[17.022084, "o", " "]
+[18.267846, "o", "\u001b[7m85e86e9a-e7a9-41f6-a05b-0007c73b7e18\u001b[27m"]
+[18.795977, "o", "\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b85e86e9a-e7a9-41f6-a05b-0007c73b7e18 "]
+[19.670696, "o", "-"]
+[19.78028, "o", "-"]
+[19.968047, "o", "s"]
+[20.187145, "o", "e"]
+[20.401866, "o", "t"]
+[20.603061, "o", " "]
+[21.214022, "o", "."]
+[21.531993, "o", "m"]
+[21.823887, "o", "\b\u001b[K"]
+[22.861155, "o", "n"]
+[22.980981, "o", "a"]
+[23.109745, "o", "m"]
+[23.226896, "o", "e"]
+[24.179914, "o", "="]
+[24.636699, "o", "\""]
+[26.576039, "o", "u"]
+[26.894846, "o", "p"]
+[27.136738, "o", "d"]
+[27.303868, "o", "a"]
+[27.540862, "o", "t"]
+[27.66499, "o", "e"]
+[29.950954, "o", "_"]
+[30.380157, "o", "p"]
+[30.596147, "o", "r"]
+[30.762974, "o", "o"]
+[31.055131, "o", "j"]
+[31.176743, "o", "e"]
+[31.448631, "o", "c"]
+[31.898195, "o", "t"]
+[33.121472, "o", "\""]
+[34.035886, "o", "\r\n\u001b[?2004l\r"]
+[36.212391, "o", "time=2025-09-15T21:14:44.192+03:00 level=INFO msg=\"Connecting to GraphQL\" component=graphql endpoint=wss://graphql.ghaymah.systems/v1/graphql\r\n"]
+[37.468317, "o", "time=2025-09-15T21:14:45.448+03:00 level=INFO msg=\"GraphQL connection established\" component=graphql\r\n"]
+[37.469474, "o", "\u001b[36mUpdating project 85e86e9a-e7a9-41f6-a05b-0007c73b7e18...\r\n\u001b[0m"]
+[38.259841, "o", "\u001b[32;1m✓ Project updated successfully\r\n\u001b[0m\u001b[36mWaiting for update to complete...\r\n\u001b[0m"]
+[40.761256, "o", "\u001b[32;1m✓ Update completed successfully\r\n\u001b[0m"]
+[40.765021, "o", "\u001b[?2004h\u001b]0;elhady@elhady: ~/asciicast\u0007\u001b[01;32melhady@elhady\u001b[00m:\u001b[01;34m~/asciicast\u001b[00m$ "]
+[43.052606, "o", "\u001b[?2004l\r\r\nexit\r\n"]