Pantheon's command line interface for creating and adding on to new projects.
A CLI heavily inspired by various create-
apps and generator frameworks
including plop
create-sitecore-jss
,
create-astro
,
and create-create-app
.
To install this package locally, run the following commands from the root of the monorepo.
# build the package
pnpm build:cli
# link the local version of the package to global node_modules
pnpm link ./packages/create-pantheon-decoupled-kit
# run the bin script
pnpm create-pantheon-decoupled-kit
Use the create command to initiate the cli with no arguments and follow the prompts in your terminal
# this will use the latest non-canary version from the npm registry
# to use the latest canary, use pantheon-decoupled-kit@canary
pnpm create pantheon-decoupled-kit
Or, pass in arguments up front to skip those prompts
pnpm create pantheon-decoupled-kit next-wp --appName my-app --outDir ./my-app-dir --force
To run the watch
script, ensure there is a watch.{ts,js}
file at the root of
this package. The watch file should export a named watchOptions
object of type
minimist.ParsedArgs
. Positional arguments in the _
array will correspond to
Generators to run. Named arguments correspond to answers to the Generator
prompts. Generators will be run in the order they are given. Any number of
generators may be run at a given time. See watch.example.ts
for an example of
watchOptions
.
See create-pantheon-decoupled-kit for more information.
Please see the Contributing guide in our monorepo to contribute to the project.
See https://decoupledkit.pantheon.io/docs/contributing for details on contributing to this module.