OxyPages CLI
Deploy From Your Terminal
Run npx oxypages in any project folder. It builds your app on your computer and puts it online in seconds - no account needed to start.
npx oxypagesNo Account
Deploy In One Command
You need Node.js 18 or newer. Nothing to install first and nothing to sign up for.
- 1
Run It In Your Project Folder
If the project has a build script, the CLI installs the dependencies and runs the build on your computer, then uploads the output folder (dist, build or out). A plain folder of HTML is uploaded as it is.
npx oxypages - 2
Open Your Link
You get a live address straight away, plus a claim link. A deploy without an account stays up for 30 minutes - open the claim link to keep it in a free account. Anyone with the claim link can claim the project, so don't share it.
Without an account a deploy can be up to 25 MB and 500 files.
Your Account
Sign In Once, Deploy Forever
Signed in, deploys go straight to your account and never expire.
- 1
Sign In From The Terminal
Your browser opens. Sign in, or create a free account, and approve. The CLI keeps a key on this computer - you'll see it as "OxyPages CLI" under Profile, API Keys.
npx oxypages login - 2
Deploy
The first deploy creates a project and links the folder to it (in a .oxypages folder, added to .gitignore). Every deploy after that updates the same project.
npx oxypages
For CI, set OXYPAGES_TOKEN to an API key instead of signing in.
Reference
Commands And Options
- oxypages
- Build if needed and deploy this folder (same as oxypages deploy).
- oxypages deploy <folder>
- Deploy another folder.
- oxypages login
- Sign in or create a free account in your browser.
- oxypages projects
- List your projects.
- oxypages open
- Open this folder's project in the browser.
- oxypages unlink
- Forget which project this folder deploys to.
- oxypages logout
- Forget the sign-in on this computer.
- --temporary
- Deploy without an account even when you're signed in.
- --no-build
- Skip the build and upload what's already there.
- --output <folder>
- Name the build output folder if it isn't found automatically.
- --json
- Print the result as JSON, for scripts and AI agents.
Git
Rather Build On Every Push?
Connect the repository with GitHub and OxyPages builds and deploys every push for you.
FAQ