next-boil is a CLI tool to bootstrap your Next.js starter pack with ease. Clone a pre-configured template, customize it with options, and start your Next.js journey in seconds.
- Next.js 15
- Tailwind CSS 3
- shadcn-ui
- TypeScript
- ESLint
- Prettier
- Jest
- Absolute Imports
- Customizable Package Manager Support (
npm,yarn, orpnpm) - Git Initialization
- Node.js >=
20.14.0 - Yarn >=
1.22.18(if using Yarn as your package manager) - pnpm >=
8.3.1(if using pnpm as your package manager)
Install globally via npm:
npm install -g next-boilOr, use it directly via npx:
npx next-boil my-next-appRun the CLI with a project name:
next-boil my-next-appThis will:
- Create a directory named
my-next-app. - Clone the default template from the repository.
- Set up your project, ready for development.
| Option | Description |
|---|---|
-t, --template <url> |
Specify a custom template repository URL |
-f, --force |
Force overwrite existing non-empty directories |
-b, --base-dir <path> |
Specify a base directory for project creation |
-p, --package-manager |
Choose a package manager (npm, yarn, pnpm) |
--no-git |
Skip git initialization |
--debug |
Show detailed error stack for debugging purposes |
-
Bootstrap with the default template:
next-boil my-next-app
-
Use a custom template:
next-boil my-next-app --template https://github.com/user/my-template
-
Force overwrite an existing directory:
next-boil my-next-app --force
-
Use a custom base directory:
next-boil my-next-app --base-dir ~/projects -
Select a package manager (
yarn,npm, orpnpm):next-boil my-next-app --package-manager yarn
-
Skip Git initialization:
next-boil my-next-app --no-git
-
Debug issues with verbose error messages:
next-boil my-next-app --debug
Running next-boil without arguments displays the help menu:
next-boilOnce your project is set up, navigate to the project directory and start development:
cd my-next-app
npm install
npm run devIf you selected a package manager like Yarn or PNPM, replace npm with your chosen package manager.
This project is licensed under the MIT License.