diff --git a/Getting started.md b/Getting started.md new file mode 100644 index 0000000..4bf5cff --- /dev/null +++ b/Getting started.md @@ -0,0 +1,45 @@ +# بسم الله الرحمن الرحيم + + +## Installation + +> **Note:** Ghaymah CLI is currently supported only on **Linux**. + +To install the cli , run the following command: + +```bash +curl -sSl https://cli.ghaymah.systems/install.sh | bash +``` + +## Authentication + +## Command completion + +### Step 1: Identify your shell + +Run + +```bash +echo $SHELL +``` + +supported shells: +Supported shells: **bash**, **zsh**, **fish** + +### Step 2: Generate the completion script + +For Bash, run: + +```bash +gy completion bash >> ~/gy-completion.sh +``` + +### Step 3: Enable command completion + +Run + +```bash +echo "source ~/gy-completion.sh" >> ~/.bashrc +``` + +Then restart your terminal