feat: add instance detach helper

Author: bhdicaire

README.md

@@ -17,24 +17,26 @@ The website is the source of truth for setup and operations:
 
 Before starting, you need a registered short domain, GitHub and Cloudflare accounts, Git, Node.js 20 or newer, npm, and a text editor. The short domain must use Cloudflare as its authoritative DNS provider before the Worker can serve it.
 
-Create your own repository from this project, clone it, and install dependencies:
+Clone the vanityURLs code, detach the clone from the upstream project, then install dependencies:
 
 ```bash
-git clone git@github.com:YOUR-ORG/YOUR-SHORT-DOMAIN.git
-cd YOUR-SHORT-DOMAIN
+git clone https://github.com/vanityURLs/code.git redirector
+cd redirector
+npm run detach
 npm install
 ```
 
-Run the installer, then validate the plain instance:
+Run the installer, install local helpers, then validate the plain instance:
 
 ```bash
 npm run setup
+npm run local-install
 npm run check
 ```
 
 Review `wrangler.toml` and set the Worker name plus the route or custom domain for your short domain. Keep instance-specific files in `custom/`; do not edit `defaults/` unless you are contributing upstream changes to vanityURLs itself.
 
-Add your first links with `./scripts/lnk` or by editing `custom/v8s-links.txt`, push the repository to GitHub, and connect it to Cloudflare Workers & Pages. You can also deploy manually:
+Initialize Git, push the repository to GitHub, and connect it to Cloudflare Workers & Pages. You can also deploy manually:
 
 ```bash
 npx wrangler deploy --config wrangler.toml

package.json

@@ -8,6 +8,7 @@
     "build:links": "node scripts/build.mjs",
     "clean": "node scripts/clean.mjs",
     "convert:lnk": "node scripts/convert-lnk.mjs",
+    "detach": "node scripts/detach-instance.mjs",
     "deploy": "wrangler deploy",
     "dev": "wrangler dev",
     "generate:blocklist": "node scripts/generate-blocklist.mjs build/blocklist.generated.json",

scripts/detach-instance.mjs

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+import fs from "node:fs";
+import path from "node:path";
+
+const ROOT = process.cwd();
+const DETACH_PATHS = [
+  ".git",
+  ".github",
+  "CHANGELOG.txt",
+  "package-lock.json",
+  "release-please-config.json"
+];
+
+function hasExpectedPackage() {
+  const packagePath = path.join(ROOT, "package.json");
+  if (!fs.existsSync(packagePath)) return false;
+
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packagePath, "utf8"));
+    return packageJson.name === "vanityURLs";
+  } catch {
+    return false;
+  }
+}
+
+if (!hasExpectedPackage()) {
+  console.error("[detach] Refusing to run: this directory does not look like a vanityURLs code checkout.");
+  process.exit(1);
+}
+
+for (const relativePath of DETACH_PATHS) {
+  const target = path.join(ROOT, relativePath);
+  if (!fs.existsSync(target)) {
+    console.log(`[detach] Skipped ${relativePath}; not present`);
+    continue;
+  }
+
+  fs.rmSync(target, {
+    recursive: true,
+    force: true
+  });
+  console.log(`[detach] Removed ${relativePath}`);
+}
+
+console.log("[detach] Ready for git init in your own repository.");