nullkey
f2e8e3f56c
Survey of 10 mainstream CLIs (gh, lark, stripe, vercel, supabase, aws, azure, gcloud, openai/codex, github-copilot-cli) showed env-gated per-command --help blurbs are a Stripe-only pattern; gh uses env detect for telemetry only, and lark relies on installed agent Skills + MCP. Our cmd/mcp/serve already covers the dominant 2025/26 path, so internal/aiclient/ (136 LOC + 38 callsites) is net maintenance burden without precedent. - Drop internal/aiclient/ entirely (annotations + detect + tests) - Remove 38 SetAgentHelp callsites + agentAwareHelpFunc / SetHelpFunc wiring in cmd/root.go - Migrate 4 command-level rules to standard Long help (visible to all, not env-gated): doc upload mode mutex, kb edit at-least-one, kb pin idempotent, search chunks channel mutex - Rewrite AGENTS.md as a developer guide (gh-style 6 H2 / 167 lines): audience preamble + Build / Architecture / Command Structure / Testing / Code Style / Error Handling. Drops sections absent in surveyed projects (Commit & PR Conventions, Who Uses This CLI) - Clean 14 internal doc refs (ADR-N, spec §X, v0.X) in source comments and docs that pointed at docs/superpowers/ — that directory is local-only / uncommitted, so refs are dead for outside readers - Drop forward-looking "once v0.2 ships" from README
83 lines
2.6 KiB
Go
83 lines
2.6 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 context 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 {
|
|
CurrentContext string `yaml:"current_context,omitempty"`
|
|
Contexts map[string]Context `yaml:"contexts,omitempty"`
|
|
|
|
// Defaults holds CLI-wide defaults; fields opt-in.
|
|
Defaults struct {
|
|
Format string `yaml:"format,omitempty"`
|
|
NoVersionCheck bool `yaml:"no_version_check,omitempty"`
|
|
RequestIDPrefix string `yaml:"request_id_prefix,omitempty"`
|
|
} `yaml:"defaults,omitempty"`
|
|
}
|
|
|
|
// Context is one named connection target (host + tenant + credential reference).
|
|
type Context 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)
|
|
}
|