@helyx/cli 0.5.2 → 0.5.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.5.4
+
+### Patch Changes
+
+- 38c70f7: Ship maintained public documentation with the bot package and point newly generated self-host projects to its version-matched offline copy.
+
+## 0.5.3
+
+### Patch Changes
+
+- Add per-server command registration, shared command families, command-management controls, and the supporting configuration and persistence contracts.
+- Include the fail-closed command write scope and optional release identifier in generated self-host environment contracts.
+- Include live Starboard, FAQ and Tags packages in the reviewed self-host catalogue.
+
 ## 0.5.2
 
 ### Patch Changes

package/README.md

@@ -16,6 +16,10 @@ helyx self-host update --confirm
 
 `self-host init` retrieves the current reviewed catalogue from the fixed Helyx API endpoint, validates a downloaded build manifest against it, creates a new starter-project directory, pins the runtime and selected official modules, generates a lockfile with lifecycle scripts disabled, and writes checksums. The request has strict timeout, response-size, JSON-schema and official-package checks; no arbitrary catalogue URL or stale bundled fallback is accepted. Add `--install` only when the dependencies should also be installed locally. Unknown, unpublished, duplicated, stale or modified package selections fail closed.
 
+Generated projects include `DOCUMENTATION.md`, which points to the
+version-matched public documentation bundled with the installed `@helyx/bot`
+package.
+
 `self-host update --check` reads the current project and the reviewed catalogue from `api.helyx.gg`, then reports the complete compatible release-set change without writing files. `--confirm` backs up the managed metadata under `.helyx/backups`, updates exact core, CLI and selected live-module versions together, refreshes and validates the lockfile with lifecycle scripts disabled, and restores the original metadata if generation fails. Run `npm ci` and `npm run doctor` after applying an update. The updater never changes `.env` or customer database data.
 
 The package is published under the Helyx Source Available Licence. Generated projects contain deployment configuration and exact public npm dependencies; they do not contain Helyx source code or credentials.

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

@@ -9,6 +9,7 @@ const generatedFileNames = [
     ".gitignore",
     ".npmrc",
     "Dockerfile",
+    "DOCUMENTATION.md",
     "compose.yaml",
     "README.md",
 ];
@@ -304,6 +305,11 @@ export const selfHostEnvironmentContract = {
         value: "900",
         optional: 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 },
+    HELYX_GLOBAL_COMMAND_MODE: { value: "legacy", optional: false },
+    HELYX_GUILD_COMMAND_WRITE_GUILD_IDS: { value: "", optional: true },
     HELYX_PRIVACY_ENABLED: { value: "false", optional: false },
     HELYX_GUILD_MEMBERS_ENABLED: { value: "false", optional: false },
     HELYX_PRIVACY_EXECUTOR_DATABASE_URL: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helyx/cli",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "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": 44,
+  "catalogueVersion": 47,
   "core": {
     "package": "@helyx/bot",
-    "version": "0.4.37",
+    "version": "0.4.39",
     "availability": "published"
   },
   "generator": {
     "package": "@helyx/cli",
-    "version": "0.5.2",
+    "version": "0.5.4",
     "command": "helyx",
     "availability": "published"
   },
@@ -16,7 +16,7 @@
     {
       "id": "helyx.feedback",
       "package": "@helyx/module-feedback",
-      "version": "1.1.15",
+      "version": "1.1.17",
       "name": "Feedback",
       "description": "Collects simple feedback from Discord server members.",
       "category": "Community",
@@ -46,7 +46,7 @@
     {
       "id": "helyx.suggestions",
       "package": "@helyx/module-suggestions",
-      "version": "1.1.15",
+      "version": "1.1.17",
       "name": "Suggestions",
       "description": "Collects community ideas with configurable reaction or button voting.",
       "category": "Community",
@@ -61,7 +61,7 @@
     {
       "id": "helyx.polls",
       "package": "@helyx/module-polls",
-      "version": "1.0.13",
+      "version": "1.0.14",
       "name": "Polls",
       "description": "Run clear single or multiple-choice polls.",
       "category": "Community",
@@ -76,12 +76,12 @@
     {
       "id": "helyx.starboard",
       "package": "@helyx/module-starboard",
-      "version": "1.0.1",
+      "version": "1.0.3",
       "name": "Starboard",
       "description": "Highlight messages your community values.",
       "category": "Community",
-      "availability": "unpublished",
-      "releaseStatus": "testing",
+      "availability": "published",
+      "releaseStatus": "live",
       "dependencies": [],
       "moduleKind": "customer_feature",
       "customerSelectable": true,
@@ -91,7 +91,7 @@
     {
       "id": "helyx.levels",
       "package": "@helyx/module-levels",
-      "version": "1.0.11",
+      "version": "1.0.12",
       "name": "Levels",
       "description": "Optional participation levels and rewards.",
       "category": "Community",
@@ -211,7 +211,7 @@
     {
       "id": "helyx.account-gate",
       "package": "@helyx/module-account-gate",
-      "version": "1.0.12",
+      "version": "1.0.14",
       "name": "Access Control",
       "description": "Require new members to complete configurable Discord interaction checks before gaining access.",
       "category": "Safety",
@@ -256,7 +256,7 @@
     {
       "id": "helyx.forms",
       "package": "@helyx/module-forms",
-      "version": "1.0.5",
+      "version": "1.0.6",
       "name": "Forms",
       "description": "Collect reusable structured responses through Discord modals.",
       "category": "Support & Staff",
@@ -271,12 +271,12 @@
     {
       "id": "helyx.faq",
       "package": "@helyx/module-faq",
-      "version": null,
-      "name": "Knowledge base",
-      "description": "Answer common questions with maintained server guidance.",
+      "version": "1.0.2",
+      "name": "FAQ",
+      "description": "Create reusable server answers with exact text triggers.",
       "category": "Support & Staff",
-      "availability": "planned",
-      "releaseStatus": "planned",
+      "availability": "published",
+      "releaseStatus": "live",
       "dependencies": [],
       "moduleKind": "customer_feature",
       "customerSelectable": true,
@@ -436,7 +436,7 @@
     {
       "id": "helyx.reactionroles",
       "package": "@helyx/module-reactionroles",
-      "version": "1.0.12",
+      "version": "1.0.14",
       "name": "Reaction Roles",
       "description": "Let members select approved roles themselves.",
       "category": "Automation",
@@ -511,12 +511,12 @@
     {
       "id": "helyx.tags",
       "package": "@helyx/module-tags",
-      "version": "1.0.1",
+      "version": "1.0.2",
       "name": "Tags",
       "description": "Save and share short server snippets.",
       "category": "Automation",
-      "availability": "unpublished",
-      "releaseStatus": "testing",
+      "availability": "published",
+      "releaseStatus": "live",
       "dependencies": [],
       "moduleKind": "customer_feature",
       "customerSelectable": true,
@@ -586,7 +586,7 @@
     {
       "id": "helyx.giveaways",
       "package": "@helyx/module-giveaways",
-      "version": "1.0.13",
+      "version": "1.0.15",
       "name": "Giveaways",
       "description": "Run auditable giveaways with eligibility rules.",
       "category": "Engagement",
@@ -616,7 +616,7 @@
     {
       "id": "helyx.counting",
       "package": "@helyx/module-counting",
-      "version": "1.0.3",
+      "version": "1.0.4",
       "name": "Counting",
       "description": "A focused, server-scoped Discord counting game.",
       "category": "Gaming",
@@ -631,7 +631,7 @@
     {
       "id": "helyx.trivia",
       "package": "@helyx/module-trivia",
-      "version": "1.0.3",
+      "version": "1.0.4",
       "name": "Trivia",
       "description": "Play private trivia rounds from a saved question catalogue.",
       "category": "Gaming",
@@ -721,7 +721,7 @@
     {
       "id": "helyx.achievements",
       "package": "@helyx/module-achievements",
-      "version": "1.0.4",
+      "version": "1.0.7",
       "name": "Achievements",
       "description": "Configurable member milestones, scores and optional rewards.",
       "category": "Gaming",
@@ -796,7 +796,7 @@
     {
       "id": "helyx.health",
       "package": "@helyx/module-health",
-      "version": "1.0.1",
+      "version": "1.0.3",
       "name": "Server Health",
       "description": "Scan your Discord server for configuration, safety and capacity issues.",
       "category": "Insights",
@@ -871,7 +871,7 @@
     {
       "id": "helyx.nexus-core",
       "package": "@helyx/module-nexus-core",
-      "version": "1.0.1",
+      "version": "1.0.3",
       "name": "Nexus Core",
       "description": "Provides the shared Nexus balance, ledger, terminology and command namespace.",
       "category": "Gaming",
@@ -886,7 +886,7 @@
     {
       "id": "helyx.nexus-rewards",
       "package": "@helyx/module-nexus-rewards",
-      "version": "1.0.1",
+      "version": "1.0.2",
       "name": "Nexus Rewards",
       "description": "Configure Daily Claim and approved ways members earn Nexus units.",
       "category": "Community",
@@ -906,7 +906,7 @@
     {
       "id": "helyx.nexus-economy",
       "package": "@helyx/module-nexus-economy",
-      "version": "1.0.1",
+      "version": "1.0.3",
       "name": "Nexus Economy",
       "description": "Run a Nexus Exchange with server rewards and member inventory.",
       "category": "Gaming",

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

@@ -66,6 +66,13 @@ HELYX_SHARD_MODE=off
 # HELYX_BOT_CONTROL_PORT=3001
 # HELYX_GUILD_RECONCILIATION_INTERVAL_SECONDS=900
 
+# Guild command writes remain off until explicitly enabled for known guild IDs.
+HELYX_GUILD_COMMAND_WRITES_ENABLED=false
+HELYX_GUILD_COMMAND_WRITE_SCOPE=allowlist
+# HELYX_GUILD_COMMAND_RELEASE_ID=
+HELYX_GLOBAL_COMMAND_MODE=legacy
+# HELYX_GUILD_COMMAND_WRITE_GUILD_IDS=
+
 # Privacy tooling ships with self-hosted Helyx but stays disabled until the
 # dedicated least-privilege executor connection has been configured.
 HELYX_PRIVACY_ENABLED=false

package/templates/self-host/DOCUMENTATION.md

@@ -0,0 +1,15 @@
+# Helyx documentation
+
+The public documentation matching this installed Helyx runtime ships inside
+`@helyx/bot`. Run `npm ci` first, then open:
+
+[`node_modules/@helyx/bot/documentation/README.md`](node_modules/@helyx/bot/documentation/README.md)
+
+That directory contains self-hosting guides, environment reference material,
+operator runbooks, and module-authoring instructions. It is replaced when the
+bot package is updated, so keep deployment-specific notes outside
+`node_modules`.
+
+The generated project's `.env.example` is the active configuration template.
+Never add the real `.env` file, credentials, database dumps, or private logs to
+a support bundle or source repository.

package/templates/self-host/README.md

@@ -8,6 +8,9 @@ This self-host starter was generated from the reviewed Helyx catalogue. It conta
 
 Package installation and module activation are separate. Installed feature modules start disabled for every Discord server. Enable and configure them only after the bot is running.
 
+The matching offline operator and module-author documentation is listed in
+[`DOCUMENTATION.md`](DOCUMENTATION.md) after the project has been generated.
+
 ## Requirements
 
 - A Discord application and bot token