commit 6714506b3ff2a1cfa75588caa68f80c47ce8cb3d Author: Omar Ahmed Date: Wed Sep 10 19:41:30 2025 +0300 Add Dockerfile to serve docs with Docsify on port 3000 diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ffd43ef --- /dev/null +++ b/Dockerfile @@ -0,0 +1,7 @@ +FROM node:18-alpine +WORKDIR /app +RUN npm install -g docsify-cli +COPY . . +EXPOSE 3000 +CMD ["docsify", "serve", ".","-p", "3000"] + diff --git a/README.md b/README.md new file mode 100644 index 0000000..3929dd3 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# Welcome to Ghaymah CLI Docs diff --git a/_sidebar.md b/_sidebar.md new file mode 100644 index 0000000..23ecc8d --- /dev/null +++ b/_sidebar.md @@ -0,0 +1,12 @@ +- [About Ghaymah CLI](about-ghaymah-cli.md) + +- [Getting Started](getting-started.md) + +- [Using CLI](using-cli.md) + +- Features + - [Integrations](features/integrations.md) + - [Projects](features/Projects.md) + + + diff --git a/about-ghaymah-cli.md b/about-ghaymah-cli.md new file mode 100644 index 0000000..e69de29 diff --git a/features/Projects.md b/features/Projects.md new file mode 100644 index 0000000..e69de29 diff --git a/features/integrations.md b/features/integrations.md new file mode 100644 index 0000000..e69de29 diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..ed3ad35 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,60 @@ +# 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 + +### Linux + +#### **Step 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 +``` + +#### **Step 2:** Check Your Shell +Run the following command to check which shell you are using: + +```bash +echo $SHELL +``` + +> ** Supported shells:** `bash`, `zsh`, `fish` + +#### **Step 3:** 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 + +#### **Step 4:** 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! +``` + +--- + diff --git a/index.html b/index.html new file mode 100644 index 0000000..b1db9c3 --- /dev/null +++ b/index.html @@ -0,0 +1,502 @@ + + + + + Ghaymah CLI Docs + + + + + + +
+
+ + Loading Ghaymah CLI Documentation... +
+
+ + + + + + + + diff --git a/using-cli.md b/using-cli.md new file mode 100644 index 0000000..e69de29