Gathering detailed insights and metrics for readme-md-cli
Gathering detailed insights and metrics for readme-md-cli
Automatically generate a readme for your project from the CLI.
Installations
npm install readme-md-cliDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
^18.19.0 || >=20.5.0
Releases
9
Languages
2
JavaScript
Shell
JavaScript (99.89%)
Shell (0.11%)
Developer
jbenner-radham
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
2 Stars
341 Commits
1 Watchers
1 Branches
2 Contributors
Updated on Nov 22, 2024
Maintainers
1
Package Meta Information
Latest Version
0.19.1
Package Id
readme-md-cli@0.19.1
Unpacked Size
130.06 kB
Size
92.04 kB
File Count
46
Published on
Nov 22, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
11
readme-md-cli
Automatically generate a readme for your project from the CLI.
Install
1yarn global add readme-md-cli # Or alternatively: `npm install --global readme-md-cli`
Usage
1$ readme-md --help 2 3 Automatically generate a readme for your project from the CLI. 4 5 Usage 6 $ readme-md [init] 7 8 Options 9 --help, -h Display this message. 10 --non-interactive, -n Run in non-interactive mode. 11 --version, -v Display the application version. 12 13 When invoked with the "init" sub-command a project level runtime 14 configuration is initialized.
For more detailed information see the doc directory or view the project's config directory for example usage.
For example output this README.md is entirely self generated by this package.
Testing
1yarn test # Or alternatively: `npm test`
See Also
License
The MIT License. See the license file for details.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
1 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/jbenner-radham/node-readme-md-cli/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/jbenner-radham/node-readme-md-cli/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/jbenner-radham/node-readme-md-cli/ci.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/jbenner-radham/node-readme-md-cli/ci.yaml/main?enable=pin
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Info: no jobLevel write permissions found
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Score
3.3
/10
Last Scanned on 2025-07-07
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