htmlhost-cli 2.4.0 → 2.5.0

package/README.md

@@ -131,6 +131,17 @@ push changes and `htmlhost pull` to sync remote edits.
 
 Use `--force` to overwrite an existing non-empty directory.
 
+### `htmlhost agents [dir] [options]`
+Teach your AI coding tool (Claude Code, Codex, Cursor, Copilot…) how htmlhost works: static hosting rules, this CLI, and how to build forms that deliver to your inbox. Writes a managed block into `AGENTS.md` (your own content is kept) and adds an `@AGENTS.md` import to `CLAUDE.md`. `clone` adds it automatically, and `deploy` keeps it current. Agent files are never deployed.
+
+```bash
+htmlhost agents              # add or refresh
+htmlhost agents --print      # print the guide instead
+htmlhost agents --no-claude  # don't touch CLAUDE.md
+```
+
+The same guide is at https://htmlhost.co/agents.md.
+
 ### `htmlhost list`
 List all your sites with titles, sizes, TTL, and expiry. Multi-page sites are marked with 📄.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "htmlhost-cli",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Deploy HTML files from the terminal — htmlhost.co CLI",
   "type": "module",
   "bin": {

package/src/cli.mjs

@@ -5,7 +5,7 @@ import { bold, dim, cyan, err } from "./ui.mjs";
 import { ApiError } from "./api.mjs";
 import { startUpdateCheck, applyUpdate } from "./update.mjs";
 
-const VERSION = "2.4.0";
+const VERSION = "2.5.0";
 
 const HELP = `
   ${bold("htmlhost")} ${dim(`v${VERSION}`)} — deploy HTML from the terminal
@@ -15,6 +15,7 @@ const HELP = `
     ${cyan("htmlhost upload")} <file|dir...> [opts] Upload media file or directory
     ${cyan("htmlhost pull")} [slug] [opts]        Pull remote changes to local
     ${cyan("htmlhost clone")} <slug> [dir]        Clone a site to a local directory
+    ${cyan("htmlhost agents")} [dir]             Teach your AI coding tool htmlhost (AGENTS.md)
     ${cyan("htmlhost list")}                     List your sites
     ${cyan("htmlhost delete")} <slug>            Delete a site
     ${cyan("htmlhost login")}                    Authenticate with an API token
@@ -39,6 +40,10 @@ const HELP = `
     --force, -f       Pull without confirmation prompt
     --dry-run         Show what would change without writing
 
+  ${bold("Agents options:")}
+    --print           Print the guide instead of writing files
+    --no-claude       Don't add the @AGENTS.md import to CLAUDE.md
+
   ${bold("Delete options:")}
     --force, -f       Skip confirmation prompt
 
@@ -128,6 +133,11 @@ export async function run(argv) {
         await clone(args);
         break;
       }
+      case "agents": {
+        const { agents } = await import("./commands/agents.mjs");
+        await agents(args);
+        break;
+      }
       case "list":
       case "ls": {
         const { list } = await import("./commands/list.mjs");

package/src/commands/agents.mjs

@@ -0,0 +1,95 @@
+/**
+ * htmlhost agents [dir] [--print] [--no-claude]
+ *
+ * Write htmlhost's instructions for AI coding agents (hosting rules, CLI, forms)
+ * into the project's AGENTS.md, so tools like Codex, Cursor, Copilot and Claude
+ * Code build features that work on htmlhost. The guide is fetched from
+ * https://htmlhost.co/agents.md so it's always current.
+ *
+ * Only a marked block is managed: anything else in AGENTS.md is left alone,
+ * and running the command again replaces just that block. Claude Code reads
+ * CLAUDE.md rather than AGENTS.md, so an `@AGENTS.md` import is added there too.
+ */
+import { readFileSync, writeFileSync, existsSync } from "node:fs";
+import { join, resolve } from "node:path";
+import { getApi } from "../config.mjs";
+import { ok, err, dim, cyan } from "../ui.mjs";
+
+const START = "<!-- htmlhost:agents:start — managed by `htmlhost agents`; edits inside this block are replaced -->";
+const END = "<!-- htmlhost:agents:end -->";
+const BLOCK_RE = /<!-- htmlhost:agents:start[^>]*-->[\s\S]*?<!-- htmlhost:agents:end -->/;
+
+/** Fetch the current guide. Throws on network or HTTP failure. */
+export async function fetchAgentGuide(timeoutMs = 10000) {
+  const res = await fetch(`${getApi()}/agents.md`, { signal: AbortSignal.timeout(timeoutMs) });
+  if (!res.ok) throw new Error(`HTTP ${res.status}`);
+  return (await res.text()).trim();
+}
+
+/** Whether a project already carries the managed block. */
+export function hasAgentGuide(dir) {
+  const path = join(dir, "AGENTS.md");
+  return existsSync(path) && BLOCK_RE.test(readFileSync(path, "utf8"));
+}
+
+/**
+ * Write (or refresh) the guide in `dir`. Returns what changed, for reporting.
+ * `claude: false` leaves CLAUDE.md untouched.
+ */
+export function writeAgentGuide(dir, guide, { claude = true } = {}) {
+  const changed = [];
+  const block = `${START}\n${guide}\n${END}`;
+
+  const agentsPath = join(dir, "AGENTS.md");
+  const before = existsSync(agentsPath) ? readFileSync(agentsPath, "utf8") : null;
+  const after = before === null
+    ? `${block}\n`
+    : BLOCK_RE.test(before)
+      ? before.replace(BLOCK_RE, () => block)
+      : `${before.replace(/\s*$/, "")}\n\n${block}\n`;
+  if (after !== before) {
+    writeFileSync(agentsPath, after, "utf8");
+    changed.push(before === null ? "created AGENTS.md" : "updated AGENTS.md");
+  }
+
+  if (claude) {
+    const claudePath = join(dir, "CLAUDE.md");
+    const current = existsSync(claudePath) ? readFileSync(claudePath, "utf8") : null;
+    if (current === null) {
+      writeFileSync(claudePath, "@AGENTS.md\n", "utf8");
+      changed.push("created CLAUDE.md (imports AGENTS.md)");
+    } else if (!/@AGENTS\.md\b/.test(current)) {
+      writeFileSync(claudePath, `${current.replace(/\s*$/, "")}\n\n@AGENTS.md\n`, "utf8");
+      changed.push("added @AGENTS.md to CLAUDE.md");
+    }
+  }
+  return changed;
+}
+
+export async function agents(args) {
+  const positionals = args.filter((a) => !a.startsWith("-"));
+  const dir = resolve(positionals[0] || ".");
+  const print = args.includes("--print");
+
+  let guide;
+  try {
+    guide = await fetchAgentGuide();
+  } catch (e) {
+    err(`Couldn't download the agent guide from ${getApi()}/agents.md (${e.message}).`);
+    process.exit(1);
+  }
+
+  if (print) {
+    console.log(guide);
+    return;
+  }
+
+  const changed = writeAgentGuide(dir, guide, { claude: !args.includes("--no-claude") });
+  if (changed.length === 0) {
+    ok("AI agent instructions are already up to date.");
+  } else {
+    ok(`AI agent instructions ${changed.join(", ")}.`);
+  }
+  console.log(`   ${dim("Your AI coding tool now knows how htmlhost hosting and forms work.")}`);
+  console.log(`   ${dim("Refresh any time with")} ${cyan("htmlhost agents")}${dim(". These files are never deployed.")}`);
+}

