@kedge/cli
v0.11.2
Published
The kedge command (K11): generate, check, doctor, migrate, deploy, preview, eject, upgrade and the deployment's bootstrap.
Readme
@kedge/cli
kedge, the command line of a Kedge
store. A new store comes from npm create kedge@latest; this package is one of
its dependencies, run as pnpm kedge <command>.
| Command | Does |
|---|---|
| kedge dev | The store on this machine, its admin at /app/ |
| kedge check | Typecheck, generate --check, doctor, then the store's tests |
| kedge doctor [--remote] | The store's checks; --remote adds its Cloudflare credentials and resources |
| kedge generate | Compose migrations and the lock from core, plugins and local/ |
| kedge preview | An isolated copy on Cloudflare, with test/scenarios run against it |
| kedge deploy | Production: migrations first, then the Worker, under one recorded operation |
| kedge staff invite-owner <email> | The first Owner's invite link (--remote for Cloudflare) |
| kedge keys create … --save | A storefront or secret key, saved to the store's env file |
| kedge seed --sample apparel --url <url> | Sample products |
| kedge smoke --url <url> | A test order, placed; run again, the same order |
| kedge upgrade --to <version> | Every @kedge package to a release, with its codemods |
For agents. kedge <command> --help prints that command's usage and runs
nothing; kedge --help lists them all. Exit 0 done, 1 refused or failed (the reason on stderr), 2
usage, 3 a person must act: the last line of stderr starts for you: and is one
sentence to pass on. Run the same command again after they do; every command is
safe to repeat. With --json, stdout is one object, {"ok": true, ...},
{"ok": false, "error"} or {"ok": false, "handoff"}.
Cloudflare credentials come from the environment, then the store's .env.local,
then wrangler login; CLOUDFLARE_API_BASE_URL is honoured for every call.
