@webhikers/cli 1.1.4 → 1.1.5

package/README.md

@@ -1,6 +1,37 @@
 # @webhikers/cli
 
-CLI for creating and deploying webhikers projects.
+CLI for creating and deploying webhikers projects on Hetzner/Coolify.
+
+## Prerequisites
+
+Before using this CLI, you need:
+
+1. **Hetzner Cloud Server** with Coolify installed
+2. **Wildcard DNS** `*.preview.webhikers.dev` pointing to your server IP
+3. **GitHub CLI** (`gh`) installed and authenticated
+4. **Node.js** >= 18
+5. **SSH Key** on your machine, added to the Hetzner server
+
+### Server Setup (one-time)
+
+1. Create a Hetzner CX23 server (Ubuntu 24.04)
+2. Add your SSH public key during server creation
+3. SSH into the server: `ssh -i ~/.ssh/your-key root@SERVER_IP`
+4. Install Coolify: `curl -fsSL https://cdn.coollabs.io/coolify/install.sh | bash`
+5. Open `http://SERVER_IP:8000`, create admin account
+6. Enable API access: Settings → API Settings → API Access checkbox
+7. Create API token: Keys & Tokens → create token with root permissions
+8. Note your Server UUID: Servers → click server → UUID is in the URL
+
+### DNS Setup (one-time)
+
+Add a wildcard A record for your domain:
+
+| Type | Name | Value |
+|------|------|-------|
+| A | `*.preview` | `SERVER_IP` |
+
+This makes every project available at `project-name.preview.webhikers.dev`.
 
 ## Install
 
@@ -14,7 +45,18 @@ npm install -g @webhikers/cli
 webhikers config
 ```
 
-Configures Coolify API token, server credentials, and SSH key.
+You will be asked for:
+
+| Prompt | Where to find it |
+|--------|-----------------|
+| Server IP | Hetzner Cloud Console → Server |
+| Coolify Port | Default: 8000 |
+| Coolify API Token | Coolify UI → Keys & Tokens |
+| Server UUID | Coolify UI → Servers → UUID in URL |
+| SSH User | Default: root |
+| SSH Key | Select from detected keys on your machine |
+
+Config is saved to `~/.config/webhikers/config.json`.
 
 ## Create a new project
 
@@ -23,17 +65,67 @@ webhikers create my-project
 ```
 
 This will:
+
 1. Create a private GitHub repo from the `nextjs-vibe-starter` template
 2. Clone it and install dependencies
 3. Generate `.env` with a random `PAYLOAD_SECRET`
-4. Create a Coolify project and configure the domain (`my-project.webhikers.site`)
+4. Create a Coolify project with domain `my-project.preview.webhikers.dev`
+5. Set environment variables in Coolify
+6. Trigger the first deploy
 
-After creation, add persistent volumes in Coolify UI, then start developing:
+After creation, add persistent volumes in Coolify UI:
+
+1. Open Coolify → Projects → select your project
+2. Go to **Storages** tab
+3. Add volume: `/app/data` (SQLite database)
+4. Add volume: `/app/public/media` (uploaded images)
+5. Redeploy the application
+
+Then start local development:
 
 ```bash
 cd my-project && npm run dev
 ```
 
