chore: update installation documentation via cli (#323)

Author: raghavyuva

README.md

@@ -76,32 +76,56 @@ Nixopus streamlines your workflow with comprehensive tools for deployment, monit
 
 This section will help you set up Nixopus on your VPS quickly.
 
-To install Nixopus on your VPS, ensure you have sudo access and run the following command:
+### Install the Nixopus CLI
 
+First, install the Nixopus CLI tool:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh | sudo bash
 ```
-sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)"
+
+### Self Host Nixopus on your VPS
+
+Once the CLI is installed, you can self host Nixopus on your VPS:
+
+```bash
+nixopus install
 ```
 
 #### Optional Parameters
 
 You can customize your installation by providing the following optional parameters:
 
-- `--api-domain`: Specify the domain where the Nixopus API will be accessible (e.g., `nixopusapi.example.tld`)
-- `--app-domain`: Specify the domain where the Nixopus app will be accessible (e.g., `nixopus.example.tld`)
-- `--email` or `-e`: Set the email for the admin account
-- `--password` or `-p`: Set the password for the admin account
+- `--api-domain` or `-ad`: Specify the domain where the Nixopus API will be accessible (e.g., `nixopusapi.example.tld`)
+- `--view-domain` or `-vd`: Specify the domain where the Nixopus app will be accessible (e.g., `nixopus.example.tld`)
+- `--verbose` or `-v`: Show more details while installing
+- `--timeout` or `-t`: Set timeout for each step (default: 300 seconds)
+- `--force` or `-f`: Replace files if they already exist
+- `--dry-run` or `-d`: See what would happen without making changes
+- `--config-file` or `-c`: Path to custom config file (defaults to built-in [`config.prod.yaml`](https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/helpers/config.prod.yaml)) 
 
 Example with optional parameters:
 
-```
-sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)" -- \
+```bash
+nixopus install \
   --api-domain nixopusapi.example.tld \
-  --app-domain nixopus.example.tld \
-  --email [email protected] \
-  --password Adminpassword@123 \
-  --env production
+  --view-domain nixopus.example.tld \
+  --verbose \
+  --timeout 600
 ```
 
+#### Additional CLI Commands
+
+The Nixopus CLI provides several other useful commands:
+
+- `nixopus preflight` - Check system requirements before installation
+- `nixopus install deps` - Install only dependencies
+- `nixopus install ssh` - Generate SSH keys for deployment
+- `nixopus service` - Manage Nixopus services
+- `nixopus uninstall` - Remove Nixopus from your system
+
+Run `nixopus --help` to see all available commands.
+
 ## About the Name
 
 Nixopus is derived from the combination of "octopus" and the Linux penguin (Tux). While the name might suggest a connection to [NixOS](https://nixos.org/), Nixopus is an independent project with no direct relation to NixOS or its ecosystem.

docs/cli/installation.md

@@ -19,11 +19,7 @@ python3 --version
 Download and install the pre-built binary for your platform:
 
 ```bash
-# Download and run the install script
-curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/master/cli/install.sh | bash
-
-# Or for local installation (no sudo required)
-curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/master/cli/install.sh | bash -s -- --local
+sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh)"
 ```
 
 **Install script options:**
@@ -115,6 +111,29 @@ Expected output:
 └─────────────────────────────────────────────────┘
 ```
 
+## Next Steps: Installing Nixopus
+
+Once the CLI is installed, you can use it to install Nixopus on your VPS:
+
+```bash
+# Basic installation
+nixopus install
+
+# Installation with custom domains
+nixopus install \
+  --api-domain api.example.com \
+  --view-domain app.example.com \
+  --verbose
+
+# Check system requirements first
+nixopus preflight
+
+# Install only dependencies
+nixopus install deps
+```
+
+For detailed installation options, see the [Installation Guide](../install/index.md).
+
 ## Troubleshooting
 
 ### Command Not Found

docs/index.md

