create-roxyon-app
v0.1.2
Published
Scaffold a Roxyon project — LumenJS SPA or a Node app — wired for `roxyon deploy`, with AGENTS.md / llms.txt / editor rules so any AI assistant gets it right.
Maintainers
Readme
create-roxyon-app
Scaffold a Roxyon project that's ready for roxyon deploy and legible to any AI
assistant.
npm create roxyon-app@latest my-app
# or
npx create-roxyon-app my-app --template lumen-baas --host my-domain.comTemplates
| id | what |
|---|---|
| lumen | LumenJS SPA (vanilla JS/HTML/CSS, no build step) |
| lumen-baas | LumenJS SPA wired to the Roxyon BaaS — RX SDK, rxError() helper, an auth-free data example (items.view) |
| node | Minimal Node.js HTTP server (no deps), reads PORT/HOST from the environment |
LumenJS templates are scaffolded by @lmjs/cli under the hood, then overlaid —
so they always track the current framework.
What every project gets
roxyon.json— host, folder, runtime, build commandAGENTS.md— how to build and deploy this project, plus the LumenJS V1 / BaaS gotchas. Also written asCLAUDE.md,GEMINI.md,.cursor/rules/roxyon.mdc,.github/copilot-instructions.mdllms.txt— pointers to the framework + platform docs.roxyonignore,.gitignore- npm scripts:
dev,build,deploy
Flags
-t, --template <id> lumen | lumen-baas | node
--host <domain> deploy host (a domain on your Roxyon subscription)
--folder <path> sub-path under the host
--no-install skip npm install
-y, --yes accept defaults, no prompts