config

package

v0.0.4 Latest Latest Go to latest Published: Jun 5, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/andy-neoaira/obs-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CliPath() (cliConfigDir string, cliConfigFile string, err error)
func ObsidianFile() (obsidianConfigFile string, err error)
func RunningInWSL() bool

Constants ¶

View Source

const (
	UserConfigDirectoryNotFoundErrorMessage = "User config directory not found"
	ObsidianConfigDirectory                 = "obsidian"
	ObsidianConfigFile                      = "obsidian.json"
	ObsCLIConfigDirectory                   = "obs-cli"
	ObsCLIConfigFile                        = "preferences.json"
)

Variables ¶

View Source

var ExecCommand = func(name string, args ...string) ([]byte, error) {
	return exec.Command(name, args...).Output()
}

ExecCommand 是包级变量，指向 exec.Command(...).Output() 的调用。使用变量方便在测试中替换为 Mock 实现。

View Source

var UserConfigDirectory = os.UserConfigDir

UserConfigDirectory 是一个包级变量，指向 os.UserConfigDir 函数。使用变量而非直接调用，方便在测试中替换为 Mock 实现。

View Source

var (
	WslInteropFile = "/proc/sys/fs/binfmt_misc/WSLInterop"
)

WslInteropFile 是 WSL 环境的标志性文件路径，用于检测是否在 WSL 中运行。

Functions ¶

func CliPath ¶

func CliPath() (cliConfigDir string, cliConfigFile string, err error)

CliPath 返回 CLI 自身配置目录和配置文件的完整路径。配置目录遵循操作系统标准：

Linux/Mac: ~/.config/obs-cli/
Windows: %APPDATA%\obs-cli\

func ObsidianFile ¶

func ObsidianFile() (obsidianConfigFile string, err error)

ObsidianFile 返回 Obsidian 官方配置文件（obsidian.json）的完整路径。它会尝试多个候选路径，以支持不同安装方式（原生、Flatpak、Snap、WSL 等）。

func RunningInWSL ¶

func RunningInWSL() bool

RunningInWSL 检测当前是否在 Windows Subsystem for Linux (WSL) 环境中运行。

Types ¶

This section is empty.

Source Files ¶

View all Source files

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