Helyx CLI

The supported Helyx command-line entry point for running and generating self-hosted deployments.

helyx setup
helyx start
helyx migrate
helyx doctor
helyx self-host init --manifest ./helyx-build.json --output ./helyx
helyx self-host update --check
helyx self-host update --confirm

setup safely creates .env from a generated starter's .env.example, never overwrites existing configuration and reports whether Docker Compose is available. Direct Node.js operation remains fully supported with a local or hosted PostgreSQL database. start loads local configuration without overriding hosting-platform variables and performs the production bot bootstrap, including database and installed-module migrations. migrate applies only core migrations and exits. doctor validates the complete bot environment, PostgreSQL connectivity, immutable core migration history and configured module package metadata without logging in to Discord or modifying the database.

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.

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.