next-sky-cli
v0.0.13
Published
CLI tool to create Next.js projects from next-sky template
Maintainers
Readme
next-sky-cli
Bootstrap production-ready Next.js projects from the next-sky template.
A simple CLI for creating new projects from a pre-configured Next.js starter.
What is next-sky-cli?
next-sky-cli bootstraps a new project from the next-sky repository.
Unlike create-next-app, which generates a clean Next.js application, next-sky-cli downloads a maintained project template that already includes the tooling, configuration, and project structure commonly required for modern application development.
Instead of spending time configuring a new project, you can start implementing your application immediately.
Features
- Bootstrap projects from the next-sky template.
- Support for GitHub, Scorpian Mirror, and custom Git repositories.
- Support for pnpm and npm.
- Support for custom npm registries.
- Automatic dependency installation.
- Automatic project configuration.
- Fresh Git repository initialization.
- Interactive and command-line modes.
Requirements
- Node.js 18+
- Git
- pnpm (optional, recommended)
Usage
Create a new project:
npx next-sky-cli my-appUse a specific repository:
npx next-sky-cli <username/repository> my-appExample:
npx next-sky-cli mfelfelani72/next-sky my-appCreate inside the current directory:
npx next-sky-cli .Run in interactive mode:
npx next-sky-cliWhat the CLI Does
The CLI performs the following steps automatically:
- Downloads the selected project template.
- Removes the original Git history.
- Updates project metadata.
- Installs dependencies.
- Initializes a new Git repository.
Supported Git Sources
- GitHub
- Scorpian Git Mirror
- Custom Git Repository
Supported Package Managers
- pnpm (recommended)
- npm
Supported npm Registries
- Official npm Registry
- Liara Mirror
- Custom Registry
Getting Started
cd my-appUsing pnpm:
pnpm devUsing npm:
npm run devAbout the Template
next-sky-cli installs the next-sky project template.
The template is designed to provide a practical starting point for building real-world applications. Rather than starting from a minimal Next.js installation, you begin with a project that already includes a modern development stack and a well-organized structure.
Depending on the template version, it may include:
- Next.js
- TypeScript
- Tailwind CSS
- ESLint
- Prettier
- Organized project structure
- Development tooling and recommended defaults
As the template evolves, newly generated projects automatically benefit from the latest improvements.
Contributing
Contributions, issues, and feature requests are welcome.
License
MIT License
Copyright © Mohammad Felfelani
