Skip to content

Latest commit

 

History

History
204 lines (142 loc) · 3.81 KB

settings.md

File metadata and controls

204 lines (142 loc) · 3.81 KB

Settings Reference

Reference for dashboard and backend settings available from codex auth login -> Settings.

Settings Location

Default file:

  • ~/.codex/multi-auth/settings.json

Top-level objects:

  • dashboardDisplaySettings
  • pluginConfig

When CODEX_MULTI_AUTH_DIR is set, this root moves accordingly.

Account List View

Controls account-row display and sorting behavior:

  • menuShowStatusBadge
  • menuShowCurrentBadge
  • menuShowLastUsed
  • menuShowQuotaSummary
  • menuShowQuotaCooldown
  • menuShowFetchStatus
  • menuShowDetailsForUnselectedRows
  • menuHighlightCurrentRow
  • menuSortEnabled
  • menuSortMode
  • menuSortPinCurrent
  • menuSortQuickSwitchVisibleRow
  • menuLayoutMode

Summary Line

Controls detail-line fields and order:

  • menuStatuslineFields
  • last-used
  • limits
  • status

Menu Behavior

Controls result-screen and fetch behavior:

  • actionAutoReturnMs
  • actionPauseOnKey
  • menuAutoFetchLimits
  • menuShowFetchStatus
  • menuQuotaTtlMs

Color Theme

Controls display style:

  • uiThemePreset
  • uiAccentColor
  • menuFocusStyle

Experimental

Experimental currently hosts:

  • one-way sync preview and apply into oc-chatgpt-multi-auth
  • named local pool backup export with filename prompt
  • refresh guard controls (proactiveRefreshGuardian, proactiveRefreshIntervalMs)

Sync behavior:

  • preview is always shown before apply
  • blocked target states do not apply changes
  • destination active selection is preserved
  • destination-only accounts are preserved by the merge preview/apply path

Named backup behavior:

  • prompts for a filename
  • appends .json when omitted
  • rejects separators, traversal (..), .rotate., .tmp, and .wal suffixes
  • fails safely on collisions instead of overwriting by default

Backend Controls

Session & Sync

Examples:

  • liveAccountSync
  • liveAccountSyncDebounceMs
  • liveAccountSyncPollMs
  • sessionAffinity
  • sessionAffinityTtlMs
  • sessionAffinityMaxEntries
  • perProjectAccounts

Rotation & Quota

Examples:

  • preemptiveQuotaEnabled
  • preemptiveQuotaRemainingPercent5h
  • preemptiveQuotaRemainingPercent7d
  • preemptiveQuotaMaxDeferralMs
  • retryAllAccountsRateLimited
  • retryAllAccountsMaxWaitMs
  • retryAllAccountsMaxRetries

Refresh & Recovery

Examples:

  • tokenRefreshSkewMs
  • proactiveRefreshBufferMs
  • storageBackupEnabled
  • sessionRecovery
  • autoResume

Performance & Timeouts

Examples:

  • parallelProbing
  • parallelProbingMaxConcurrency
  • fastSession
  • fastSessionStrategy
  • fastSessionMaxInputItems
  • emptyResponseMaxRetries
  • emptyResponseRetryDelayMs
  • fetchTimeoutMs
  • streamStallTimeoutMs
  • networkErrorCooldownMs
  • serverErrorCooldownMs

Stable Environment Overrides

Common operator overrides:

  • CODEX_MULTI_AUTH_DIR
  • CODEX_MULTI_AUTH_CONFIG_PATH
  • CODEX_MODE
  • CODEX_TUI_V2
  • CODEX_TUI_COLOR_PROFILE
  • CODEX_TUI_GLYPHS
  • CODEX_AUTH_FETCH_TIMEOUT_MS
  • CODEX_AUTH_STREAM_STALL_TIMEOUT_MS

Advanced and Internal Overrides

Maintainer/debug-focused overrides include:

  • CODEX_MULTI_AUTH_SYNC_CODEX_CLI
  • CODEX_MULTI_AUTH_REAL_CODEX_BIN
  • CODEX_MULTI_AUTH_BYPASS
  • CODEX_CLI_ACCOUNTS_PATH
  • CODEX_CLI_AUTH_PATH
  • refresh lease controls (CODEX_AUTH_REFRESH_LEASE*)

Full inventory: ../development/CONFIG_FIELDS.md

Recommended Defaults

For most environments:

  • smart sort enabled
  • auto-fetch limits enabled
  • live sync enabled
  • session affinity enabled
  • preemptive quota deferral enabled
  • proactive refresh guardian enabled

Validation

After changes:

codex auth status
codex auth check
codex auth forecast --live

Related