config

Documentation

Index

• func AddLogin(login *Login) error
• func DeleteLogin(name string) error
• func GetConfigPath() string
• func SetDefaultLogin(name string) error
• type FlagDefaults
• type LocalConfig
• type Login
  • func GetDefaultLogin() (*Login, error)
  • func GetLoginByHost(host string) *Login
  • func GetLoginByName(name string) *Login
  • func GetLoginByToken(token string) *Login
  • func GetLogins() ([]Login, error)
  • func (l *Login) Client(options ...gitea.ClientOption) *gitea.Client
  • func (l *Login) GetSSHHost() string
• type Preferences
  • func GetPreferences() Preferences

Functions

func AddLogin

func AddLogin(login *Login) error

AddLogin save a login to config

func DeleteLogin

func DeleteLogin(name string) error

DeleteLogin delete a login by name from config

func GetConfigPath

func GetConfigPath() string

GetConfigPath return path to tea config file

func SetDefaultLogin

func SetDefaultLogin(name string) error

SetDefaultLogin set the default login by name (case insensitive)

Types

type FlagDefaults

type FlagDefaults struct {
	// Prefer a specific git remote to use for selecting a repository on gitea,
	// instead of relying on the remote associated with main/master/trunk branch.
	// The --remote flag still has precedence over this value.
	Remote string `yaml:"remote"`
}

FlagDefaults defines all flags that can be overridden with a default value via the config file

type LocalConfig

type LocalConfig struct {
	Logins []Login     `yaml:"logins"`
	Prefs  Preferences `yaml:"preferences"`
}

LocalConfig represents local configurations

type Login

type Login struct {
	Name    string `yaml:"name"`
	URL     string `yaml:"url"`
	Token   string `yaml:"token"`
	Default bool   `yaml:"default"`
	SSHHost string `yaml:"ssh_host"`
	// optional path to the private key
	SSHKey   string `yaml:"ssh_key"`
	Insecure bool   `yaml:"insecure"`
	// User is username from gitea
	User string `yaml:"user"`
	// Created is auto created unix timestamp
	Created int64 `yaml:"created"`
}

Login represents a login to a gitea server, you even could add multiple logins for one gitea server

func GetDefaultLogin

func GetDefaultLogin() (*Login, error)

GetDefaultLogin return the default login

func GetLoginByHost

func GetLoginByHost(host string) *Login

GetLoginByHost finds a login by it's server URL

func GetLoginByName

func GetLoginByName(name string) *Login

GetLoginByName get login by name (case insensitive)

func GetLoginByToken

func GetLoginByToken(token string) *Login

GetLoginByToken get login by token

func GetLogins

func GetLogins() ([]Login, error)

GetLogins return all login available by config

func (*Login) Client

func (l *Login) Client(options ...gitea.ClientOption) *gitea.Client

Client returns a client to operate Gitea API. You may provide additional modifiers for the client like gitea.SetBasicAuth() for customization

func (*Login) GetSSHHost

func (l *Login) GetSSHHost() string

GetSSHHost returns SSH host name

type Preferences

type Preferences struct {
	// Prefer using an external text editor over inline multiline prompts
	Editor       bool         `yaml:"editor"`
	FlagDefaults FlagDefaults `yaml:"flag_defaults"`
}

Preferences that are stored in and read from the config file

func GetPreferences

func GetPreferences() Preferences

GetPreferences returns preferences based on the config file