A new create command scaffolds an Edge App in 1 step
The create command scaffolds a working Edge App into a new directory, with a manifest, an entry point, and package.json scripts set up for npm or Bun.
Starting an Edge App used to mean cloning a template repository and replacing its placeholders. Now 1 command gives you a project that builds:
npx @screenly/edge-apps create my-edge-app
cd my-edge-app
npm run dev
With Bun, run bunx @screenly/edge-apps create my-edge-app instead. The command notices which
package manager started it and writes the package.json scripts and test setup to match. --pm npm
or --pm bun overrides that.
The new directory has:
- a
screenly.ymlmanifest with amessagesetting and asentry_dsnsetting index.htmlwith<auto-scaler>and<app-header>already on the pagesrc/main.ts, which applies the theme, reads themessagesetting, and signals ready- scripts for
dev(with the CORS proxy running alongside),build,lint,format,type-check,screenshots, anddeploy - a Playwright spec under
e2e/for screenshots at every supported resolution
Dependencies are installed for you, at the versions the library itself was released with.
| Option | What it does |
|---|---|
--description <text> | Sets the description in package.json, screenly.yml, and README.md |
--author <text> | Sets the author in package.json |
--pm <npm|bun> | Picks the package manager instead of detecting it |
--force | Writes into a directory that already has files in it |
--skip-install | Skips installing dependencies |
Running edge-apps-scripts create with no directory still does what it did before: it fills in
the {{APP_NAME}}-style placeholders in the current project, for template repositories you've
already cloned.