toml

Documentation

Index

• func TOML(key string, paths ...string) cli.ValueSourceChain

Examples

• TOML

Functions

func TOML

func TOML(key string, paths ...string) cli.ValueSourceChain

TOML is a helper function to encapsulate a number of tomlValueSource together as a cli.ValueSourceChain

Example

package main

import (
	"context"
	"fmt"
	"os"
	"path/filepath"
	"time"

	toml "github.com/urfave/cli-altsrc/toml"
	altsrc "github.com/urfave/cli-altsrc/v3"
	"github.com/urfave/cli/v3"
)

var (
	testdataDir = func() string {
		ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
		defer cancel()

		return altsrc.MustTestdataDir(ctx)
	}()
)

func main() {
	configFiles := []string{
		filepath.Join(testdataDir, "config.toml"),
		filepath.Join(testdataDir, "alt-config.toml"),
	}

	app := &cli.Command{
		Name: "greet",
		Flags: []cli.Flag{
			&cli.StringFlag{
				Name:    "name",
				Aliases: []string{"n"},
				Sources: toml.TOML("greet.name", configFiles...),
			},
			&cli.IntFlag{
				Name:    "enthusiasm",
				Aliases: []string{"!"},
				Sources: toml.TOML("greet.enthusiasm", configFiles...),
			},
		},
		Action: func(ctx context.Context, cmd *cli.Command) error {
			punct := ""
			if cmd.Int("enthusiasm") > 9000 {
				punct = "!"
			}

			fmt.Fprintf(os.Stdout, "Hello, %[1]v%[2]v\n", cmd.String("name"), punct)

			return nil
		},
	}

	// Simulating os.Args
	os.Args = []string{"greet"}

	if err := app.Run(context.Background(), os.Args); err != nil {
		fmt.Fprintf(os.Stdout, "OH NO: %[1]v\n", err)
	}

}

Output:

Hello, Berry!