Skip to content

redwoodjs/create-rwsdk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-rwsdk

A simple CLI wrapper for creating RedwoodSDK starter projects with support for multiple templates.

Installation

You can use this package directly with npx:

npx create-rwsdk my-project

Usage

create-rwsdk [project-name] [options]

Commands

  • create: Create a new project (default command when no command is specified)
  • list: List and interactively select from available templates

Arguments

  • [project-name]: Name of the project directory to create (optional, will prompt if not provided)

Options

  • -f, --force: Force overwrite if directory exists
  • -t, --template <template>: Starter template to use (standard, minimal) [default: "standard"]
  • -h, --help: Display help information
  • -V, --version: Display version number

Examples

Create a new project with the default (standard) template:

create-rwsdk my-awesome-app

Create a new project with an interactive prompt for the project name:

create-rwsdk
# You will be prompted: What is the name of your project?

List and interactively select from available templates:

create-rwsdk list
# You will see a list of templates to choose from and then be prompted for a project name

Create a project with the minimal template:

create-rwsdk my-awesome-app --template minimal

Force overwrite an existing directory:

create-rwsdk my-awesome-app --force

What it does

This tool is a simple wrapper around the following commands, depending on the template you choose:

Standard template (default)

npx tiged redwoodjs/sdk/starters/standard <project-name>

Minimal template

npx tiged redwoodjs/sdk/starters/minimal <project-name>

Next steps after creating a project

cd <project-name>
pnpm install
pnpm dev

Check out the full RedwoodSDK documentation.

License

MIT

About

npx create-rwsdk my-project

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •