@helyx/cli 1.6.0 → 1.6.1

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.6.1
+
+### Patch Changes
+
+- Remove unused internal development, status reporting, OAuth, private control,
+  advanced Cloud Connect and Auto Moderation tuning examples from the self-host
+  environment template and portable documentation. The environment builder also
+  omits these examples from older templates while preserving existing active
+  custom settings. Keep Discord intent settings, basic Cloud Connect and data
+  encryption configuration; runtime defaults and scanning behavior are unchanged.
+
 ## 1.6.0
 
 ### Minor Changes

package/dist/self-host/project-generator.d.ts

@@ -22,6 +22,8 @@ type HostedOnlyBotEnvironment = "HELYX_PRIVACY_ENABLED" | "HELYX_PRIVACY_EXECUTO
 type EnvironmentExample = Record<Exclude<keyof BotEnvironmentInput, HostedOnlyBotEnvironment>, {
     value: string;
     optional: boolean;
+} | {
+    omit: true;
 }>;
 export declare const selfHostEnvironmentContract: EnvironmentExample;
 export {};

package/dist/self-host/project-generator.js

@@ -180,6 +180,12 @@ function validateEnvironmentTemplate(template, databaseEngine) {
         .split("\n")
         .map((line) => line.trim()));
     for (const [key, definition] of Object.entries(selfHostEnvironmentContract)) {
+        if ("omit" in definition) {
+            const setting = new RegExp(`^(?:#\\s*)?${key}\\s*=`, "u");
+            if ([...lines].some((line) => setting.test(line)))
+                throw new Error(`Self-host environment template contains an omitted setting: ${key}`);
+            continue;
+        }
         const value = key === "DATABASE_ENGINE"
             ? databaseEngine
             : key === "DATABASE_URL" && databaseEngine === "mysql"
@@ -333,25 +339,15 @@ export const selfHostEnvironmentContract = {
     DISCORD_TOKEN: { value: "replace-me", optional: false },
     DISCORD_CLIENT_ID: { value: "12345678901234567", optional: false },
     HELYX_MESSAGE_CONTENT_ENABLED: { value: "false", optional: false },
-    HELYX_AUTOMOD_EMBEDDED_WORKERS: { value: "1", optional: false },
-    HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS: { value: "5000", optional: true },
-    HELYX_AUTOMOD_EMBEDDED_QUEUE_BYTES: { value: "67108864", optional: true },
-    HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS_PER_GUILD: {
-        value: "100",
-        optional: true,
-    },
-    HELYX_AUTOMOD_EMBEDDED_REFRESH_SECONDS: {
-        value: "300",
-        optional: true,
-    },
-    DISCORD_INTERNAL_GUILD_ID: {
-        value: "12345678901234567",
-        optional: true,
-    },
-    APPROVED_ROLES: {
-        value: "12345678901234567,12345678901234568",
-        optional: true,
-    },
+    // Advanced self-host options use runtime defaults; internal/hosted settings
+    // are deliberately absent from the customer example.
+    HELYX_AUTOMOD_EMBEDDED_WORKERS: { omit: true },
+    HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS: { omit: true },
+    HELYX_AUTOMOD_EMBEDDED_QUEUE_BYTES: { omit: true },
+    HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS_PER_GUILD: { omit: true },
+    HELYX_AUTOMOD_EMBEDDED_REFRESH_SECONDS: { omit: true },
+    DISCORD_INTERNAL_GUILD_ID: { omit: true },
+    APPROVED_ROLES: { omit: true },
     HELYX_MODULE_PACKAGES: {
         value: "",
         optional: true,
@@ -364,16 +360,10 @@ export const selfHostEnvironmentContract = {
         value: "https://app.helyx.gg",
         optional: true,
     },
-    HELYX_BOT_CONTROL_SECRET: {
-        value: "replace-with-a-base64-encoded-32-byte-key",
-        optional: true,
-    },
-    HELYX_BOT_CONTROL_PORT: { value: "3001", optional: true },
-    HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS: {
-        value: "900",
-        optional: true,
-    },
-    HELYX_HOSTED_MODERATION_ENABLED: { value: "false", optional: false },
+    HELYX_BOT_CONTROL_SECRET: { omit: true },
+    HELYX_BOT_CONTROL_PORT: { omit: true },
+    HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS: { omit: true },
+    HELYX_HOSTED_MODERATION_ENABLED: { omit: true },
     HELYX_GUILD_COMMAND_WRITES_ENABLED: { value: "false", optional: false },
     HELYX_GUILD_COMMAND_WRITE_SCOPE: { value: "allowlist", optional: false },
     HELYX_GUILD_COMMAND_RELEASE_ID: { value: "", optional: true },
@@ -381,31 +371,16 @@ export const selfHostEnvironmentContract = {
     HELYX_GUILD_COMMAND_WRITE_GUILD_IDS: { value: "", optional: true },
     HELYX_GUILD_MEMBERS_ENABLED: { value: "false", optional: false },
     HELYX_CLOUD_CONNECT_ENABLED: { value: "true", optional: false },
-    HELYX_CLOUD_ENROLMENT_TOKEN: {
-        value: "replace-with-a-short-lived-enrolment-code",
-        optional: true,
-    },
-    HELYX_CLOUD_ENROLMENT_FILE: {
-        value: "./helyx.cloud-enrolment.json",
-        optional: true,
-    },
+    HELYX_CLOUD_ENROLMENT_TOKEN: { omit: true },
+    HELYX_CLOUD_ENROLMENT_FILE: { omit: true },
     HELYX_DATA_ENCRYPTION_KEY: {
         value: "replace-with-a-base64-encoded-32-byte-key",
         optional: true,
     },
-    HELYX_CLOUD_API_URL: {
-        value: "https://api.helyx.gg",
-        optional: true,
-    },
-    HELYX_OAUTH_ENABLED: { value: "false", optional: false },
-    HELYX_OAUTH_INTERNAL_SECRET: {
-        value: "replace-with-a-base64-encoded-32-byte-key",
-        optional: true,
-    },
-    HELYX_CLOUD_ENDPOINT: {
-        value: "wss://connect.helyx.gg/v1/connect",
-        optional: true,
-    },
+    HELYX_CLOUD_API_URL: { omit: true },
+    HELYX_OAUTH_ENABLED: { omit: true },
+    HELYX_OAUTH_INTERNAL_SECRET: { omit: true },
+    HELYX_CLOUD_ENDPOINT: { omit: true },
     HELYX_OWNER_USER_IDS: {
         value: "12345678901234567",
         optional: true,
@@ -438,35 +413,14 @@ export const selfHostEnvironmentContract = {
         value: "4",
         optional: true,
     },
-    HELYX_CLOUD_AUDIT_RETENTION_DAYS: {
-        value: "90",
-        optional: true,
-    },
-    HELYX_CLOUD_CREDENTIAL_AUDIT_RETENTION_DAYS: {
-        value: "365",
-        optional: true,
-    },
-    HELYX_STATUS_ENABLED: { value: "false", optional: false },
-    HELYX_STATUS_URL: {
-        value: "https://status.helyx.gg",
-        optional: true,
-    },
-    HELYX_STATUS_HEARTBEAT_SECRET: {
-        value: "replace-with-a-base64-encoded-32-byte-key",
-        optional: true,
-    },
-    HELYX_STATUS_HEARTBEAT_INTERVAL_SECONDS: {
-        value: "60",
-        optional: true,
-    },
-    CF_ACCESS_CLIENT_ID: {
-        value: "replace-with-access-client-id",
-        optional: true,
-    },
-    CF_ACCESS_CLIENT_SECRET: {
-        value: "replace-with-access-client-secret",
-        optional: true,
-    },
+    HELYX_CLOUD_AUDIT_RETENTION_DAYS: { omit: true },
+    HELYX_CLOUD_CREDENTIAL_AUDIT_RETENTION_DAYS: { omit: true },
+    HELYX_STATUS_ENABLED: { omit: true },
+    HELYX_STATUS_URL: { omit: true },
+    HELYX_STATUS_HEARTBEAT_SECRET: { omit: true },
+    HELYX_STATUS_HEARTBEAT_INTERVAL_SECONDS: { omit: true },
+    CF_ACCESS_CLIENT_ID: { omit: true },
+    CF_ACCESS_CLIENT_SECRET: { omit: true },
     LOG_LEVEL: { value: "info", optional: false },
     NODE_ENV: { value: "production", optional: false },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helyx/cli",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Command-line tools for running and generating self-hosted Helyx deployments.",
   "keywords": [
     "helyx",

package/self-host-catalogue.json

@@ -1,14 +1,14 @@
 {
   "schemaVersion": 2,
-  "catalogueVersion": 86,
+  "catalogueVersion": 87,
   "core": {
     "package": "@helyx/bot",
-    "version": "1.5.3",
+    "version": "1.5.4",
     "availability": "published"
   },
   "generator": {
     "package": "@helyx/cli",
-    "version": "1.6.0",
+    "version": "1.6.1",
     "command": "helyx",
     "availability": "published"
   },

package/templates/self-host/.env.example

@@ -9,16 +9,6 @@ DISCORD_CLIENT_ID=12345678901234567
 # Explicit privileged gateway opt-in. Keep false unless a reviewed loaded module
 # requires message content and it is enabled in the Discord developer portal.
 HELYX_MESSAGE_CONTENT_ENABLED=false
-# Enhanced Auto Moderation stays inside this bot process. One worker is the
-# recommended default (range 1-4); increase only after measuring CPU and memory.
-# Hosted scanning uses the separate Helyx Ecko service, not these settings.
-HELYX_AUTOMOD_EMBEDDED_WORKERS=1
-# Optional conservative queue overrides (hard ceilings: 5000 items, 64 MiB,
-# 100 items per server). Defaults are used when these remain commented.
-# HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS=5000
-# HELYX_AUTOMOD_EMBEDDED_QUEUE_BYTES=67108864
-# HELYX_AUTOMOD_EMBEDDED_QUEUE_ITEMS_PER_GUILD=100
-# HELYX_AUTOMOD_EMBEDDED_REFRESH_SECONDS=300
 # Enable for loaded member workflows such as Welcome, Access Control or Levels,
 # with Server Members Intent also enabled in the Discord developer portal.
 HELYX_GUILD_MEMBERS_ENABLED=false
@@ -51,10 +41,6 @@ HELYX_CLOUD_CONNECT_ENABLED=true
 # trace, debug, info, warn, error, fatal or silent
 LOG_LEVEL=info
 
-# Guild-scoped development commands only
-# DISCORD_INTERNAL_GUILD_ID=12345678901234567
-# APPROVED_ROLES=12345678901234567,12345678901234568
-
 # SHARDING: OFF BY DEFAULT
 
 # `off` is the compatible self-host default. Keep shard-only values commented
@@ -80,12 +66,6 @@ HELYX_SHARD_MODE=off
 # Additional reviewed module packages
 # HELYX_MODULE_PACKAGES=
 
-# Private dashboard control endpoint — configure both together
-# HELYX_BOT_CONTROL_SECRET=replace-with-a-base64-encoded-32-byte-key
-# HELYX_BOT_CONTROL_PORT=3001
-# HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS=900
-HELYX_HOSTED_MODERATION_ENABLED=false
-
 # Guild command writes remain off until explicitly enabled for known guild IDs.
 # For enabled-module server commands, set writes=true, retain allowlist scope,
 # add comma-separated Discord server IDs below, and use global mode platform-only.
@@ -96,14 +76,6 @@ HELYX_GUILD_COMMAND_WRITE_SCOPE=allowlist
 HELYX_GLOBAL_COMMAND_MODE=legacy
 # HELYX_GUILD_COMMAND_WRITE_GUILD_IDS=
 
-# Alternative Cloud Connect enrolment — the Discord command is preferred
-# HELYX_CLOUD_ENROLMENT_TOKEN=replace-with-a-short-lived-enrolment-code
-# HELYX_CLOUD_ENROLMENT_FILE=./helyx.cloud-enrolment.json
-
-# Hosted OAuth bridge. Keep disabled unless the API and bot share this secret.
-HELYX_OAUTH_ENABLED=false
-# HELYX_OAUTH_INTERNAL_SECRET=replace-with-a-base64-encoded-32-byte-key
-
 # DANGER ZONE — HELYX-MANAGED VALUES, DO NOT EDIT
 
 # Generated module selection
@@ -113,22 +85,5 @@ HELYX_MODULE_CATALOGUE_PATH=./helyx.modules.json
 # and Invite Tracking; retain it unchanged across restarts and deployments.
 # HELYX_DATA_ENCRYPTION_KEY=replace-with-a-base64-encoded-32-byte-key
 
-# Official Cloud Connect endpoints
-# HELYX_CLOUD_API_URL=https://api.helyx.gg
-# HELYX_CLOUD_ENDPOINT=wss://connect.helyx.gg/v1/connect
-
-# Security audit retention
-# HELYX_CLOUD_AUDIT_RETENTION_DAYS=90
-# HELYX_CLOUD_CREDENTIAL_AUDIT_RETENTION_DAYS=365
-
-# Optional public status reporting. Keep disabled unless this installation has
-# its own approved Helyx status credentials.
-HELYX_STATUS_ENABLED=false
-# HELYX_STATUS_URL=https://status.helyx.gg
-# HELYX_STATUS_HEARTBEAT_SECRET=replace-with-a-base64-encoded-32-byte-key
-# HELYX_STATUS_HEARTBEAT_INTERVAL_SECONDS=60
-# CF_ACCESS_CLIENT_ID=replace-with-access-client-id
-# CF_ACCESS_CLIENT_SECRET=replace-with-access-client-secret
-
 # Runtime mode
 NODE_ENV=production

package/templates/self-host/env-builder.mjs

@@ -208,23 +208,19 @@ const environmentGroups = [
   ],
   ["DATA ENCRYPTION - KEEP THIS KEY", /^HELYX_DATA_ENCRYPTION_KEY$/u],
   ["LOGGING", /^LOG_LEVEL$/u],
-  ["AUTO MODERATION", /^HELYX_AUTOMOD_/u],
   ["SHARDING - ADVANCED", /^HELYX_SHARD_/u],
   ["MODULE SELECTION", /^HELYX_MODULE_/u],
-  [
-    "PRIVATE CONTROL - ADVANCED",
-    /^HELYX_BOT_CONTROL_|^HELYX_HOSTED_MODERATION_ENABLED$|^HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS$/u,
-  ],
-  ["CLOUD CONNECT - ADVANCED", /^HELYX_CLOUD_/u],
-  ["OAUTH - ADVANCED", /^HELYX_OAUTH_/u],
-  ["STATUS REPORTING - OPTIONAL", /^HELYX_STATUS_|^CF_ACCESS_/u],
-  [
-    "INTERNAL DEVELOPMENT - OPTIONAL",
-    /^(?:DISCORD_INTERNAL_GUILD_ID|APPROVED_ROLES)$/u,
-  ],
   ["CUSTOM SETTINGS", /./u],
 ];
+const omittedExampleSetting =
+  /^(?:HELYX_AUTOMOD_|HELYX_BOT_CONTROL_|HELYX_HOSTED_MODERATION_ENABLED$|HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS$|HELYX_CLOUD_(?!CONNECT_ENABLED$)|HELYX_OAUTH_|HELYX_STATUS_|CF_ACCESS_|DISCORD_INTERNAL_GUILD_ID$|APPROVED_ROLES$)/u;
 const oldHeadings = new Set([
+  "AUTO MODERATION",
+  "PRIVATE CONTROL - ADVANCED",
+  "CLOUD CONNECT - ADVANCED",
+  "OAUTH - ADVANCED",
+  "STATUS REPORTING - OPTIONAL",
+  "INTERNAL DEVELOPMENT - OPTIONAL",
   "REQUIRED — EDIT THESE VALUES",
   "Discord",
   "Database",
@@ -237,7 +233,7 @@ const oldHeadings = new Set([
   "Keep this file private. Lines starting with # are comments.",
 ]);
 
-export function formatEnvironment(content) {
+export function formatEnvironment(content, { template = false } = {}) {
   const newline = content.includes("\r\n") ? "\r\n" : "\n";
   const groups = environmentGroups.map(() => []);
   let pending = [];
@@ -265,6 +261,10 @@ export function formatEnvironment(content) {
       continue;
     const key =
       record.key ?? text.match(/^\s*#\s*([A-Za-z_][A-Za-z0-9_]*)\s*=/u)?.[1];
+    if (key && omittedExampleSetting.test(key) && (template || !record.key)) {
+      pending = [];
+      continue;
+    }
     if (!key) {
       if (!text.trim() && pending.length && previousGroup !== undefined) {
         append(previousGroup, pending);
@@ -295,6 +295,9 @@ export function formatEnvironment(content) {
     ].join("\n\n\n") + "\n";
   const formatted = output.replace(/\n/gu, newline);
   const before = parseEnv(content);
+  if (template)
+    for (const key of Object.keys(before))
+      if (omittedExampleSetting.test(key)) delete before[key];
   const after = parseEnv(formatted);
   if (
     Object.keys(before).length !== Object.keys(after).length ||
@@ -420,7 +423,10 @@ export async function runWizard({
       "Choose a downloaded Helyx starter folder containing package.json and .env.example.",
     );
   const original = await optionalRead(join(directory, ".env"));
-  const template = await readFile(join(directory, ".env.example"), "utf8");
+  const template = formatEnvironment(
+    await readFile(join(directory, ".env.example"), "utf8"),
+    { template: true },
+  );
   const existing = parseEnv(original ?? "");
   const defaults = parseEnv(template);
   const values = { ...defaults, ...existing };