create-kedge
v0.11.2
Published
npx create-kedge my-store: a new Kedge store from the starter.
Readme
create-kedge
A new Kedge store: an open-source (MIT) headless commerce backend that runs on Cloudflare Workers and D1, in your own Cloudflare account.
mkdir my-store && cd my-store
npm create kedge@latestRun it in an empty folder, or name a new one: npm create kedge@latest my-store.
The store's name comes from the folder (--name chooses another; --help lists
the options and writes nothing). It needs Node 24 or newer and pnpm 10 or newer
(npm install --global pnpm), and checks both before it writes anything.
With a coding agent
Give your agent this page and ask: "Make me a Kedge store and place a test
order." The store it makes carries the kedge-start skill (in .claude/skills/
and .agents/skills/), which holds the steps below. A command that needs you
stops with exit code 3 and one line starting for you:; your agent passes it on.
The first run
On this machine (no Cloudflare account needed):
pnpm kedge check --fastpnpm kedge dev(keep it running): the store athttp://localhost:8787, its admin at/app/.pnpm kedge staff invite-owner [email protected]: open the link it prints, set a password and an authenticator, and you're the store's Owner.pnpm kedge seed --sample apparel --url http://localhost:8787pnpm kedge smoke --url http://localhost:8787: a test order, placed.
On Cloudflare (a Workers Paid account):
- Commit the store:
git add -A && git commit -m "A new Kedge store". - Give the CLI credentials:
CLOUDFLARE_API_TOKENandCLOUDFLARE_ACCOUNT_IDin.env.local, ornpx wrangler login.pnpm kedge doctor --remotechecks them. pnpm kedge deploy --jurisdiction <eu|us|fedramp|none>: where the store's data lives, chosen once.pnpm kedge staff invite-owner [email protected] --remote: your invite.pnpm kedge seed --sample apparel --url <store> --liveandpnpm kedge smoke --url <store> --live: sample products and a test order on the live store.
Every command takes --json for a single result object on stdout. The installed
@kedge/docs holds the guides for extending the store, matched to its version.
