| 1 | import type { DocsConfigurationDict } from "../types"; |
| 2 | |
| 3 | export const docsConfiguration: DocsConfigurationDict = { |
| 4 | metaTitle: "Configuration · Codewhale Docs", |
| 5 | metaDescription: |
| 6 | "Where config.toml is read from, the per-project overlay, credential precedence, and legacy path migration.", |
| 7 | bodyClassName: "text-ink-soft leading-relaxed", |
| 8 | overviewTitle: "Configuration", |
| 9 | overviewLead: |
| 10 | "Codewhale reads its configuration from ~/.codewhale/config.toml (the legacy ~/.deepseek/config.toml is still read as a fallback). The --config flag and the CODEWHALE_CONFIG_PATH environment variable can point elsewhere; --config wins when both are set, and environment variable overrides are applied after the file is loaded.", |
| 11 | auditLead: |
| 12 | "Inside the TUI, {auditCommand} shows which documented keys can change in the current session, which can also be persisted, and which stay file-only or restart-only — treat its “Command / reason” column as the source of truth before editing by hand.", |
| 13 | overlayTitle: "Per-project overlay", |
| 14 | overlayLead: |
| 15 | "When a workspace contains a regular-file <workspace>/.codewhale/config.toml, the safe values it declares are merged on top of the global config (legacy <workspace>/.deepseek/config.toml files are still read when the Codewhale path is absent; symlinked project configs are rejected). This lets a repository suggest a model or tighten the local safety posture without touching the user's global config. Pass --no-project-config to skip the overlay for one launch.", |
| 16 | overlayLimits: |
| 17 | "The overlay is intentionally narrow: it supports model, reasoning_effort, approval_policy and sandbox_mode (tightening values only), notes_path, max_subagents (clamped to 1..=20), and allow_shell (false applies, true is ignored). Credentials, endpoints, provider selection, MCP config, hooks, skills, and instructions = [...] stay user-global — a repo-local config.toml that declares api_key, base_url, or provider is ignored, so a cloned repository cannot pick arbitrary local files into the prompt.", |
| 18 | credentialsTitle: "Credential lookup", |
| 19 | credentialsLead: |
| 20 | "After any explicit {apiKey}, credentials resolve in config → keyring → env order. {authStatus} inspects the active provider's config file, OS keyring backend, environment variable, winning source, and last-four label without printing the key itself. Hosted, generic OpenAI-compatible, self-hosted, or native Anthropic routes are selected with {providerConfig} or {providerFlag}; the full registry lives on the Models & providers page and in docs/PROVIDERS.md.", |
| 21 | legacyTitle: "Legacy .deepseek/ paths", |
| 22 | legacyLead: |
| 23 | "Codewhale was renamed from DeepSeek-TUI. To avoid breaking existing installs, the runtime reads state from the new ~/.codewhale/ location but falls back to ~/.deepseek/ when only the legacy directory exists, and always writes to ~/.codewhale/ — read-with-fallback, write-to-new. State-dir resolution is consolidated in resolve_state_dir / ensure_state_dir in crates/config/src/lib.rs, and every legacy path reference carries an audited keep decision.", |
| 24 | sourceNote: |
| 25 | "Source documents: docs/CONFIGURATION.md, docs/LEGACY_PATHS.md · Update docs-map.ts when changing.", |
| 26 | }; |
| 27 |