\n\n#### Base template for pwa/api-rest projects.\n\n## Underpost Platform\n\n**Underpost** is an platform for application delivery, from infrastructure to runtime. The `underpost` npm package is its CLI toolchain surface.\n\nThe project covers:\n\n- **Bare metal provisioning** on Rocky Linux 9.\n- **Kubernetes / K3s / kubeadm / LXD** workflows for production, edge, and isolated workloads.\n- **GitHub OSS repository flow** — clone, pull, push, commit, release, and CI integrations as first-class CLI subcommands.\n- **CI/CD orchestration** — GitHub Actions integrations, container builds, multi-environment deployments.\n- **Static build + PWA delivery** — every deploy ships as an installable Progressive Web App with Workbox-based offline support.\n- **Cloudinary-backed static asset flow** for image/asset delivery.\n- **ERP/CRM-style PWA base applications** as the default workload.\n- **Cyberia** — a dedicated MMO extension built on top of the platform, with its own content backend (`engine-cyberia`), authoritative simulation runtime (`cyberia-server`), and presentation runtime (`cyberia-client`).\n\nSee Detailed platform doc.\n\n### Architectural roles (Cyberia stack)\n\nWhen the platform is hosting the Cyberia MMO extension, three independent runtime processes participate. Their boundaries are non-overlapping.\n\n| Process | Role |\n| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **engine-cyberia** (Node.js) | Content authority: maps, object layers, atlas/asset metadata, world configuration, persistence, validation, gRPC + REST data services, editor backend, asset distribution. |\n| **cyberia-server** (Go) | Authoritative simulation runtime: tick advancement, AOI replication, input command processing, snapshot generation. |\n| **cyberia-client** (C → WebAssembly) | Presentation runtime: rendering, UI, input capture, prediction, reconciliation, interpolation, client-side presentation defaults. |\n\nThe ecosystem is **playable only when all three are running and healthy**. Each service is supervised independently and owns its own monitor/reconnector. If any one is unhealthy, the game enters standby and resumes automatically once all three are healthy again.\n\nSee detailed Cyberia architecture.\n\n## Create a new project\n\n```bash\nnpm install -g underpost\n```\n\n```bash\nunderpost new app-name\n```\n\nAfter template installation, the server will be running on http://localhost:4001\n\n## Usage\n\n```bash\ncd app-name\n```\n\nBuild client bundle\n\n```bash\nnpm run build\n```\n\nRun dev client server\n\n```bash\nnpm run dev\n```\n\nSee Docs.\n\n\n## Underpost CLI\n\n> underpost ci/cd cli v3.4.5\n\n**Usage:** `underpost [options] [command]`\n\n### Global options\n\n| Option | Description |\n| --- | --- |\n| `-V, --version` | output the version number |\n| `--profile ` | Execution profile. One of: LIVE_CLUSTER, HERMETIC_BUILD, OFFLINE_DRY_RUN. LIVE_CLUSTER Full access: cluster and host mutation permitted. HERMETIC_BUILD Build outputs only: no cluster, host or network side effects. OFFLINE_DRY_RUN Nothing executes; every command is reported as intent. |\n| `-h, --help` | display help for command |\n\n### Commands\n\n| Command | Description |\n| --- | --- |\n| [`new`](CLI-HELP.md#underpost-new) | Initializes a new Underpost project, service, or configuration. |\n| [`client`](CLI-HELP.md#underpost-client) | Builds client assets, single replicas, and/or syncs environment ports. |\n| [`start`](CLI-HELP.md#underpost-start) | Initiates application servers, build pipelines, or other defined services based on the deployment ID. |\n| [`clone`](CLI-HELP.md#underpost-clone) | Clones a specified GitHub repository into the current directory. |\n| [`pull`](CLI-HELP.md#underpost-pull) | Pulls the latest changes from a specified GitHub repository. |\n| [`cmt`](CLI-HELP.md#underpost-cmt) | Manages commits to a GitHub repository, supporting various commit types and options. |\n| [`push`](CLI-HELP.md#underpost-push) | Pushes committed changes from a local repository to a remote GitHub repository. |\n| [`static`](CLI-HELP.md#underpost-static) | Manages static build of page, bundles, and documentation with comprehensive customization options. |\n| [`root`](CLI-HELP.md#underpost-root) | Displays the root path of the npm installation. |\n| [`ip`](CLI-HELP.md#underpost-ip) | Displays the current public machine IP addresses. |\n| [`cluster`](CLI-HELP.md#underpost-cluster) | Manages Kubernetes clusters, defaulting to Kind cluster initialization. |\n| [`deploy`](CLI-HELP.md#underpost-deploy) | Manages application deployments, defaulting to deploying development pods. |\n| [`secret`](CLI-HELP.md#underpost-secret) | Workload secret store: SOPS/Age encrypted credentials projected as Kubernetes Secrets. |\n| [`host`](CLI-HELP.md#underpost-host) | Host configuration: the node-level operational environment shared by the cluster. |\n| [`app`](CLI-HELP.md#underpost-app) | Application environment: one deployment's runtime configuration. |\n| [`state`](CLI-HELP.md#underpost-state) | Runtime state: live container execution state, health and metrics, exported off-cluster. |\n| [`image`](CLI-HELP.md#underpost-image) | Manages Docker images, including building, saving, and loading into Kubernetes clusters. |\n| [`install`](CLI-HELP.md#underpost-install) | Quickly imports Underpost npm dependencies by copying them. |\n| [`db`](CLI-HELP.md#underpost-db) | Manages database operations with support for MariaDB and MongoDB, including import/export, multi-pod targeting, and Git integration. |\n| [`metadata`](CLI-HELP.md#underpost-metadata) | Manages cluster metadata operations, including import and export. |\n| [`cron`](CLI-HELP.md#underpost-cron) | Manages cron jobs: execute jobs directly or generate and apply K8s CronJob manifests. |\n| [`fs`](CLI-HELP.md#underpost-fs) | Uploads, pulls, or deletes Cloudinary assets and synchronizes the selected storage manifest. |\n| [`monitor`](CLI-HELP.md#underpost-monitor) | Manages health server monitoring, the cluster observability stack, and host dashboards. |\n| [`event`](CLI-HELP.md#underpost-event) | Dispatches operational events and provisions the monitoring rules that trigger them. |\n| [`ssh`](CLI-HELP.md#underpost-ssh) | Manages cluster scoped SSH credentials and sessions for remote access to cluster nodes or services. Users are registered in engine-private/deploy/conf.users.json and keys are stored in engine-private/deploy/users/. |\n| [`wireguard`](CLI-HELP.md#underpost-wireguard) | Manages the WireGuard L3 hub-and-spoke transport and the HAProxy edge gateway in front of it. |\n| [`haproxy`](CLI-HELP.md#underpost-haproxy) | Manages the HAProxy edge gateway over the WireGuard transport (same subsystem as `underpost wireguard`). |\n| [`vultr`](CLI-HELP.md#underpost-vultr) | Meters the edge VPS bandwidth against its Vultr plan quota and blocks egress before overage accrues. |\n| [`run`](CLI-HELP.md#underpost-run) | Runs specified scripts using various runners. |\n| [`test`](CLI-HELP.md#underpost-test) | Runs the test projects locally, inside deployment pods, or as a cluster Job with Allure reporting. |\n| [`docker-compose`](CLI-HELP.md#underpost-docker-compose) | General-purpose Docker Compose development pipeline (mirrors the Kubernetes dev stack). |\n| [`lxd`](CLI-HELP.md#underpost-lxd) | Manages LXD virtual machines as K3s nodes (control plane or workers). |\n| [`baremetal`](CLI-HELP.md#underpost-baremetal) | Manages baremetal server operations, including installation, database setup, commissioning, and user management. |\n| [`package`](CLI-HELP.md#underpost-package) | Generates the package manifests a deploy id owns, from the engine manifest and the deploy's product catalog, and installs the dependencies that catalog pins. |\n| [`socketsecurity`](CLI-HELP.md#underpost-socketsecurity) | Security audit through Socket.dev: dependency security (advisories, supply chain alerts, reachability, security patches in .socket/manifest.json) and source code risk (alerts on this project's own code). |\n| [`release`](CLI-HELP.md#underpost-release) | Release orchestrator for building new versions and deploying releases of the Underpost CLI. |\n\n\n","readmeFilename":"README.md"}
![\"underpost](\"https://underpost.net/assets/splash/apple-touch-icon-precomposed.png\"){kind=icon}
\n
\n\n