Skip to content

Library to generate documentation for the command-line interface built using https://cli.urfave.org/

License

Notifications You must be signed in to change notification settings

nikhilsbhat/urfavecli-docgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UrFaveCli DocGen

Go Report Card shields shields shields

Library to generate documents for urfave-cli.

Introduction

This library would be helpful when generating Markdown documents for the command-line interfaces built using https://cli.urfave.org.

Installation

Get latest version of urfavecli-docgen using go get command. Example:

go get github.com/nikhilsbhat/urfavecli-docgen@latest

Get specific version of the same. Example:

go get github.com/nikhilsbhat/urfavecli-docgen@v0.0.2

Usage

package main

import (
	"fmt"
	"log"

	"github.com/nikhilsbhat/urfavecli-docgen"
)

func main() {
	appCli := cli.App{}

	if err := docgen.GenerateDocs(&appCli); err != nil {
		log.Fatalln(err)
	}
}

More examples can be found here.