Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b01c0a64be | ||
|
|
1eaaf00f63 | ||
|
|
17feae0491 | ||
|
|
dee9c1b220 | ||
|
|
6714506b3f |
@@ -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
|
||||
@@ -4,3 +4,4 @@ RUN npm install -g docsify-cli
|
||||
COPY . .
|
||||
EXPOSE 3000
|
||||
CMD ["docsify", "serve", ".","-p", "3000"]
|
||||
|
||||
|
||||
-39
@@ -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
|
||||
```
|
||||
@@ -7,3 +7,6 @@
|
||||
- Features
|
||||
- [Integrations](features/integrations.md)
|
||||
- [Projects](features/Projects.md)
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -9,7 +9,6 @@ This topic describes how to install the latest release of **Ghaymah Command Line
|
||||
### Installation
|
||||
|
||||
#### **Step 1:** Download & Install
|
||||
|
||||
Run the following command to install the latest release of the Ghaymah CLI:
|
||||
|
||||
```bash
|
||||
@@ -17,7 +16,6 @@ curl -sSl https://cli.ghaymah.systems/install.sh | bash
|
||||
```
|
||||
|
||||
#### **Step 2:** Update PATH
|
||||
|
||||
Add the CLI to your PATH and reload your shell configuration:
|
||||
|
||||
```bash
|
||||
@@ -26,7 +24,6 @@ source ~/.bashrc
|
||||
```
|
||||
|
||||
#### **Step 3:** Verify Installation
|
||||
|
||||
Check that the CLI is installed correctly:
|
||||
|
||||
```bash
|
||||
@@ -46,7 +43,6 @@ Latest version: xx.xx.xx
|
||||
### Enable Auto-Completion
|
||||
|
||||
#### **Step 1:** Check Your Shell
|
||||
|
||||
Run the following command to check which shell you are using:
|
||||
|
||||
```bash
|
||||
@@ -56,7 +52,6 @@ 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:
|
||||
@@ -76,20 +71,17 @@ echo "source ~/gy-completion.sh" >> ~/.bashrc
|
||||
---
|
||||
|
||||
### 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:
|
||||
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:
|
||||
-25
@@ -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
|
||||
|
||||
|
||||
@@ -1,13 +1,11 @@
|
||||
<!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>
|
||||
|
||||
@@ -21,5 +19,4 @@
|
||||
|
||||
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user