archival run

Options

-p, --port <port>

choose the port to run the local server on. By default, archival serves on the first available port starting at 1024 (so it’s usually 1024).

-n, --noserve

disable the static server and only watch and rebuild on file changes. Useful when another server is serving the build directory, or for IDE integrations.

-u, --upload-prefix <prefix>

override the upload prefix. If no archival.toml is present, this is required.

--no-carriers

don't serve the carriers in this site's carriers/ directory.

--carriers-port <port>

choose the port your carriers' Node process listens on. By default it uses any free port.

--carriers-inspect

run your carriers under node --inspect, so a debugger can attach.

--site-url <url>

override the site.url your carriers see. Defaults to this server's address.

-h, --help

print help for this command.

Arguments

[path/to/archival-site]

optionally specify a path to an archival site. By default will run in the current working directory.

This command runs a local static server and watches your archival site for changes. The site will be automatically rebuilt whenever files change, including scripts: saving a .ts file in scripts/ rebuilds it, and a script that fails to compile prints its error while the server keeps serving its last working version.

If your site has carriers, archival run serves them too, at /carriers/<carrier-name>, and picks up a carrier as soon as you add or change it. This needs Node 22.13 or later; see Running carriers locally.

Note that this command should never be used to serve a website in production. Archival generates static websites, so to serve an archival site, just run archival build and run a static web server that points to the dist folder, or upload that dist folder to a static host (or use the archival editor to automate this process).