@rom-weaver/cli 0.10.2 → 0.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -109,7 +109,7 @@ general speed claim.
109
109
  and the threaded WASM webapp, with line-delimited JSON output for scripting.
110
110
 
111
111
  The complete format, codec, and checksum compatibility tables are maintained
112
- in the [CLI guide](./docs/hosting/cli.md#supported-formats).
112
+ in the [CLI guide](./docs/reference/formats.md).
113
113
 
114
114
  ## Notices
115
115
 
@@ -170,20 +170,42 @@ For a guided explanation, use
170
170
  [guided Apply](https://rom-weaver.com/apply?guide=apply),
171
171
  [guided Create](https://rom-weaver.com/create?guide=create), or
172
172
  [guided Bundle](https://rom-weaver.com/apply?guide=bundle).
173
+ To run the webapp on your own host, see the
174
+ [self-hosting guide](./docs/hosting/self-hosting.md) for the release tarball,
175
+ Docker, and Docker Compose setups.
173
176
 
174
177
  <a name="self-host-the-webapp"></a>
175
178
 
176
179
  <details>
177
180
  <summary>Self-host the webapp</summary>
178
181
 
179
- The Docker source build serves the full webapp: it builds the WASM module, adds
180
- cross-origin isolation headers, supports client-side routes, and precompresses
181
- assets. The
182
- [self-hosting guide](./docs/hosting/self-hosting.md) covers reverse proxies, subpath
183
- routing, HTTPS certificates, service-worker scope, and the required COOP/COEP
184
- headers.
182
+ For a quick setup, choose static files, Docker Run, or Docker Compose. The
183
+ [full self-hosting guide](./docs/hosting/self-hosting.md) covers reverse proxies,
184
+ subpath routing, HTTPS certificates, service-worker scope, and the required
185
+ COOP/COEP headers.
185
186
 
186
- Build and start it with Docker Compose:
187
+ Static release files:
188
+
189
+ ```bash
190
+ mkdir -p rom-weaver-webapp
191
+ curl --fail --location --proto '=https' --tlsv1.2 \
192
+ --output rom-weaver-webapp.tar.gz \
193
+ https://github.com/rom-weaver/rom-weaver/releases/latest/download/rom-weaver-webapp.tar.gz
194
+ tar --extract --gzip --file rom-weaver-webapp.tar.gz --directory rom-weaver-webapp
195
+ ```
196
+
197
+ Serve the extracted `rom-weaver-webapp` directory from an HTTPS static host.
198
+ For a pinned release, replace `latest` in the URL with its tag.
199
+
200
+ Docker Run:
201
+
202
+ ```bash
203
+ docker run --detach --name rom-weaver-webapp \
204
+ --publish 8080:8080 \
205
+ ghcr.io/brandonocasey/rom-weaver-webapp:latest
206
+ ```
207
+
208
+ Docker Compose, building from source:
187
209
 
188
210
  ```bash
189
211
  git clone https://github.com/rom-weaver/rom-weaver.git
@@ -230,6 +252,7 @@ scoop install rom-weaver
230
252
 
231
253
  Downloads the latest release to `~/.local/bin` and verifies its checksum.
232
254
  Override with `ROM_WEAVER_INSTALL_DIR` or pin with `ROM_WEAVER_VERSION`.
255
+ The script also installs manpages and shell completions for the current user.
233
256
 
234
257
  ```bash
235
258
  curl --proto '=https' --tlsv1.2 -LsSf \
@@ -242,6 +265,7 @@ curl --proto '=https' --tlsv1.2 -LsSf \
242
265
  <summary>Install script (Windows)</summary>
243
266
 
244
267
  The same thing for PowerShell, installing to `%LOCALAPPDATA%\rom-weaver\bin`.
268
+ It also installs the PowerShell completion beside the executable.
245
269
 
246
270
  ```powershell
247
271
  irm https://raw.githubusercontent.com/rom-weaver/rom-weaver/main/install.ps1 | iex
@@ -314,7 +338,7 @@ docker run --rm \
314
338
  Mount your ROM directory at `/work` and pass paths under it. `--user` matters:
315
339
  bind-mounted files keep their host ownership, so without it the container cannot
316
340
  read files it does not own and leaves anything it writes owned by an unknown uid.
317
- See [Run in Docker](./docs/hosting/cli.md#run-in-docker).
341
+ See [Run in Docker](./docs/cli/install.md#run-in-docker).
318
342
 
319
343
  </details>
320
344
 
@@ -336,7 +360,7 @@ toolchain.
336
360
  </details>
337
361
 
338
362
  Hitting `Permission denied`? See
339
- [File permissions](./docs/hosting/cli.md#file-permissions).
363
+ [File permissions](./docs/cli/reference.md#file-permissions).
340
364
 
341
365
  The [development guide](./docs/development/development.md) covers the full toolchain setup,
342
366
  webapp builds, and tests.