Stagepass

FAQ

Frequently asked questions

Short answers about setup, safety and versions.

Ask on GitHub

Do visitors see my local code?

No. Without an active session, tagged files keep their production URLs. Local files are only accepted from domains ending in .sp, localhost or localhost:*.

What do I need to run it?

macOS, Node.js 18 or newer and Homebrew. Running stagepass setup installs Caddy, Dnsmasq and PHP. No Docker.

Does it work on Windows or Linux?

Not yet. Stagepass runs on macOS today. Windows and Linux support may come later.

Does it slow the site down?

Scripts load with defer. Without a session the loader only keeps your production URLs.

How do I turn it off?

Click the flag in the top right corner and choose End session, or open the page with ?stagepass=off. Without a flag, you see the live site.

What is debug mode?

Open the page with ?stagepass=debug. Stagepass logs what it does but does not swap any files.

Can I use TypeScript, SCSS or a bundler?

Yes. Stagepass serves the built files from your folder, so Vite, Webpack and legacy PHP setups all work.

Which versions should I use?

Use the major pin @2 for loader and modules. Stagepass follows strict semver, so you get fixes within v2 without breaking changes. If you want full control, pin an exact version like @2.3.0.

Where is the session stored?

In localStorage in your browser. That is why the session survives reloads and sub pages.

Is Stagepass free?

Yes. It is open source under the MIT license.