package
0.28.4
Repository: https://github.com/solo-io/go-utils.git
Documentation: pkg.go.dev

# README

Generate standard Solo.io documentation from Cobra CLIs

  • Takes the entry point to a Cobra CLI (the root *cobra.CMD) and produces files formatted for Solo's online documentation

Example usage

  • from Squash:
package main

import (
	"log"

	"github.com/solo-io/go-utils/clidoc"

	"github.com/solo-io/squash/pkg/squashctl"
	"github.com/solo-io/squash/pkg/version"
)

func main() {
	app, err := squashctl.App(version.Version)
	if err != nil {
		log.Fatal(err)
	}
	clidoc.MustGenerateCliDocs(app)
}

# Functions

deprecated, use GenerateCliDocsWithConfig.
GenerateCliDocs is the official way to convert Solo.io's command line tools to online documentation.
MustGenerateCliDocs is the same as GenerateCliDocs but it exits with status 1 on error.

# Variables

this config represents the latest/best practices for doc generation.

# Structs

No description provided by the author