@bluecadet/create-launchpad
v4.0.2
Published
Scaffolding CLI for @bluecadet/launchpad projects
Keywords
Readme
@bluecadet/create-launchpad
Scaffolding CLI for Launchpad projects.
Usage
Use Node.js 24.x or 26 and newer (^24 || >=26).
npm create @bluecadet/launchpadThe tool asks which plugins, sources, and transforms you need, then generates or updates these files with explicit workflow orchestration:
launchpad.config.tspackage.json(created or merged)tsconfig.json(created or validated).gitignore(optional)
Generated package.json files declare the Node.js requirement. When updating an existing project, the scaffolder adds the requirement if it is missing and keeps any explicit Node engine declaration; make sure that range matches the supported runtime.
After the tool finishes, install the added dependencies:
npm installIf you scaffold the monitor plugin, the generated config includes workflows.start and workflows.stop, so PM2 apps connect, start, stop, and disconnect in order.
Observability
Observability is opt-in and unselected by default. The scaffolder generates no endpoint, token, or other credential. The generated plugin stays disabled until LAUNCHPAD_OBSERVABILITY_ENDPOINT is set, and then sends Launchpad logs and metrics only to that OTLP endpoint.
LAUNCHPAD_OBSERVABILITY_TOKEN is optional. If it is missing, empty, or whitespace, requests go out without authentication. Nonblank tokens pass through unchanged. No client, project, installation, environment, organization, or other resource field is required.
To identify the generated service, uncomment and edit the optional resource example in launchpad.config.ts:
resource: { 'service.name': 'my-launchpad-service' },Add other flat primitive resource attributes if your deployment policy requires them.
Logs use the controller's retained canonical JSONL and per-destination checkpoints by default. The generated block includes a commented logStorage: { type: 'memory' } opt-out for ephemeral delivery. New destinations backfill from the oldest retained record, which can raise ingestion costs or hit backend timestamp limits; see the delivery reference.
Docs
See Creating a Project for full documentation.
License
Bluecadet-authored code in this package is licensed under ISC. Third-party dependencies retain their own licenses.
