First release of the kroki CLI

[ggrossetie]

Usage

kroki convert hello.dot

By default the output format is svg and the diagram type is inferred from the file name. The above command is equivalent to:

kroki convert hello.dot --type dot --format svg

Read from stdin, output to stdout and use svg as the default output format.

cat hello.dot | kroki convert --type dot -

Read from stdin, output to out.png and use png as output format.

cat hello.dot | kroki convert --type dot -o out.png -

Read the file hello.dot and output to out.png.

kroki convert hello.dot -o out.png

Read the file hello.dot and output to stdout.

kroki convert hello.dot -o -

TODO

• Allow to configure the endpoint (ie. target URL)
  • From environment variable KROKI_ENDPOINT
  • From a config file $HOME/kroki.yml
  • From a config file /etc/kroki.yml
  • From a config file kroki.yml
• Allow to specify an alternate config file --config /path/to/kroki.yml
• Add tests 😅
• Allow to configure the out-file

[mcorbin]

you committed a main binary.

[mcorbin]

You could avoid global variables by defining the flags in the command:

var convertCmd = &cobra.Command{
	Use:           "convert file",
	Short:         "Convert text diagram to image",
        Flags: []cli.Flag{ 
        cli.StringFlag{
			Name:  "config",
			Usage: "description",
                         // use Value: "foo" for default values
         }
},

And then:

config := (cmd.String("config"))

[ggrossetie]

you committed a main binary.

Oops 😅

[mcorbin]

You don't need to name the return values, (kroki.GraphFormat, error) is enough.

[ggrossetie]

I thought it was mandatory, removed!
Named return values is "just" for documentation purpose ?

[mcorbin]

Yes, it's for documentation, and you can use them to avoid returning the values: https://tour.golang.org/basics/7

[ggrossetie]

@mcorbin I think we should use io.Reader and io.Writer abstraction to read the diagram source and write the result.
It's also easier to test as you can replace the Reader and/or the Writer with a Buffer.

I think kroki-go should provide the following functions:

func (c *Client) FromReader(reader io.Reader, diagramType DiagramType, imageFormat ImageFormat) (string, error) {}

func (c *Client) Write(writer io.Writer, result string) error {}

[ggrossetie]

@mcorbin Should be ready to go.

After this pull request is merged, I will make a few changes to kroki-go then release a new version and adjust the CLI code.