@@ -9,9 +9,9 @@ hero:
 <div style="display: flex; justify-content: center; align-items: center; margin: 1.5em 0;">
   <div style="position: relative; display: inline-flex; align-items: center; background: rgba(0,0,0,0.18); border-radius: 12px; border: 1px solid #a78bfa; overflow: hidden; box-shadow: 0 4px 12px rgba(0,0,0,0.15); min-width: 400px; max-width: 90vw;">
         <div style="flex: 1; padding: 1.2em 1.5em; font-family: 'Fira Code', 'Monaco', 'Consolas', monospace; font-size: 1.05em; color: #fff; background: rgba(0,0,0,0.18); overflow-x: auto; white-space: nowrap; max-width: 600px;">
-      sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)"
+      sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh)"
     </div>
-    <button onclick="navigator.clipboard.writeText('curl -sSL https://nixopus.sh/install.sh | bash'); this.innerText='Copied!'; setTimeout(()=>this.innerText='Copy',1200);" style="color: #fff; border: none; padding: 1.2em 1.5em; font-weight: 600; font-size: 0.9em; cursor: pointer; transition: all 0.2s; outline: none; border-left: 1px solid #a78bfa; min-width: 80px; display: flex; align-items: center; justify-content: center;">Copy</button>
+    <button onclick="navigator.clipboard.writeText('sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh)"'); this.innerText='Copied!'; setTimeout(()=>this.innerText='Copy',1200);" style="color: #fff; border: none; padding: 1.2em 1.5em; font-weight: 600; font-size: 0.9em; cursor: pointer; transition: all 0.2s; outline: none; border-left: 1px solid #a78bfa; min-width: 80px; display: flex; align-items: center; justify-content: center;">Copy</button>
   </div>
 </div>
 <SponsorsMarquee />

docs/install/index.md

@@ -2,30 +2,49 @@
 
 Welcome to the Nixopus installation guide. This section will help you set up Nixopus on your VPS quickly.
 
-To install Nixopus on your VPS, ensure you have sudo access and run the following command:
+## Prerequisites
 
+- **VPS with sudo access**
+- **Nixopus CLI installed** (see [CLI Installation Guide](../cli/installation.md))
+
+## Quick Installation
+
+### Step 1: Install the Nixopus CLI
+
+First, install the Nixopus CLI tool:
+
+```bash
+sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install-cli.sh)"
 ```
-sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)"
+
+### Step 2: Install Nixopus on your VPS
+
+Once the CLI is installed, you can install Nixopus on your VPS:
+
+```bash
+nixopus install
 ```
 
-## Optional Parameters
+## Installation Options
 
 You can customize your installation by providing the following optional parameters:
 
-- `--api-domain`: Specify the domain where the Nixopus API will be accessible (e.g., `nixopusapi.example.tld`)
-- `--app-domain`: Specify the domain where the Nixopus app will be accessible (e.g., `nixopus.example.tld`)
-- `--email` or `-e`: Set the email for the admin account
-- `--password` or `-p`: Set the password for the admin account
+- `--api-domain` or `-ad`: Specify the domain where the Nixopus API will be accessible (e.g., `nixopusapi.example.tld`)
+- `--view-domain` or `-vd`: Specify the domain where the Nixopus app will be accessible (e.g., `nixopus.example.tld`)
+- `--verbose` or `-v`: Show more details while installing
+- `--timeout` or `-t`: Set timeout for each step (default: 300 seconds)
+- `--force` or `-f`: Replace files if they already exist
+- `--dry-run` or `-d`: See what would happen without making changes
+- `--config-file` or `-c`: Path to custom config file (defaults to built-in [`config.prod.yaml`](https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/helpers/config.prod.yaml))
 
 Example with optional parameters:
 
-```
-sudo bash -c "$(curl -sSL https://raw.githubusercontent.com/raghavyuva/nixopus/refs/heads/master/scripts/install.sh)" -- \
+```bash
+nixopus install \
   --api-domain nixopusapi.example.tld \
-  --app-domain nixopus.example.tld \
-  --email [email protected] \
-  --password Adminpassword@123 \
-  --env production
+  --view-domain nixopus.example.tld \
+  --verbose \
+  --timeout 600
 ```
 
 ## Accessing Nixopus