Skip to main content

Usage

The recommended way of using Create Kadena App is through npx.

npx @kadena/create-kadena-app
npx @kadena/create-kadena-app

Create Kadena app allows you to pass command line arguments to set up a new project non-interactively. While we might further expand functionality in the future currently there's one command availabe, generate-project. See create-kadena-app generate --help:

Usage: create-kadena-app generate-project [options]
 
Generate starter project
 
Options:
  -n, --name <value>      Project name
  -t, --template <value>  Project template to use
  -h, --help              display help for command
Usage: create-kadena-app generate-project [options]
 
Generate starter project
 
Options:
  -n, --name <value>      Project name
  -t, --template <value>  Project template to use
  -h, --help              display help for command

Options:

  • name determines the name of the project but also the folder on the filesystem that will contain the project. The same general operating system folder name rules apply and are being validated.
  • template determines the template being used for the project that is being created. Valid values are:
    • nextjs
    • vuejs
    • angular
  • help displays the help menu