@helyx/cli 1.5.0 → 1.6.1

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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
+
+- b698422: Add the optional `helyx envbuilder` command and generated starter npm script.
+  Preserve platform builder selections in build manifests and include standalone
+  batch, PowerShell or POSIX scripts only when selected. The guided builder runs
+  locally, checks input format, masks saved credentials and preserves encryption
+  keys and custom settings until the operator confirms saving.
+
 ## 1.5.0
 
 ### Minor Changes

package/README.md

@@ -20,6 +20,12 @@ operation supports a local or hosted PostgreSQL or MySQL-compatible database.
 and performs the bot bootstrap, including core and installed-module migrations.
 `migrate` applies only core migrations and exits.
 
+Generated starters also include the optional `npm run envbuilder` command.
+After `npm ci`, it runs `helyx envbuilder`, a local guided `.env` builder with
+no connection tests. Additional standalone Windows batch, PowerShell and
+macOS/Linux scripts are included only when selected for the download. Setup
+and startup remain independent.
+
 `doctor` checks the complete bot environment, connectivity, immutable core
 migration history, package metadata and selected module/engine compatibility
 without logging in to Discord or changing the database. It inspects module

package/dist/cli.js

@@ -24,6 +24,10 @@ try {
     else if (command === "setup") {
         await setup();
     }
+    else if (command === "envbuilder") {
+        const builder = (await import(new URL("../templates/self-host/env-builder.mjs", import.meta.url).href));
+        await builder.runEnvironmentBuilder(process.argv[3]);
+    }
     else if (command === "self-host") {
         await runSelfHostCommand(process.argv.slice(3));
     }
@@ -141,6 +145,7 @@ function printHelp() {
 
 Commands:
   setup    Create .env safely and explain the available hosting paths
+  envbuilder  Optionally create or update .env with a local guided builder
   start    Start the Helyx Discord bot
   migrate  Apply core migrations for the selected database engine and exit
   doctor   Validate environment, database schema and module packages

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./self-host/catalogue.js";
 export * from "./self-host/command.js";
 export * from "./self-host/database-adapters.js";
+export * from "./self-host/environment-builders.js";
 export * from "./self-host/manifest.js";
 export * from "./self-host/project-generator.js";
 export * from "./self-host/update.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./self-host/catalogue.js";
 export * from "./self-host/command.js";
 export * from "./self-host/database-adapters.js";
+export * from "./self-host/environment-builders.js";
 export * from "./self-host/manifest.js";
 export * from "./self-host/project-generator.js";
 export * from "./self-host/update.js";

package/dist/self-host/environment-builders.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const selfHostEnvironmentBuilderSchema: z.ZodEnum<{
+    none: "none";
+    windows: "windows";
+    powershell: "powershell";
+    unix: "unix";
+    all: "all";
+}>;
+export type SelfHostEnvironmentBuilder = z.infer<typeof selfHostEnvironmentBuilderSchema>;
+export type SelfHostEnvironmentBuilderFile = "env-builder.mjs" | "env-builder.bat" | "env-builder.ps1" | "env-builder.sh";
+export declare function selfHostEnvironmentBuilderFiles(selection?: SelfHostEnvironmentBuilder): SelfHostEnvironmentBuilderFile[];
+//# sourceMappingURL=environment-builders.d.ts.map

package/dist/self-host/environment-builders.js

@@ -0,0 +1,25 @@
+import { z } from "zod";
+export const selfHostEnvironmentBuilderSchema = z.enum([
+    "none",
+    "windows",
+    "powershell",
+    "unix",
+    "all",
+]);
+export function selfHostEnvironmentBuilderFiles(selection = "none") {
+    selfHostEnvironmentBuilderSchema.parse(selection);
+    if (selection === "none")
+        return [];
+    const launchers = {
+        windows: "env-builder.bat",
+        powershell: "env-builder.ps1",
+        unix: "env-builder.sh",
+    };
+    return [
+        "env-builder.mjs",
+        ...(selection === "all"
+            ? Object.values(launchers)
+            : [launchers[selection]]),
+    ];
+}
+//# sourceMappingURL=environment-builders.js.map

package/dist/self-host/manifest.d.ts

@@ -1,7 +1,15 @@
 import { z } from "zod";
+import { type SelfHostEnvironmentBuilder } from "./environment-builders.js";
 import { type SelfHostCatalogue, type SelfHostDatabaseEngine } from "./catalogue.js";
 export declare const selfHostBuildManifestSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     schemaVersion: z.ZodLiteral<1>;
+    environmentBuilder: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        windows: "windows";
+        powershell: "powershell";
+        unix: "unix";
+        all: "all";
+    }>>;
     catalogueVersion: z.ZodNumber;
     core: z.ZodObject<{
         package: z.ZodString;
@@ -18,6 +26,13 @@ export declare const selfHostBuildManifestSchema: z.ZodDiscriminatedUnion<[z.Zod
     }, z.core.$strict>>;
 }, z.core.$strict>, z.ZodObject<{
     schemaVersion: z.ZodLiteral<2>;
+    environmentBuilder: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        windows: "windows";
+        powershell: "powershell";
+        unix: "unix";
+        all: "all";
+    }>>;
     databaseEngine: z.ZodOptional<z.ZodEnum<{
         postgresql: "postgresql";
         mysql: "mysql";
@@ -52,6 +67,6 @@ export declare const selfHostBuildManifestSchema: z.ZodDiscriminatedUnion<[z.Zod
     }, z.core.$strict>>;
 }, z.core.$strict>], "schemaVersion">;
 export type SelfHostBuildManifest = z.infer<typeof selfHostBuildManifestSchema>;
