This is a command-line interface to create a new Comet application. It sets up a project with the necessary configuration and files to get started quickly.
To create a new Comet app, run the following command:
npx @comet/create-app <project-name>
The following arguments can be passed to customize the project setup:
-
project-name
(required): Specifies the name of the project. It will be used as the directory name for the project. -
-ni
or--no-install
: Disables the automatic installation of dependencies. -
-r
or--repository <repository>
: Repository to clone from. Defaults tohttps://github.com/vivid-planet/comet-starter.git
. -
-b
or--branch <branch>
: Branch to checkout. Defaults tomain
. -
-v
or--verbose
: Enables extra console logs for verbose output. -
-V
or--version
: Outputs the version number. -
-h
or--help
: Display help for the command.
Create a new Comet app with the name "my-project" and enable verbose logging:
npx @comet/create-app my-project -v
Create a new Comet app with a different repository and branch:
npx @comet/create-app my-project -r https://github.com/my-company/comet-starter.git -b next
The following commands can be used to customize the project setup:
-
remove-site
: Removes the site from the project.
Example usage:
npx @comet/create-app remove-site
To test the script locally, run the following commands:
- Start the development process:
npm start
- Run the script:
node ./bin/index.js
Testing a close to production usage of the CLI can be done by calling npm link
in the create-app/ directory. Then npx @comet/create-app
can be used.