package/src/commands/clone.mjs

@@ -9,6 +9,7 @@
 import { readFileSync, writeFileSync, existsSync, mkdirSync, readdirSync } from "node:fs";
 import { join, dirname, resolve } from "node:path";
 import { get, downloadBuffer } from "../api.mjs";
+import { fetchAgentGuide, writeAgentGuide } from "./agents.mjs";
 import {
   ok,
   err,
@@ -164,6 +165,12 @@ export async function clone(args) {
   const linkPath = join(destDir, LINK_FILE);
   writeFileSync(linkPath, JSON.stringify(linkData, null, 2) + "\n", "utf8");
 
+  // Teach the user's AI coding tool how htmlhost works. Best-effort: a
+  // failed download mustn't fail the clone.
+  const agentsWritten = await fetchAgentGuide(5000)
+    .then((guide) => writeAgentGuide(destDir, guide).length > 0)
+    .catch(() => false);
+
   // --- Done ---
   console.log("");
   console.log(`  ${green("━".repeat(40))}`);
@@ -174,5 +181,6 @@ export async function clone(args) {
   console.log("");
   console.log(`   ${dim("Deploy changes:")}  ${cyan("htmlhost deploy")}`);
   console.log(`   ${dim("Pull updates:")}    ${cyan("htmlhost pull")}`);
+  if (agentsWritten) console.log(`   ${dim("AI agent guide:")}  ${cyan("AGENTS.md")} ${dim("(not deployed)")}`);
   console.log("");
 }

package/src/commands/deploy.mjs

@@ -5,6 +5,7 @@ import { createHash } from "node:crypto";
 import { post } from "../api.mjs";
 import { ok, err, info, warn, cyan, dim, bold, yellow, green, formatBytes, mimeFromExt } from "../ui.mjs";
 import { checkRemoteChanges } from "./pull.mjs";
+import { fetchAgentGuide, hasAgentGuide, writeAgentGuide } from "./agents.mjs";
 
 const LINK_FILE = ".htmlhost";
 
@@ -68,6 +69,15 @@ const DEFAULT_IGNORE = [
   "package-lock.json",
   "yarn.lock",
   "pnpm-lock.yaml",
+  // Instructions for AI coding tools — private to the project, never published.
+  "AGENTS.md",
+  "CLAUDE.md",
+  "GEMINI.md",
+  ".claude",
+  ".cursor",
+  ".cursorrules",
+  ".windsurfrules",
+  ".github",
 ];
 
 /**
@@ -342,6 +352,10 @@ async function deployDirectory(dirPath, { ttl, title, slug: explicitSlug, forceN
     }
   }
 
+  // Keep an existing AI agent guide current (downloaded alongside the deploy).
+  const hadAgentGuide = hasAgentGuide(dirPath);
+  const agentGuide = hadAgentGuide && !json ? fetchAgentGuide(5000).catch(() => null) : Promise.resolve(null);
+
   // Read existing link data
   const link = readLink(dirPath);
   let existingSlug = explicitSlug || (!forceNew && link?.multipage?.slug) || null;
@@ -557,6 +571,11 @@ async function deployDirectory(dirPath, { ttl, title, slug: explicitSlug, forceN
     }
     console.log("");
     console.log(`   ${dim("Linked → .htmlhost")}`);
+    const guide = await agentGuide;
+    if (guide) writeAgentGuide(dirPath, guide, { claude: false });
+    else if (!hadAgentGuide) {
+      console.log(`   ${dim("Building with AI? Run")} ${cyan("htmlhost agents")} ${dim("so your coding tool knows how htmlhost forms and hosting work.")}`);
+    }
     console.log("");
   } catch (e) {
     err(`Deploy failed: ${e.message}`);