npmpackage.info

Gathering detailed insights and metrics for readme-md-cli

readme-md-cli

Automatically generate a readme for your project from the CLI.

0.19.1

MIT

JavaScript

130.06 kB

3.3

Installations

npm install readme-md-cli

Developer Guide

BETA

Typescript

No

Module System

ESM

Min. Node Version

^18.19.0 || >=20.5.0

Pull Requests

Open

0

Total

27

Closed

17

Merged

10

Issues

Open

0

Total

7

Closed

7

Releases

v0.19.1

Updated on Nov 22, 2024

v0.19.0

Updated on Oct 17, 2024

v0.18.0

Updated on Oct 12, 2024

v0.17.0

Updated on Oct 10, 2024

v0.16.0

Updated on Oct 07, 2024

v0.15.0

Updated on Oct 06, 2024

View All 9 releases

Languages

JavaScript

Shell

JavaScript (99.89%)

Shell (0.11%)

Developer

jbenner-radham

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Stars

341 Commits

1 Watchers

1 Branches

2 Contributors

Updated on Nov 22, 2024

Maintainers

View All 2 Contributors

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

Published on

Nov 22, 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

readme-md-cli

Automatically generate a readme for your project from the CLI.

Animated demo of readme-md

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`

License

The MIT License. See the license file for details.

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

License

Determines if the project has defined a license.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

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

0

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

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

0

SAST

Determines if the project uses static code analysis.

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.

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

Other packages similar to readme-md-cli

Other packages similar to readme-md-cli

readme-md-cli

Installations

Developer Guide

No

ESM

^18.19.0 || >=20.5.0

Pull Requests

0

27

17

10

Issues

0

7

7

Releases

Languages

Developer

jbenner-radham

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

readme-md-cli

Install

Usage

Testing

See Also

License

10

10

10

9

0

0

0

0

0

0

0

0

0

3.3

/10