npmpackage.info

Gathering detailed insights and metrics for @ptkdev/node-cli-boilerplate

@ptkdev/node-cli-boilerplate - 3.0.3 | npmpackage.info

@ptkdev/node-cli-boilerplate

🪓 Create node cli with this user friendly boilerplate

3.0.3

NOASSERTION

TypeScript

40.64 kB

3.3

Installations

npm install @ptkdev/node-cli-boilerplate

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18.0.0

Node Version

20.13.1

NPM Version

10.5.2 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

1

Total

2

Closed

1

Releases

v3.0.3

3.0.3

Updated on Jun 03, 2024

v2.0.3

2.0.3

Updated on Apr 05, 2022

v2.0.2

2.0.2

Updated on Feb 20, 2022

v2.0.1

2.0.1

Updated on Jan 16, 2022

v2.0.0

2.0.0

Updated on Jan 16, 2022

v1.0.20210930

1.0.20210930

Updated on Sep 29, 2021

View All 10 releases

Languages

TypeScript

JavaScript

Smarty

Shell

TypeScript (81.69%)

JavaScript (12.5%)

Smarty (5.02%)

Shell (0.79%)

Developer

ptkdev-boilerplate

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

26 Stars

545 Commits

3 Forks

2 Watchers

3 Branches

1 Contributors

Updated on May 11, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

3.0.3

Package Id

@ptkdev/node-cli-boilerplate@3.0.3

Unpacked Size

40.64 kB

Size

12.03 kB

File Count

NPM Version

10.5.2

Node Version

20.13.1

Published on

Jun 03, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

🪓 node-cli-boilerplate

Create node cli with this user friendly boilerplate. Use this respository as template for your new npm command line interface project

This is a github template, you can fork it or use as template for start new project with this repository as hello-world. I hate start new project with empty template, often i missing correct configuration, readme instruction or i need of samples of code. Use this repository as template solve this 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
[✔️] Make CLI Package for npm
[✔️] Friendly boilerplate + Github templates
[✔️] Typescript + TSPaths preconfigured
[✔️] Userfriendly folders tree
[✔️] Prettiers and ESLint preconfigured
[✔️] all-contributors-cli and all-shields-cli preconfigured
[✔️] JEST Test preconfigured
[✔️] Full async code
[✔️] Github and Vscode dotfiles preconfigured
[✔️] Translations: 🇬🇧 🇮🇹 🇵🇱 (Help me ❤️)

🚀 Usage

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

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

🔨 Developer Mode

🏁 Run Project

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

If you want to try cli locally:

Run npm run release
Run npm link (on unix/mac use sudo npm link)
Run node-cli-boilerplate anywhere for execute command line tool

For uninstall it run npm unlink (on unix/mac use sudo npm unlink)

💾 Setup Project

If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit setup.json with correct values and run npm run setup.

🚀 Deploy

For create 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 on paypal, ko-fi or github and send me 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 the donations allow it, I would like to share some of the success with those who helped me the most. For me open source is share of code, share development knowledges and share donations!

🦄 Other Projects

💫 License

Code and Contributions have MIT License
Images and logos have CC BY-NC 4.0 License
Documentations and Translations have CC BY 4.0 License

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

9

License

Determines if the project has defined a license.

6

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/beta.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/beta.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/beta.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/beta.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/main.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/main.yml/nightly?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/main.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/nightly.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/nightly.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/release.yml/nightly?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/ptkdev-boilerplate/node-cli-boilerplate/release.yml/nightly?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 4 out of 4 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.3

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@ptkdev/node-cli-boilerplate

Installations

Developer Guide

Yes

ESM

>=18.0.0

20.13.1

10.5.2

Pull Requests

0

0

0

Issues

1

2

1

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

🪓 node-cli-boilerplate

🎁 Support: Donate

📎 Menu

💡 Features

🚀 Usage

🔨 Developer Mode

🏁 Run Project

💾 Setup Project

🚀 Deploy

📚 Documentation

👑 Backers and Sponsors

👨‍💻 Contributing

🦄 Other Projects

💫 License

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

10

10

10

9

6

0

0

0

0

0

0

0

0

0

3.3

/10