Skip to content

Shukaaa/swerr-cli

Repository files navigation

Swerr CLI

Swerr CLI is a command-line interface tool designed to easily create error documentation / catelogs for your projects.
With the magic of JSDoc comments and Swerr, you can generate comprehensive error documentation in just a few simple steps.

Installation

To install Swerr CLI, use npm:

npm install -g @swerr/cli

Usage

First of all, you need a swerr.config.js file in your project root. You can create one manually or run:

swerr init

Once you have your configuration file set up, you can run the swerr configuration with:

swerr run

This command will generate the error documentation based on your JSDoc comments and the settings in your swerr.config.js file.

Documentation

https://swerr.apidocumentation.com

About

(WIP) Swagger but for errors. Generate schemes from projects and turn them into doc pages or other file formats.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors