Help us shape the future of Go! Take the 2026 Go Developer Survey

config

package
v1.30.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 30, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package config provides subcommands for managing the eng CLI configuration. It allows users to view and modify settings stored in the $HOME/.eng.yaml file.

Index

Constants

This section is empty.

Variables

View Source
var ConfigCmd = &cobra.Command{
	Use:   "config",
	Short: "Manage the cli's config file.",
	Long: `This command is used to facilitate the management of the config file specific to this cli.

It should be located at $HOME/.eng.yaml`,
	Run: func(cmd *cobra.Command, _args []string) {

		config.Email()
		config.DotfilesRepo()
		config.RepoURL()
		config.Branch()
		config.BareRepoPath()
		config.GitDevPath()
		config.Verbose()
	},
}

ConfigCmd represents the base command for all configuration related operations.

View Source
var DotfilesBareRepoPathCmd = &cobra.Command{
	Use:   "dotfiles-bare-repo-path",
	Short: "Update config dotfiles bare repo path",
	Long:  `Get or set the path where the bare dotfiles repository should be stored.`,
	Run: func(cmd *cobra.Command, args []string) {
		config.BareRepoPath()
	},
}

DotfilesBareRepoPathCmd represents the command to manage the bare repository path configuration.

View Source
var DotfilesBranchCmd = &cobra.Command{
	Use:   "dotfiles-branch",
	Short: "Update config dotfiles branch",
	Long:  `Get or set the dotfiles branch (main/work/server) in the configuration file.`,
	Run: func(cmd *cobra.Command, _args []string) {
		config.Branch()
	},
}

DotfilesBranchCmd represents the command to manage the dotfiles branch configuration.

View Source
var DotfilesRepoCmd = &cobra.Command{
	Use:   "dotfiles-repo",
	Short: "Update config dotfiles repo path",
	Long:  `This command sets the path to the local dotfiles repository in the config file.`,
	Run: func(cmd *cobra.Command, args []string) {
		log.Start("Checking for dotfile repo path in config file...")
		config.DotfilesRepo()
	},
}

DotfilesRepoCmd defines the command for setting the local dotfiles repository path.

View Source
var DotfilesRepoURLCmd = &cobra.Command{
	Use:   "dotfiles-repo-url",
	Short: "Update config dotfiles repo URL",
	Long:  `Get or set the dotfiles repository URL in the configuration file.`,
	Run: func(cmd *cobra.Command, args []string) {
		config.RepoURL()
	},
}

DotfilesRepoURLCmd represents the command to manage the dotfiles repository URL configuration.

View Source
var EditCmd = &cobra.Command{
	Use:   "edit",
	Short: "Interactively edit the eng CLI configuration",
	Long: `Launch a beautiful TUI wizard to easily update your .eng.yaml configuration settings.

By default, this command launches the interactive editor. Use --interactive=false if you want to bypass the wizard in the future (though currently, the interactive editor is the primary function of this command).`,
	RunE: func(cmd *cobra.Command, args []string) error {
		if !interactiveMode {

			return config.RunInteractiveEditor()
		}
		return config.RunInteractiveEditor()
	},
}

EditCmd represents the edit command.

View Source
var EmailCmd = &cobra.Command{
	Use:   "email",
	Short: "Update config email",
	Long:  `This command should validate and update the email config.`,
	Run: func(cmd *cobra.Command, args []string) {
		log.Start("Checking for email in config file...")
		config.Email()
	},
}

EmailCmd defines the command for setting the user's email in the configuration.

View Source
var GitDevPathCmd = &cobra.Command{
	Use:   "git-dev-path",
	Short: "Update config git dev path",
	Long:  `This command sets the path to the development folder containing git repositories in the config file.`,
	Run: func(cmd *cobra.Command, _args []string) {
		log.Start("Checking for development folder path in config file...")
		config.GitDevPath()
	},
}

GitDevPathCmd defines the command for setting the development folder path.

View Source
var VerboseCmd = &cobra.Command{
	Use:   "verbose",
	Short: "Update config verbose setting",
	Long:  `This command should validate and update the verbose config setting.`,
	Run: func(cmd *cobra.Command, _args []string) {
		log.Start("Checking for verbose setting in config file...")
		config.Verbose()
	},
}

VerboseCmd defines the command for managing the verbose output setting.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL