🪓 node-cli-boilerplate

Create a Node CLI with this user-friendly boilerplate. Use this repository as a template for your new npm command line interface project.

This is a GitHub template. You can fork it or use it as a template to start a new project with this repository as a hello-world base. I hate starting new projects from an empty template: I often miss the correct configuration, README instructions, or code samples. Using this repository as a template solves that problem.

🎁 Support: Donate

This project is free, open source and I try to provide excellent free support. Why donate? I work on this project several hours in my spare time and try to keep it up to date and working. THANK YOU!

📎 Menu

• 💡 Features
• 🚀 How to use
• 📚 Documentation
• 🔨 Developer Mode
• • 🏁 Run Project
• • 💾 Setup Project
• • 🚀 Deploy
• 👨‍💻 Contributing
• 🐛 Known Bugs
• 🍻 Community:
  • Telegram (🇬🇧 English | 🇮🇹 Italian)
  • Discord (🇬🇧 English | 🇮🇹 Italian | 🇵🇱 Polish)
  • Twitter

💡 Features

• [✔️] Easy to use
• [✔️] MIT License
• [✔️] Create a CLI package for npm
• [✔️] Friendly boilerplate + GitHub templates
• [✔️] TypeScript + TSPaths preconfigured
• [✔️] User-friendly folder tree
• [✔️] Prettier and ESLint preconfigured
• [✔️] all-contributors-cli and all-shields-cli preconfigured
• [✔️] Jest tests preconfigured
• [✔️] Full async code
• [✔️] GitHub and VS Code dotfiles preconfigured
• [✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

🚀 Usage

1. Install cli package globally: npm install @ptkdev/node-cli-boilerplate -g
2. Run anywhere: node-cli-boilerplate

You can use npx, example: npx @ptkdev/node-cli-boilerplate

🔨 Developer Mode

🏁 Run Project

1. Clone this repository or download nightly, beta or stable.
2. Run npm install
3. Run npm run dev for watch mode

If you want to try the CLI locally:

4. Run npm run release
5. Run npm link (on unix/mac use sudo npm link)
6. Run node-cli-boilerplate anywhere to execute the command line tool

To uninstall it, run npm unlink (on Unix/macOS use sudo npm unlink)

💾 Setup Project

If you want to replace all strings (e.g., package name, author, URLs, etc.) in Markdown files, source files, and other files in this project, edit setup.json with the correct values and run npm run setup.

🚀 Deploy

To create an npm package:

• Run npm run release
• Run npm publish

📚 Documentation

Run npm run docs

👑 Backers and Sponsors

Thanks to all our backers! 🙏 Donate $3 or more via PayPal, Ko-fi, or GitHub Sponsors, and send me an email with your avatar and URL.

👨‍💻 Contributing

I ❤️ contributions! I will happily accept your pull request! (IMPORTANT: Only to nightly branch!) Translations, grammatical corrections (GrammarNazi you are welcome! Yes my English is bad, sorry), etc... Do not be afraid, if the code is not perfect we will work together 👯 and remember to insert your name in .all-contributorsrc and package.json file.

Thanks goes to these wonderful people (emoji key):

Patryk Rzucidło 💻 🌍 📖 🐛

💰 In the future, if donations allow it, I would like to share some of the success with those who helped me the most. To me, open source means sharing code, sharing development knowledge, and sharing donations!

🦄 Other Projects

💫 License

• Code and Contributions have MIT License
• Images and logos have CC BY-NC 4.0 License
• Documentation and translations have CC BY 4.0 License

Copyleft (c) 2026 Patryk Rzucidło (@PTKDev) <support@ptkdev.io>