Namespace npm package under jmfederico

This commit is contained in:
Federico Jaramillo Martinez
2026-05-08 18:57:20 +02:00
parent dca8fe6855
commit f89c055e59
5 changed files with 18 additions and 9 deletions
+12 -3
View File
@@ -90,7 +90,7 @@ Pi Web keeps its own state intentionally small:
Recommended install uses npm plus systemd user services: Recommended install uses npm plus systemd user services:
```bash ```bash
npm install -g pi-web npm install -g @jmfederico/pi-web
pi-web install pi-web install
``` ```
@@ -116,7 +116,7 @@ pi-web uninstall
One-line install is also available for users who prefer it: One-line install is also available for users who prefer it:
```bash ```bash
curl -fsSL https://raw.githubusercontent.com/earendil-works/pi-web/main/install.sh | sh curl -fsSL https://raw.githubusercontent.com/jmfederico/pi-web/main/install.sh | sh
``` ```
Advanced users may run the binaries however they prefer: Advanced users may run the binaries however they prefer:
@@ -126,6 +126,15 @@ pi-web-sessiond
PI_WEB_PORT=8504 pi-web-server PI_WEB_PORT=8504 pi-web-server
``` ```
To install directly from the GitHub repository instead of npm:
```bash
npm install -g github:jmfederico/pi-web#main
pi-web install
```
This uses npm's git install flow and runs the package `prepare` script to build `dist/` on the target machine.
## Development quick start ## Development quick start
```bash ```bash
@@ -161,7 +170,7 @@ npm run pack:dry
npm publish --access public npm publish --access public
``` ```
`prepack` builds `dist/` before npm creates the tarball, and `prepublishOnly` runs verification before publishing. Releases can also be published by the GitHub Actions npm workflow when a GitHub release is published. `prepare` builds `dist/` before npm creates the tarball and when installing directly from git, and `prepublishOnly` runs verification before publishing. Releases can also be published by the GitHub Actions npm workflow when a GitHub release is published.
Pi Web uses a single-line CalVer-inspired npm version: `MAJOR.YYYYMM.SEQUENCE`, for example `1.202605.1`. The major number signals breaking-change eras; the middle number is the release month; the final number increments for additional releases in that month. Older major eras may be deprecated rather than maintained in parallel. Pi Web uses a single-line CalVer-inspired npm version: `MAJOR.YYYYMM.SEQUENCE`, for example `1.202605.1`. The major number signals breaking-change eras; the middle number is the release month; the final number increments for additional releases in that month. Older major eras may be deprecated rather than maintained in parallel.
+1 -1
View File
@@ -1,5 +1,5 @@
#!/usr/bin/env sh #!/usr/bin/env sh
set -eu set -eu
npm install -g pi-web npm install -g @jmfederico/pi-web
pi-web install pi-web install
+2 -2
View File
@@ -1,11 +1,11 @@
{ {
"name": "pi-web", "name": "@jmfederico/pi-web",
"version": "1.202605.1", "version": "1.202605.1",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "pi-web", "name": "@jmfederico/pi-web",
"version": "1.202605.1", "version": "1.202605.1",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
+2 -2
View File
@@ -1,5 +1,5 @@
{ {
"name": "pi-web", "name": "@jmfederico/pi-web",
"version": "1.202605.1", "version": "1.202605.1",
"license": "MIT", "license": "MIT",
"type": "module", "type": "module",
@@ -28,7 +28,7 @@
"start": "tsx src/server/index.ts", "start": "tsx src/server/index.ts",
"start:sessiond": "tsx src/server/sessiond.ts", "start:sessiond": "tsx src/server/sessiond.ts",
"clean": "rm -rf dist", "clean": "rm -rf dist",
"prepack": "npm run build", "prepare": "npm run build",
"pack:dry": "npm pack --dry-run", "pack:dry": "npm pack --dry-run",
"prepublishOnly": "npm run verify", "prepublishOnly": "npm run verify",
"publish:npm": "npm publish --access public" "publish:npm": "npm publish --access public"
+1 -1
View File
@@ -197,7 +197,7 @@ Usage:
pi-web doctor pi-web doctor
Recommended install: Recommended install:
npm install -g pi-web npm install -g @jmfederico/pi-web
pi-web install pi-web install
`); `);
} }