KOSMOS/.env.example at main · umyunsang/KOSMOS · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# KOSMOS environment template
# Copy to `.env` (which is a gitignored symlink to your secrets store) and fill in values.
# See docs/configuration.md for the authoritative registry.
# All `<redacted>` placeholders must be replaced with real values before running.
#
# Format note: inline `# ...` on the same line as a value is NOT treated as a
# comment by `src/kosmos/_dotenv.py` — the parser strips quotes but does not
# strip trailing `#` comments. Keep all commentary on its own line ABOVE the
# key so that a bare `cp .env.example .env` produces truly empty values and
# triggers `kosmos.config.guard` with the single-line remediation message.

# --- Required in dev/ci/prod (guard enforces non-empty) ---
# Leave values empty so a bare `cp .env.example .env` fails the startup guard
# with a single-line remediation message — copying the template must NOT look
# like a valid install.

# consumed by kosmos.settings.KosmosSettings.kakao_api_key
KOSMOS_KAKAO_API_KEY=
# consumed by kosmos.llm.config.LLMClientConfig.token
KOSMOS_FRIENDLI_TOKEN=
# consumed by kosmos.settings.KosmosSettings.data_go_kr_api_key
KOSMOS_DATA_GO_KR_API_KEY=

# --- Optional fallback (resolve_location.py logs-and-skips when unset) ---
# consumed by kosmos.settings.KosmosSettings.juso_confm_key
# KOSMOS_JUSO_CONFM_KEY=<redacted>
# consumed by kosmos.settings.KosmosSettings.sgis_key
# KOSMOS_SGIS_KEY=<redacted>
# consumed by kosmos.settings.KosmosSettings.sgis_secret
# KOSMOS_SGIS_SECRET=<redacted>

# --- Required in prod only (conditional) ---
# consumed by kosmos.observability.langfuse (#501)
LANGFUSE_PUBLIC_KEY=<redacted>
# consumed by kosmos.observability.langfuse (#501)
LANGFUSE_SECRET_KEY=<redacted>
# consumed by kosmos.observability.otel (#501)
KOSMOS_OTEL_ENDPOINT=<redacted>

# --- Optional (defaults apply) ---
# activation flag: dev | ci | prod (default dev)
# KOSMOS_ENV=dev
# consumed by kosmos.llm.config.LLMClientConfig.base_url
# KOSMOS_FRIENDLI_BASE_URL=<redacted>
# consumed by kosmos.llm.config.LLMClientConfig.model
# KOSMOS_FRIENDLI_MODEL=<redacted>
# consumed by kosmos.llm.config.LLMClientConfig.session_budget
# KOSMOS_LLM_SESSION_BUDGET=<redacted>
# consumed by kosmos.settings.KosmosSettings.lookup_topk; clamped [1, 20]
# KOSMOS_LOOKUP_TOPK=5
# consumed by kosmos.settings.KosmosSettings.nmc_freshness_minutes; clamped [1, 1440]
# KOSMOS_NMC_FRESHNESS_MINUTES=30
# consumed by kosmos.cli.config.CLIConfig.history_size
# KOSMOS_CLI_HISTORY_SIZE=<redacted>
# consumed by kosmos.cli.config.CLIConfig.show_usage
# KOSMOS_CLI_SHOW_USAGE=<redacted>
# consumed by kosmos.cli.config.CLIConfig.welcome_banner
# KOSMOS_CLI_WELCOME_BANNER=<redacted>
# consumed by kosmos.cli.themes.load_theme (alias for KOSMOS_THEME)
# KOSMOS_CLI_THEME=<redacted>
# consumed by kosmos.cli.themes.load_theme
# KOSMOS_THEME=<redacted>

# --- Override pattern (escape hatch) ---
# per-tool override, e.g. KOSMOS_KOROAD_ACCIDENT_SEARCH_API_KEY; see docs/configuration.md
# KOSMOS_<TOOL_ID>_API_KEY=<redacted>

# --- Deprecated (scheduled for removal) ---
# legacy global fallback — do not set in new installs; consumed by kosmos.permissions.credentials (global fallback)
# KOSMOS_API_KEY=<redacted>

# OTLP Collector (spec 028)
# consumed by docker-compose.dev.yml — host port of the otelcol OTLP HTTP receiver
KOSMOS_OTEL_COLLECTOR_PORT=4318
# consumed by infra/otel-collector/config.yaml — base OTLP URL (collector appends /v1/traces automatically)
KOSMOS_LANGFUSE_OTLP_ENDPOINT=http://langfuse-web:3000/api/public/otel
# consumed by infra/otel-collector/config.yaml — Basic <base64(pk-xxx:sk-xxx)> for Langfuse OTLP auth (empty = anonymous)
KOSMOS_LANGFUSE_OTLP_AUTH_HEADER=