nullkey
6f8b825f5f
The `weknora` command-line client for the WeKnora RAG server. Full command surface: kb / doc / chunk / session / message / agent / model / search / chat / auth / profile / link / api / mcp / skills / config / doctor / schema / exit-codes. Agent-first wire contract: JSON envelope by default, typed error codes mapped to stable exit codes, error.retry_argv / retryable / partial-failure status, global --dry-run preview, the exit-10 confirmation protocol for writes, and control/ANSI/Bidi input hygiene. Stateless env-credential auth (WEKNORA_API_KEY / WEKNORA_TOKEN + WEKNORA_HOST) for headless/CI/agent use. A curated read-only MCP tool surface (`mcp serve`) and embedded Agent Skills (`skills install`). Extensive unit + contract-golden tests and CI.
82 lines
2.5 KiB
Go
82 lines
2.5 KiB
Go
// Package config reads and writes the user-level config at
|
|
// $XDG_CONFIG_HOME/weknora/config.yaml. yaml.v3 directly; viper is
|
|
// intentionally not used. Multi-host profile map lives here;
|
|
// the per-project link (.weknora/project.yaml) is handled by the
|
|
// projectlink package.
|
|
package config
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
|
|
"gopkg.in/yaml.v3"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/xdg"
|
|
)
|
|
|
|
// Config is the on-disk schema. Empty zero-value is valid (returned when the
|
|
// file does not exist) so commands like --help / version don't fail.
|
|
type Config struct {
|
|
CurrentProfile string `yaml:"current_profile,omitempty"`
|
|
Profiles map[string]Profile `yaml:"profiles,omitempty"`
|
|
|
|
// Defaults holds CLI-wide defaults; fields opt-in.
|
|
Defaults struct {
|
|
Format string `yaml:"format,omitempty"`
|
|
NoVersionCheck bool `yaml:"no_version_check,omitempty"`
|
|
} `yaml:"defaults,omitempty"`
|
|
}
|
|
|
|
// Profile is one named connection target (host + tenant + credential reference).
|
|
type Profile struct {
|
|
Host string `yaml:"host"`
|
|
TenantID uint64 `yaml:"tenant_id,omitempty"`
|
|
User string `yaml:"user,omitempty"`
|
|
APIKeyRef string `yaml:"api_key_ref,omitempty"` // keychain://... or file://...
|
|
TokenRef string `yaml:"token_ref,omitempty"` // keychain://... or file://...
|
|
RefreshRef string `yaml:"refresh_token_ref,omitempty"`
|
|
DefaultKBID string `yaml:"default_kb_id,omitempty"`
|
|
}
|
|
|
|
// ErrCorrupt is returned by Load when the file exists but cannot be parsed.
|
|
// Callers should map this to error code "local.config_corrupt".
|
|
var ErrCorrupt = errors.New("config: file is malformed")
|
|
|
|
// Path returns the absolute config file path.
|
|
// Honors XDG_CONFIG_HOME via internal/xdg.
|
|
func Path() (string, error) {
|
|
return xdg.Path("XDG_CONFIG_HOME", ".config", "config.yaml")
|
|
}
|
|
|
|
// Load reads the config file. If it does not exist, returns a zero-value
|
|
// Config with no error (commands like `version` and `--help` must not fail
|
|
// just because the user has not run `auth login` yet).
|
|
func Load() (*Config, error) {
|
|
p, err := Path()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
data, err := os.ReadFile(p)
|
|
if errors.Is(err, os.ErrNotExist) {
|
|
return &Config{}, nil
|
|
}
|
|
if err != nil {
|
|
return nil, fmt.Errorf("read config: %w", err)
|
|
}
|
|
var c Config
|
|
if err := yaml.Unmarshal(data, &c); err != nil {
|
|
return nil, fmt.Errorf("%w: %v", ErrCorrupt, err)
|
|
}
|
|
return &c, nil
|
|
}
|
|
|
|
// Save writes the config atomically with mode 0600 via internal/xdg.WriteAtomicYAML.
|
|
func Save(c *Config) error {
|
|
p, err := Path()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return xdg.WriteAtomicYAML(p, c)
|
|
}
|