config

package

Go to main page

Versions in this module

v0

v0.2.1

Jan 4, 2025

Changes in this version

+ var EnvKeyNexusUrlGetFilesFormat = "NEXUS_URL_GET_FILES_FORMAT"

+ var FlagNexusUrlGetModFilesFormat = &cli.StringFlag

+ var YamlKeyNexusUrlGetFilesFormat = "nexus_url_get_files_format"

v0.2.0

Jan 1, 2025

Changes in this version

+ var EnvKeyLlmApiKey = "LLM_API_KEY"

+ var EnvKeyLlmModelName = "LLM_MODEL_NAME"

+ var EnvKeyLlmProvider = "LLM_PROVIDER"

+ var FlagLlmApiKey = &cli.StringFlag

+ var FlagLlmModelName = &cli.StringFlag

+ var FlagLlmProvider = &cli.GenericFlag

+ var LLMCategory = "LLM"

+ var YamlKeyLlmApiKey = "llm_api_key"

+ var YamlKeyLlmModelName = "llm_model_name"

+ var YamlKeyLlmProvider = "llm_provider"

type EnumValue

+ func (e *EnumValue[T]) Value() T

type MarkxusConfig

+ Llm struct{ ... }

+ type Provider string

+ var ProviderGenAi Provider = "gen_ai"

+ var ProviderOpenAi Provider = "open_ai"

v0.1.8

Jan 1, 2025

v0.1.7

Jan 1, 2025

v0.1.6

Jan 1, 2025

v0.1.5

Dec 31, 2024

Changes in this version

+ const Version

+ var AllFlags = []cli.Flag

+ var ConfigPathGlobal = ...()

+ var ConfigPathLocal = ...()

+ var EnvKeyFallbackGameCode = "FALLBACK_GAME_CODE"

+ var EnvKeyGenAiApiKey = "GEN_AI_API_KEY"

+ var EnvKeyGenAiModelName = "GEN_AI_MODEL_NAME"

+ var EnvKeyMarkdownHeaderFormat = "MARKDOWN_HEADER_FORMAT"

+ var EnvKeyMarkxusPromptFormat = "GEN_AI_PROMPT_FORMAT"

+ var EnvKeyMarkxusUrlModPageFormat = "NEXUS_URL_MOD_PAGE_FORMAT"

+ var EnvKeyNexusApiKey = "NEXUS_API_KEY"

+ var EnvKeyNexusUrlGetModFormat = "NEXUS_URL_GET_MOD_FORMAT"

+ var EnvKeyOutputDir = "OUTPUT_DIR"

+ var EnvKeyOverwriteOutput = "OVERWRITE_OUTPUT"

+ var FlagConfigType = &cli.GenericFlag

+ var FlagFallbackGameCode = &cli.StringFlag

+ var FlagGenAiApiKey = &cli.StringFlag

+ var FlagGenAiModelName = &cli.StringFlag

+ var FlagMarkdownHeaderFormat = &cli.StringFlag

+ var FlagMarkxusPromptFormat = &cli.StringFlag

+ var FlagMarkxusUrlModPageFormat = &cli.StringFlag

+ var FlagNexusApiKey = &cli.StringFlag

+ var FlagNexusUrlGetModFormat = &cli.StringFlag

+ var FlagOutputDir = &cli.StringFlag

+ var FlagOverwriteOutput = &cli.BoolFlag

+ var GenAICategory = "GenAI"

+ var GenerationCategory = "Markdown"

+ var HelperCategory = "Helper"

+ var KeyringSource = &keyringSource

+ var NexusCategory = "Nexus"

+ var YamlKeyCategoryIconMap = "category_icon_map"

+ var YamlKeyFallbackGameCode = "fallback_game_code"

+ var YamlKeyGenAiApiKey = "genai_api_key"

+ var YamlKeyGenAiModelName = "genai_model_name"

+ var YamlKeyMarkdownHeaderFormat = "markdown_header_format"

+ var YamlKeyMarkxusPromptFormat = "genai_prompt_format"

+ var YamlKeyMarkxusUrlModPageFormat = "nexus_url_mod_page_format"

+ var YamlKeyNexusApiKey = "nexus_api_key"

+ var YamlKeyNexusUrlGetModFormat = "nexus_url_get_mod_format"

+ var YamlKeyOutputDir = "output_dir"

+ var YamlKeyOverwriteOutput = "overwrite_output"

+ var YamlSourceGlobal = NewYamlSource(ConfigPathGlobal)

+ var YamlSourceGlobalError = NewYamlSource(ConfigPathGlobal)

+ var YamlSourceLocal = NewYamlSource(ConfigPathLocal)

+ var YamlSourceLocalError = NewYamlSource(ConfigPathLocal)

+ func ConfigCategoryIconMap(gameCode string) []markxus.CategoryIconMap

+ func ConfigPath(configType ConfigType) string

+ func CreateDefaultConfig() map[string]any

+ func EnvToYaml(key string) string

+ func Resolve(envKey string) any

+ func ResolveFromYaml(configType ConfigType, yamlKey string) any

+ func SetKeyring(key string, value string) error

+ func YamlToEnv(key string) string

+ type ConfigType string

+ var ConfigTypeGlobal ConfigType = "global"

+ var ConfigTypeLocal ConfigType = "local"

+ type EnumValue struct

+ Default T

+ Enum []T

+ func (e *EnumValue[T]) Get() any

+ func (e *EnumValue[T]) Selected() T

+ func (e *EnumValue[T]) Set(value string) error

+ func (e *EnumValue[T]) String() string

+ type KV map[string]any

+ func NewYamlSource(path string) (KV, error)

+ func (s KV) GoString() string

+ func (s KV) Lookup(key string) (any, bool)

+ func (s KV) String() string

+ type MarkxusConfig struct

+ Common struct{ ... }

+ GenAi struct{ ... }

+ Generation struct{ ... }

+ Helper struct{ ... }

+ Nexus struct{ ... }

+ var Config MarkxusConfig

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