corona10 / fuego

fuego is a library for automatically generating command line interfaces (CLIs) from function and struct.

fuego

Inspired by Google python-fire

fuego is a library for automatically generating command line interfaces (CLIs) from function and struct.

Features

• fuego is a simple way to create a CLI in Go.
• fuego helps with exploring existing code or turning other people's code into a CLI. [1]
• fuego shows documentation of each method or functions for help.

Installation

go get github.com/corona10/fuego

TODO

• Support flag options
• More error handling
• Support more types

Examples

package main

import (
	"fmt"

	"github.com/corona10/fuego"
)

func Add(a int, b int) (int, int) {
	fmt.Println(a, b)
	return a + b, 2*a + b
}

func main() {
	fuego.Fire(Add)
}

package main

import (
	"fmt"

	"github.com/corona10/fuego"
)

type Sample struct {
	Name string
}

func (s Sample) Add(a, b int) int {
	return a + b
}

func (s Sample) Minus(a, b int) int {
	return a - b
}

func (s Sample) HelloWorld() {
	fmt.Println(s.Name)
	fmt.Println("Hello world!")
}

func main() {
	var s Sample
	s.Name = "test"
	fuego.Fire(s)
}

Special thanks to

• Haeun Kim
• Sebastien Binet: The contributor who proposed the name fuego.

fuego's Issues

Error handling is needed

For example,

package main

import (
	"fmt"

	"github.com/corona10/fuego"
)

type Sample struct {
	Name string
}

func (s Sample) Add(a, b int) int {
	return a + b
}

func (s Sample) Minus(a, b int) int {
	return a - b
}

func (s Sample) HelloWorld() {
	fmt.Println(s.Name)
	fmt.Println("Hello world!")
}

func main() {
	var s Sample
	s.Name = "test"
	fuego.Fire(s)
}

go run example2.go do not

This should be handled as an error and should not be succeeded.
Due to this line of codes https://github.com/corona10/fuego/blob/master/sym.go#L33
There are no error handlings for wrong types, it should be added.

Pretty help command

The current command list is not pretty.
We need to improve it as much as python-fire

No updates for a year

Is project still being supported? Or maybe it became proprietary?

Package level documentation extraction should be supported.

package main

import (
	"github.com/corona10/fuego"
	"github.com/corona10/goimghdr"
)

func main() {
	fuego.Fire(goimghdr.What)
}

This code is able to run through fuego.
but fail to extract documentation from the package.
This issue should be solved.

$ go run example4.go 
Usage of example4:
example4 string -> Documentation of What should be found from AST information.

Need refactoring

Codes are too dirty and lots of duplicated codes.

DocString for command lists.

When fuego show command lists.
It only shows command and function/methods parameters.

Usage:  example2
example2 Add int int -> Add is a method for the sum of two values.

If fuego can show this way, it would be great.