Skip to content

Global settings and configuration scope ​

Studio’s settings entry at the bottom of the sidebar manages local user preferences in $OMK_HOME/settings.json (~/.oh-my-knowledge/settings.json by default). CLI and Studio share this file. Reading creates no directory; saving invokes no model, moves no data and changes no historical run.

Persisted preferences ​

SettingBuilt-in defaultScope
Knowledge folder$OMK_HOME/knowledgeStudio extraction and omk observe knowledge; workspace / --workspace overrides it
Extraction providercodexKnowledge extraction; supports codex, openai-api
Extraction modelUnsetMust be selected before extraction; changing provider does not inherit another provider’s model
Default languageAuto: system locale, falling back to zhStudio and CLI; lang / --lang overrides it

Priority: explicit request → existing environment overrides → saved settings → system locale → zh. OMK_EXECUTOR, OMK_MODEL and OMK_LANG remain environment overrides; Settings shows the overriding variable names. There is no additional knowledge-folder environment alias. An empty model means selection is required, not automatic model discovery.

The knowledge page’s per-operation folder and model controls do not modify global preferences. Browsers no longer own durable folder settings. Old browser selections are not automatically copied into the settings file; save them explicitly if needed. Explicit page directories still apply. Changing the default does not migrate existing candidates or sources.

Configuration that remains elsewhere ​

ScopeConfigurationOwner
Startup and data rootOMK_HOME, Studio --host / --port, OMK_REPORT_HOST / OMK_REPORT_PORTEnvironment or startup flags; no live root or listener changes
API credentials and endpointsOPENAI_API_KEY, OPENAI_BASE_URLEnvironment; keys are neither accepted nor displayed by settings
External runtimesCODEX_HOME, Codex config, PATH, proxy configurationRuntime or startup environment; third-party configuration is not modified
General execution/evaluation defaultsOMK_EXECUTOR, OMK_MODEL, OMK_JUDGE_MODELSExisting CLI environment overrides; evaluations do not read the extraction model preference
Project and evaluation runEvaluation config, judges, samples, assertions, concurrency, budgets, report/observation directoriesProject files or command flags; not promoted to user preferences
Extraction and maintenance operationConversation, task, selected messages, model override, revision and rationaleCurrent workflow; no automatic historical scanning or sending
Maintenance and internal infrastructureOMK_SKIP_UPDATE_CHECK, BROWSER, cache/tree directories and retention limits, mock variablesExisting advanced environment controls, outside the ordinary settings form

Environment changes generally require restarting Studio. Reading settings does not verify credentials or model availability. Extraction still requires preview and confirmation.

Command-line environment overrides ​

VariableEffect
OMK_EXECUTORDefault executor preference, such as codex, codex-sdk, or openai-api; it neither installs nor authenticates a runtime.
OMK_MODELDefault evaluated model; when unset, Codex uses its own configuration.
OMK_JUDGE_MODELSDefault judge list in executor:model[,...] format.
OMK_REPORT_PORTLocal report listener port, default 7799; use the actual URL returned at startup.

See runtime prerequisites for executors and optional SDKs. Reading existing work records requires no model call; supplying environment variables does not prove authentication or invocation succeeded.

File and concurrency ​

The file uses schemaVersion: 2 and only known fields. Corrupt files, unknown versions, relative folders and credential fields are rejected without silent overwrites. Saves carry a read revision; conflicts require a reload. Extraction runs continue to record the actual provider, model and selected source.

Before upgrading v1 settings, back up the file, explicitly select codex or openai-api and its model, then set schemaVersion to 2. Old versions are rejected and never overwritten automatically. See runtime removal and migration.