quickstart
publish a standalone HTML file to a shareable spx URL
spx publishes a single standalone HTML file and returns an unlisted public URL.
It is most useful when a coding agent produces a report, dashboard, memo, or proposal that you want to show to someone without deploying a web service.
Setup
The fastest path is to sign up on the web, which hands you a one-step login command. Otherwise, run the four commands below.
Install the CLI:
brew install ab-10/spx/spxAuthenticate:
spx loginThis starts a GitHub OAuth device flow and prints a code to enter in your browser. If you signed up at runspx.com/install, paste the personalized command instead:
spx login --code <code>Subscribe:
spx subscribePublishing requires an active subscription. spx subscribe opens Stripe Checkout in your
browser and waits for the subscription to activate.
Publish
spx report.htmlspx uploads the file and prints the URL:
https://<slug>.runspx.dev/To start checkout automatically when publishing is blocked by billing, pass --subscribe
(or set SPX_AUTO_SUBSCRIBE=1):
spx report.html --subscribeFile requirements
- The upload must be one standalone HTML file.
- The filename must end in
.htmlor.htm. - The file must be 10 MB or smaller.
Put CSS, JavaScript, images, and other assets inline. spx does not upload a directory or
an asset bundle.
Manage published pages
Replace the HTML behind an existing page, keeping the same URL:
spx update <slug-or-url> report.htmlList your pages:
spx listDelete a page:
spx delete <slug-or-url>URL behavior
Only the root URL is served. Other paths, including /index.html, are not part of the
public contract.
spx URLs are unlisted, not private. Treat anyone with the URL as able to view the page.