-export declare function createSelfHostBuildManifest(catalogue: SelfHostCatalogue, selectedModuleIds: readonly string[], databaseEngine?: SelfHostDatabaseEngine): SelfHostBuildManifest;
+export declare function createSelfHostBuildManifest(catalogue: SelfHostCatalogue, selectedModuleIds: readonly string[], databaseEngine?: SelfHostDatabaseEngine, environmentBuilder?: SelfHostEnvironmentBuilder): SelfHostBuildManifest;
 export declare function parseSelfHostBuildManifest(input: unknown, catalogue: SelfHostCatalogue): SelfHostBuildManifest;
 //# sourceMappingURL=manifest.d.ts.map

package/dist/self-host/manifest.js

@@ -1,6 +1,7 @@
 import semver from "semver";
 import { isDeepStrictEqual } from "node:util";
 import { z } from "zod";
+import { selfHostEnvironmentBuilderSchema, } from "./environment-builders.js";
 import { isSelfHostModuleCustomerSelectable, selfHostDatabaseEngineSchema, } from "./catalogue.js";
 const exactVersion = z
     .string()
@@ -23,6 +24,7 @@ const buildModuleSchema = z
 const selfHostBuildManifestV1Schema = z
     .object({
     schemaVersion: z.literal(1),
+    environmentBuilder: selfHostEnvironmentBuilderSchema.optional(),
     catalogueVersion: z.number().int().positive(),
     core: buildComponentSchema,
     generator: buildComponentSchema,
@@ -48,6 +50,7 @@ const buildModuleV2Schema = buildModuleSchema
 const selfHostBuildManifestV2Schema = z
     .object({
     schemaVersion: z.literal(2),
+    environmentBuilder: selfHostEnvironmentBuilderSchema.optional(),
     databaseEngine: selfHostDatabaseEngineSchema.optional(),
     catalogueVersion: z.number().int().positive(),
     core: buildComponentSchema,
@@ -82,15 +85,16 @@ export const selfHostBuildManifestSchema = z
         packages.add(module.package);
     }
 });
-export function createSelfHostBuildManifest(catalogue, selectedModuleIds, databaseEngine = "postgresql") {
+export function createSelfHostBuildManifest(catalogue, selectedModuleIds, databaseEngine = "postgresql", environmentBuilder = "none") {
     selfHostDatabaseEngineSchema.parse(databaseEngine);
+    selfHostEnvironmentBuilderSchema.parse(environmentBuilder);
     assertPublishedComponent(catalogue.core, "Helyx runtime");
     assertPublishedComponent(catalogue.generator, "Helyx generator");
     if (new Set(selectedModuleIds).size !== selectedModuleIds.length) {
         throw new Error("Self-host selection contains duplicate module IDs");
     }
     if (catalogue.schemaVersion === 2) {
-        return createSelfHostBuildManifestV2(catalogue, selectedModuleIds, databaseEngine);
+        return createSelfHostBuildManifestV2(catalogue, selectedModuleIds, databaseEngine, environmentBuilder);
     }
     if (databaseEngine !== "postgresql") {
         throw new Error("Legacy self-host catalogue supports PostgreSQL only");
@@ -115,6 +119,7 @@ export function createSelfHostBuildManifest(catalogue, selectedModuleIds, databa
     });
     return {
         schemaVersion: 1,
+        ...(environmentBuilder !== "none" ? { environmentBuilder } : {}),
         catalogueVersion: catalogue.catalogueVersion,
         core: {
             package: catalogue.core.package,
@@ -127,7 +132,7 @@ export function createSelfHostBuildManifest(catalogue, selectedModuleIds, databa
         modules,
     };
 }
-function createSelfHostBuildManifestV2(catalogue, selectedModuleIds, databaseEngine) {
+function createSelfHostBuildManifestV2(catalogue, selectedModuleIds, databaseEngine, environmentBuilder = "none") {
     const byId = new Map(catalogue.modules.map((module) => [module.id, module]));
     const explicitlySelected = new Set(selectedModuleIds);
     const modules = [];
@@ -189,6 +194,7 @@ function createSelfHostBuildManifestV2(catalogue, selectedModuleIds, databaseEng
         include(id);
     return {
         schemaVersion: 2,
+        ...(environmentBuilder !== "none" ? { environmentBuilder } : {}),
         ...(databaseEngine === "mysql" ? { databaseEngine } : {}),
         catalogueVersion: catalogue.catalogueVersion,
         core: {
@@ -218,13 +224,20 @@ export function parseSelfHostBuildManifest(input, catalogue) {
         const selectedModuleIds = manifest.modules
             .filter(({ moduleKind }) => moduleKind === "customer_feature")
             .map(({ id }) => id);
-        const expected = createSelfHostBuildManifestV2(catalogue, selectedModuleIds, manifest.databaseEngine ?? "postgresql");
+        const expected = createSelfHostBuildManifestV2(catalogue, selectedModuleIds, manifest.databaseEngine ?? "postgresql", manifest.environmentBuilder ?? "none");
         if (!isDeepStrictEqual({
             ...manifest,
+            environmentBuilder: manifest.environmentBuilder === "none"
+                ? undefined
+                : manifest.environmentBuilder,
             databaseEngine: manifest.databaseEngine === "postgresql"
                 ? undefined
                 : manifest.databaseEngine,
-        }, { ...expected, databaseEngine: expected.databaseEngine })) {
+        }, {
+            ...expected,
+            databaseEngine: expected.databaseEngine,
+            environmentBuilder: expected.environmentBuilder,
+        })) {
             throw new Error("Build manifest modules do not match the trusted catalogue dependency graph");
         }
         return expected;

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

@@ -2,6 +2,7 @@ import { createHash } from "node:crypto";
 import { spawn } from "node:child_process";
 import { mkdir, readFile, readdir, rm, stat, writeFile, } from "node:fs/promises";
 import { dirname, parse, resolve } from "node:path";
+import { selfHostEnvironmentBuilderFiles, } from "./environment-builders.js";
 import { isSelfHostModuleCustomerSelectable, } from "./catalogue.js";
 import { parseSelfHostBuildManifest, } from "./manifest.js";
 import { databaseAdaptersForCatalogue, } from "./database-adapters.js";
@@ -80,6 +81,7 @@ async function writeGeneratedFiles(targetDirectory, manifest, catalogue, databas
         engines: { node: ">=24 <27", npm: ">=11" },
         scripts: {
             setup: "helyx setup",
+            envbuilder: "helyx envbuilder",
             start: "helyx start",
             doctor: "helyx doctor",
             migrate: "helyx migrate",
@@ -95,7 +97,10 @@ async function writeGeneratedFiles(targetDirectory, manifest, catalogue, databas
     };
     await writeFile(resolve(targetDirectory, "package.json"), formatJson(packageJson), "utf8");
     await writeFile(resolve(targetDirectory, "helyx.modules.json"), formatJson(moduleCatalogue), "utf8");
-    for (const fileName of generatedFileNames) {
+    for (const fileName of [
+        ...generatedFileNames,
+        ...selfHostEnvironmentBuilderFiles(manifest.environmentBuilder),
+    ]) {
         const template = await readFile(fileName === "compose.yaml" && databaseEngine === "mysql"
             ? mysqlComposeTemplateUrl()
             : templateUrl(fileName), "utf8");
@@ -106,8 +111,13 @@ async function writeGeneratedFiles(targetDirectory, manifest, catalogue, databas
                 : template;
         if (fileName === ".env.example")
             validateEnvironmentTemplate(rendered, databaseEngine);
-        const content = normalizeCrLf(rendered);
-        await writeFile(resolve(targetDirectory, fileName), content, "utf8");
+        const content = fileName.endsWith(".sh")
+            ? rendered.replaceAll("\r\n", "\n")
+            : normalizeCrLf(rendered);
+        await writeFile(resolve(targetDirectory, fileName), content, {
+            encoding: "utf8",
+            mode: fileName.endsWith(".sh") ? 0o755 : 0o644,
+        });
     }
 }
 function renderEnvironmentExample(template, databaseEngine) {
@@ -170,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"
@@ -323,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,
@@ -354,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 },
@@ -371,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,
@@ -428,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.5.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": 85,
+  "catalogueVersion": 87,
   "core": {
     "package": "@helyx/bot",
-    "version": "1.5.3",
+    "version": "1.5.4",
     "availability": "published"
   },
   "generator": {
     "package": "@helyx/cli",
-    "version": "1.5.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/README.md

@@ -20,6 +20,31 @@ The matching offline operator and module-author documentation is listed in
 
 ## Choose a runtime path
 
+### Optional guided environment builder
+
+Run `npm run envbuilder` to create or update `.env` by answering questions.
+This optional command is available after `npm ci`; normal setup and startup do
+not run it. If you selected additional environment builders when downloading
+your starter, you can also use these included files before package installation:
+
+- Windows: double-click `env-builder.bat`, or run `.\env-builder.ps1` in PowerShell.
+- macOS and Linux: run `sh ./env-builder.sh` in a terminal.
+
+No additional builder files are included by default. Each platform selection
+includes its matching script and the shared `env-builder.mjs`; selecting all
+builders includes every platform script. The npm command is always included.
+
+The builder detects the starter's database selection, checks input format, and
+asks whether to enable server-specific slash commands for your server IDs.
+Database URLs and bot tokens are visible while you type or paste; saved values
+remain masked in prompts and the review summary. Database passwords are hidden
+while typing. Existing encryption keys and custom settings are retained.
+
+Nothing is saved until you type `SAVE`. The builder makes no connection tests,
+installs no packages and starts no services. It is optional: `setup`, `doctor`,
+installation and startup do not launch it. You may still edit `.env` manually.
+Continue with the installation and runtime checks for your chosen path below.
+
 ### Node.js and PowerShell or another shell
 
 Use this path on a local machine or VPS without Docker. It requires Node.js `>=24 <27`, npm `>=11`, and one local or hosted supported database. Helyx does not require Docker.

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

@@ -0,0 +1,14 @@
+@echo off
+setlocal DisableDelayedExpansion
+title Helyx Environment Builder
+where node >nul 2>nul
+if errorlevel 1 (
+  echo Node.js 24 or newer is required. Install Node.js and run this file again.
+  pause
+  exit /b 1
+)
+node "%~dp0env-builder.mjs" %*
+set "builder_exit=%errorlevel%"
+echo.
+pause
+exit /b %builder_exit%