+## Architecture
+
+```
+~/.config/webhikers/
+  config.json        ← Coolify token, server IP, SSH config (global)
+  ssh_key            ← SSH private key (chmod 600)
+
+project/
+  .env               ← PAYLOAD_SECRET + SITE_URL (local dev, gitignored)
+  .deploy.json       ← Server IP, domain, Coolify UUIDs (gitignored)
+```
+
+- **Local dev:** `npm run dev` → localhost:3000
+- **Sync from prod:** `npm run sync:pull` (git pull + DB + media)
+- **Deploy:** `npm run sync:push` (media push + git push → Coolify builds)
+- **Coolify** handles Docker build, Payload migrations, and seed on every deploy
+
+## Adding a team member
+
+Your team member creates their own SSH key and sends you the public key (`.pub` file). Then:
+
+```bash
+ssh -i ~/.ssh/your-key root@SERVER_IP
+echo "their-public-key-content" >> /root/.ssh/authorized_keys
+```
+
+They install the CLI and run `webhikers config` with the same server details.
+
+## Scaling
+
+| Server | RAM | Capacity |
+|--------|-----|----------|
+| CX23 | 4 GB | 5-10 sites |
+| CX33 | 8 GB | 20-30 sites |
+| CX43 | 16 GB | 50-80 sites |
+| CX53 | 32 GB | 100-150 sites |
+
+Upgrade via Hetzner Console (30 sec, no data loss). For 150+ sites, add a second server — Coolify manages multiple servers natively.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webhikers/cli",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "CLI for creating and deploying webhikers projects",
   "type": "module",
   "bin": {

package/src/commands/create.js

@@ -1,5 +1,5 @@
 import { execSync } from "child_process";
-import { existsSync, writeFileSync, readFileSync } from "fs";
+import { existsSync, writeFileSync } from "fs";
 import { resolve } from "path";
 import { loadConfig, getConfigPath } from "../utils/config-store.js";
 
@@ -7,8 +7,18 @@ const TEMPLATE_REPO = "Webhikers/nextjs-vibe-starter";
 const GITHUB_ORG = "Webhikers";
 const DOMAIN_SUFFIX = "preview.webhikers.dev";
 
+// ANSI colors
+const c = {
+  green: (s) => `\x1b[32m${s}\x1b[0m`,
+  red: (s) => `\x1b[31m${s}\x1b[0m`,
+  yellow: (s) => `\x1b[33m${s}\x1b[0m`,
+  cyan: (s) => `\x1b[36m${s}\x1b[0m`,
+  bold: (s) => `\x1b[1m${s}\x1b[0m`,
+  dim: (s) => `\x1b[2m${s}\x1b[0m`,
+};
+
 function run(cmd, options = {}) {
-  console.log(`  → ${cmd}`);
+  console.log(c.dim(`  → ${cmd}`));
   return execSync(cmd, { stdio: "inherit", ...options });
 }
 
@@ -39,12 +49,12 @@ async function coolifyApi(config, method, path, body) {
 }
 
 export async function createCommand(name) {
-  console.log(`\nCreating project: ${name}\n`);
+  console.log(c.bold(`\nCreating project: ${name}\n`));
 
   // --- 1. Check prerequisites ---
   const config = loadConfig();
   if (!config) {
-    console.error(`Error: ${getConfigPath()} not found.`);
+    console.error(c.red(`Error: ${getConfigPath()} not found.`));
     console.error("Run 'webhikers config' first.");
     process.exit(1);
   }
@@ -52,7 +62,7 @@ export async function createCommand(name) {
   try {
     runCapture("which gh");
   } catch {
-    console.error("Error: GitHub CLI (gh) not found.");
+    console.error(c.red("Error: GitHub CLI (gh) not found."));
     console.error("Install it: https://cli.github.com");
     process.exit(1);
   }
@@ -60,21 +70,19 @@ export async function createCommand(name) {
   try {
     runCapture("gh auth status");
   } catch {
-    console.error("Error: Not logged into GitHub CLI.");
+    console.error(c.red("Error: Not logged into GitHub CLI."));
     console.error("Run: gh auth login");
     process.exit(1);
   }
 
   // --- 2. Create GitHub repo from template ---
-  console.log("Creating GitHub repo from template...");
+  console.log(c.cyan("1/6 Creating GitHub repo from template..."));
 
-  // Create repo first (without --clone, to avoid race condition)
   run(
     `gh repo create ${GITHUB_ORG}/${name} --template ${TEMPLATE_REPO} --private`
   );
 
-  // Wait for GitHub to finish creating the repo from template
-  console.log("  Waiting for GitHub to prepare the repository...");
+  console.log(c.dim("  Waiting for GitHub to prepare the repository..."));
   const maxRetries = 12;
   let cloned = false;
   for (let i = 0; i < maxRetries; i++) {
@@ -84,28 +92,30 @@ export async function createCommand(name) {
       cloned = true;
       break;
     } catch {
-      console.log(`  Retrying clone... (${i + 1}/${maxRetries})`);
+      console.log(c.dim(`  Retrying clone... (${i + 1}/${maxRetries})`));
     }
   }
 
   if (!cloned) {
-    console.error("Error: Could not clone repo after 60 seconds.");
+    console.error(c.red("Error: Could not clone repo after 60 seconds."));
     console.error(`Try manually: gh repo clone ${GITHUB_ORG}/${name}`);
     process.exit(1);
   }
 
   const projectDir = resolve(process.cwd(), name);
   if (!existsSync(projectDir)) {
-    console.error(`Error: Expected directory ${projectDir} not found.`);
+    console.error(c.red(`Error: Expected directory ${projectDir} not found.`));
     process.exit(1);
   }
+  console.log(c.green("  ✓ Repo created and cloned"));
 
   // --- 3. npm install ---
-  console.log("\nInstalling dependencies...");
+  console.log(c.cyan("\n2/6 Installing dependencies..."));
   run("npm install", { cwd: projectDir });
+  console.log(c.green("  ✓ Dependencies installed"));
 
   // --- 4. Generate .env ---
-  console.log("\nGenerating .env...");
+  console.log(c.cyan("\n3/6 Generating .env..."));
   const payloadSecret = runCapture("openssl rand -hex 32");
   const domain = `${name}.${DOMAIN_SUFFIX}`;
   const siteUrl = `https://${domain}`;
@@ -116,33 +126,29 @@ export async function createCommand(name) {
   ].join("\n");
 
   writeFileSync(resolve(projectDir, ".env"), envContent, "utf-8");
-  console.log("  .env written (PAYLOAD_SECRET + SITE_URL)");
+  console.log(c.green("  ✓ .env written"));
 
   // --- 5. Get git remote URL ---
   let gitRepo;
   try {
     gitRepo = runCapture("git remote get-url origin", { cwd: projectDir });
   } catch {
-    console.error("Error: No git remote 'origin' found.");
+    console.error(c.red("Error: No git remote 'origin' found."));
     process.exit(1);
   }
 
   // --- 6. Setup Coolify deployment ---
-  console.log("\nSetting up Coolify deployment...");
-  console.log(`  Domain: ${domain}`);
-  console.log(`  Git repo: ${gitRepo}`);
+  console.log(c.cyan("\n4/6 Setting up Coolify deployment..."));
+  console.log(`  Domain: ${c.bold(domain)}`);
 
-  // Create project
-  console.log("  Creating Coolify project...");
+  console.log(c.dim("  Creating Coolify project..."));
   const project = await coolifyApi(config, "POST", "/projects", {
     name,
     description: `${name} - deployed via webhikers CLI`,
   });
   const projectUuid = project.uuid;
-  console.log(`  Project created: ${projectUuid}`);
 
-  // Create application
-  console.log("  Creating application...");
+  console.log(c.dim("  Creating application..."));
   const app = await coolifyApi(config, "POST", "/applications/public", {
     project_uuid: projectUuid,
     server_uuid: config.serverUuid,
@@ -154,16 +160,13 @@ export async function createCommand(name) {
     instant_deploy: false,
   });
   const appUuid = app.uuid;
-  console.log(`  Application created: ${appUuid}`);
 
-  // Set domain
-  console.log(`  Setting domain to ${domain}...`);
+  console.log(c.dim(`  Setting domain...`));
   await coolifyApi(config, "PATCH", `/applications/${appUuid}`, {
     domains: `https://${domain}`,
   });
 
-  // Set environment variables
-  console.log("  Setting environment variables...");
+  console.log(c.dim("  Setting environment variables..."));
   await coolifyApi(config, "POST", `/applications/${appUuid}/envs`, {
     key: "PAYLOAD_SECRET",
     value: payloadSecret,
@@ -174,8 +177,10 @@ export async function createCommand(name) {
     value: siteUrl,
     is_preview: false,
   });
+  console.log(c.green("  ✓ Coolify project configured"));
 
   // --- 7. Write .deploy.json ---
+  console.log(c.cyan("\n5/6 Writing .deploy.json..."));
   const deployConfig = {
     serverIp: config.serverIp,
     domain,
@@ -187,24 +192,35 @@ export async function createCommand(name) {
     JSON.stringify(deployConfig, null, 2) + "\n",
     "utf-8"
   );
-  console.log("  .deploy.json written");
-
-  // --- 8. Summary ---
-  console.log("");
-  console.log("=========================================");
-  console.log("  Project created successfully!");
-  console.log("=========================================");
-  console.log("");
-  console.log(`  Repo:    https://github.com/${GITHUB_ORG}/${name}`);
-  console.log(`  Domain:  https://${domain}`);
-  console.log(`  Dir:     ${projectDir}`);
-  console.log("");
-  console.log("  MANUAL STEP:");
-  console.log("  Open Coolify UI → Application → Storages");
-  console.log("  Add two volumes:");
-  console.log("    1. /app/data          (SQLite database)");
-  console.log("    2. /app/public/media  (uploaded images)");
-  console.log("");
-  console.log(`  Ready! Run: cd ${name} && npm run dev`);
-  console.log("=========================================");
+  console.log(c.green("  ✓ .deploy.json written"));
+
+  // --- 8. Trigger first deploy ---
+  console.log(c.cyan("\n6/6 Triggering first deploy..."));
+  await coolifyApi(config, "POST", `/applications/${appUuid}/start`);
+  console.log(c.green("  ✓ Deploy triggered on Coolify"));
+
+  // --- 9. Summary ---
+  console.log("\n" + c.green("═══════════════════════════════════════════"));
+  console.log(c.green(c.bold("  Project created successfully!")));
+  console.log(c.green("═══════════════════════════════════════════\n"));
+
+  console.log(`  ${c.bold("Repo:")}     https://github.com/${GITHUB_ORG}/${name}`);
+  console.log(`  ${c.bold("Domain:")}   https://${domain}`);
+  console.log(`  ${c.bold("Coolify:")}  ${config.coolifyUrl}`);
+  console.log(`  ${c.bold("Dir:")}      ${projectDir}`);
+
+  console.log(c.yellow("\n  ┌─────────────────────────────────────────────┐"));
+  console.log(c.yellow("  │  MANUAL STEP: Add persistent volumes        │"));
+  console.log(c.yellow("  ├─────────────────────────────────────────────┤"));
+  console.log(c.yellow("  │                                             │"));
+  console.log(c.yellow("  │  1. Open Coolify UI → Projects              │"));
+  console.log(c.yellow(`  │  2. Select "${name}"                        │`));
+  console.log(c.yellow("  │  3. Go to Storages tab                      │"));
+  console.log(c.yellow("  │  4. Add volume: /app/data (SQLite DB)       │"));
+  console.log(c.yellow("  │  5. Add volume: /app/public/media (Uploads) │"));
+  console.log(c.yellow("  │  6. Redeploy the application                │"));
+  console.log(c.yellow("  │                                             │"));
+  console.log(c.yellow("  └─────────────────────────────────────────────┘"));
+
+  console.log(`\n  ${c.bold("Next:")} cd ${name} && npm run dev\n`);
 }