Package Health Score

66 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.13.21	\|	03/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.12.3	\|	08/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.11.4	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.10.4	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.9.13	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (66,888)

GitHub Stars: 23.3K
Forks: 2.29K
Contributors: -

Direct Usage Popularity

The npm package redoc-cli receives a total of 66,888 downloads a week. As such, we scored redoc-cli popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package redoc-cli, we found that it has been starred 23,299 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like redoc-cli is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 342
Open PR: 16
Last Release: 2 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of redoc-cli based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for redoc-cli is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12.0.0

Age: 7 years
Dependencies: 11 Direct
Versions: 78
Install Size: 261 kB
Dist-tags: 1
# of Files: 7
Maintainers: 2
TS Typings: No

redoc-cli has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

redoc-cli

DEPRECATED: this package is deprecated. Use npx @redocly/cli build-docs instead.

ReDoc's Command Line Interface

Installation

You can use redoc-cli by installing the package globally, or using npx.

Usage

The two following commands are available:

redoc-cli serve [spec] - starts the server with spec rendered with ReDoc. Supports a server-side rendering mode (--ssr) and can watch the spec (--watch) to automatically reload the page whenever it changes.
Deprecated. Use npx @redocly/cli preview-docs [spec]
redoc-cli bundle [spec] - bundles spec and Redoc into a zero-dependency HTML file.
Deprecated. Use Use "build" command instead.
redoc-cli build [spec] - build spec and Redoc into a zero-dependency HTML file.

Some examples:

Bundle with the main color changed to orange:
$ redoc-cli build [spec] --options.theme.colors.primary.main=orange
Serve with the nativeScrollbars option set to true:
$ redoc-cli serve [spec] --options.nativeScrollbars
Bundle using a custom Handlebars template (check the default template for an example):
$ redoc-cli build [spec] -t custom.hbs
Bundle using a custom template and add custom templateOptions:
$ redoc-cli build [spec] -t custom.hbs --templateOptions.metaDescription "Page meta description"

With a Redocly configuration file (more info):

Go to folder with your Redocly configuration file (.redocly.yaml or redocly.yaml) and your OpenAPI definition file.
Build the site using the build command (options from the Redocly configuration file will be automatically fetched):
redoc build openapi.yaml

For more details, run redoc-cli --help.

redoc-cli dependencies

boxen chokidar handlebars mkdirp mobx node-libs-browser react react-dom redoc styled-components yargs

redoc-cli development dependencies

@types/mkdirp

FAQs

What is redoc-cli?

ReDoc's Command Line Interface. Visit Snyk Advisor to see a full health score report for redoc-cli, including popularity, security, maintenance & community analysis.

Is redoc-cli popular?

The npm package redoc-cli receives a total of 66,888 weekly downloads. As such, redoc-cli popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is redoc-cli well maintained?

We found indications that redoc-cli is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is redoc-cli safe to use?

The npm package redoc-cli was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 September-2024, at 04:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

redoc-cli

ReDoc's Command Line Interface For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (66,888)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

redoc-cli

Installation

Usage

With a Redocly configuration file (more info):

redoc-cli dependencies

redoc-cli development dependencies

FAQs

What is redoc-cli?

Is redoc-cli popular?

Is redoc-cli well maintained?

Is redoc-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (66,888)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

redoc-cli

Installation

Usage

With a Redocly configuration file (more info):

redoc-cli dependencies

redoc-cli development dependencies

FAQs

What is redoc-cli?

Is redoc-cli popular?

Is redoc-cli well maintained?

Is redoc-cli safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues