Skip to content

feat: support configurable CLI global config#1011

Merged
EhabY merged 8 commits into
mainfrom
feat/global-config
Jun 26, 2026
Merged

feat: support configurable CLI global config#1011
EhabY merged 8 commits into
mainfrom
feat/global-config

Conversation

@EhabY

@EhabY EhabY commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Adds coder.globalConfig as a machine-scoped directory setting for the CLI --global-config path, with CODER_CONFIG_DIR fallback and existing per-deployment storage as the default.
  • Applies the resolved config directory consistently through PathResolver, CLI auth flags, credential file reads/writes/deletes, active remote reload prompts, and support bundle settings.
  • Preserves keyring precedence while allowing file-backed CLI credentials to be reused when keyring auth is not active.

Closes #185.

Testing

  • pnpm test:extension ./test/unit/cliConfig.test.ts ./test/unit/core/pathResolver.test.ts ./test/unit/core/cliCredentialManager.test.ts ./test/unit/login/loginCoordinator.test.ts ./test/unit/supportBundle/settings.test.ts
  • pnpm test
  • pnpm typecheck
  • pnpm lint
  • pnpm format:check
  • pnpm build
  • git diff --check

Generated by Coder Agents.

Implementation plan
  • Add a dedicated coder.globalConfig setting for a directory path and keep coder.globalFlags from overriding managed --global-config / --use-keyring flags.
  • Resolve global config path in PathResolver: coder.globalConfig first, then CODER_CONFIG_DIR, then the existing <globalStorage>/<safeHostname> default.
  • Preserve keyring precedence in CLI auth resolution; use --url for active supported keyring auth, otherwise --global-config <resolvedDir>.
  • Read file-backed CLI credentials from the resolved config directory when keyring auth is not active so CLI login can be shared with the extension.
  • Add reload prompt/support bundle handling for the setting.
  • Cover behavior with targeted unit tests for path resolution, CLI flags, credential manager, login fallback, and support bundle settings.

@EhabY EhabY self-assigned this Jun 17, 2026
@EhabY EhabY requested a review from code-asher June 17, 2026 12:46
Comment thread src/core/cliCredentialManager.ts Outdated
Comment thread src/core/cliCredentialManager.ts Outdated
Comment thread src/core/cliCredentialManager.ts Outdated
Comment thread src/core/pathResolver.ts Outdated
@EhabY EhabY requested a review from code-asher June 18, 2026 10:00
@EhabY EhabY force-pushed the feat/global-config branch 3 times, most recently from 9a72ccf to 6d03c00 Compare June 23, 2026 06:59
@EhabY

EhabY commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator Author

With 7e5d315 we have the following. @code-asher I think this simplified things a bit and we can further cut down if we drop support for <0.25 (very old tbh - 3 years old).

Global config / credential changes (vs main)

<dir> = the per-deployment config dir, default <globalStorage>/<safeHost>, or a user --global-config in coder.globalFlags (honored on 2.31.0+, file mode only).

WRITE

Mode / version main new
keyring (mac/win, 2.29+) coder login --use-token-as-session <url> same
file, 0.25+ extension writes <dir>/session + <dir>/url coder login --use-token-as-session <url> --global-config <dir>
file, <0.25 extension writes the files extension writes the files (fallback)

READ

Mode / version main new
keyring (2.31+) coder login token --url <url> same
file, 2.31+ nothing (only keyring was read) coder login token --url <url> --global-config <dir>
<2.31 nothing nothing

DELETE

rm <default> files always runs: it is the only deleter when coder logout is unavailable (<0.25 or binary unresolvable), and it sweeps the default dir, which coder logout --global-config <override> does not touch.

Mode / version main new
keyring (2.29+) coder logout --url <url> --yes + rm <default> files same
file, 0.25+ rm <default> files only coder logout --url <url> --global-config <dir> --yes + rm <default> files
file, <0.25 / no binary rm <default> files rm <default> files (no coder logout)

Config dir / --global-config

main new
Custom dir not configurable --global-config in coder.globalFlags (2.31+, file mode)
Binary cache under <default> always plugin dir (coder.binaryDestination still applies)

What it means for the user (vs main)

  • New: point the extension at a shared CLI dir (--global-config=~/.config/coderv2 in coder.globalFlags) to share login with the terminal coder, on 2.31+.
  • New: on 2.31+ the extension picks up file based CLI credentials (main only read the keyring).
  • File writes/deletes now go through coder login / coder logout instead of the extension touching the files directly.
  • No change for keyring users.

@EhabY EhabY force-pushed the feat/global-config branch 2 times, most recently from 36cfde3 to b69b20b Compare June 25, 2026 09:47
Comment thread src/core/container.ts
Comment thread src/settings/cli.ts Outdated
Comment thread src/util/uri.ts Outdated
Comment thread src/util/uri.ts Outdated
Comment thread src/core/cliCredentialManager.ts Outdated
EhabY and others added 8 commits June 26, 2026 14:19
Split src/util.ts into focused modules: src/util/uri.ts (toSafeHost,
removeTrailingSlashes, resolveUiUrl, openInBrowser) and
src/util/authority.ts (Remote SSH authority helpers), replacing
src/uri/utils.ts. Migrate all importers and mirror the unit tests.

Make CliCredentialManager.readToken return the token together with its
source ("keyring" | "files") so LoginCoordinator labels the login
method from the actual source instead of re-deriving it from whether
keyring is enabled.
…malization

- Add loginCoordinator test for the keyring_token method (source: "keyring")
- Add comprehensive toRemoteAuthority tests over varied URI types
- Test toSafeHost/normalizeUrl with Arabic alongside Japanese IDNs
- Consolidate the trim + strip-trailing-slashes logic into a shared
  normalizeUrl in util/uri, reused by resolveUiUrl and cliCredentialManager
Replace the dedicated `coder.globalConfig` setting with a `--global-config`
passthrough in `coder.globalFlags`, honored on 2.31.0+. The extension no longer
reads/writes the CLI credential files itself: it writes via `coder login`
(0.25.0+, `--use-token-as-session`), reads via `coder login token` (2.31.0+),
and deletes via `coder logout` (keyring or file with `--global-config`).
Direct file writes remain only as a pre-0.25 fallback. The binary cache no
longer follows the config dir.
- Bump the minimum supported deployment version to 0.25.0 (where `coder
  login` lives), gating on `featureSet.cliLogin`, and move the compatibility
  check before credential configuration so older servers get a clear message.
- Remove the pre-0.25 direct-file-write fallback; credential writes now always
  go through `coder login`. Drop the now-unused `vscodessh` feature flag and
  the dead `CredentialFileError` class plus its `filesystem`/`file` telemetry
  categories.
- Collapse the `resolveCli` overloads into one throwing resolver; the
  best-effort read path catches instead.
- Fix the stale `coder.globalConfig` CHANGELOG entry (the setting was dropped)
  and two pre-existing test typecheck breaks (`toSafeHost` import path and a
  `CliAuth.allowOverride` literal).
Routing file-mode credentials through `coder login`/`logout` means the
credential binary resolver now runs in the login and logout flows, not just on
connect. It previously fell back to `fetchBinary` on a cache miss, so a
file-mode user's login (including auto-login on startup) or logout could
trigger a surprise CLI download with a progress popup, where before it was
silent file I/O.

Make the resolver locate-only. The connect and CLI-command flows still fetch
the binary first, so credential ops become best-effort against an
already-present binary and never download on their own. If no binary exists
yet, credential sharing is simply skipped until a real connection fetches one.
- rename FeatureSet.keyringTokenRead to tokenRead (token subcommand works for both stores)
- rename resolveUiUrl to resolveCoderDashboardUrl
- clarify openInBrowser docstring (connectionUrl is arbitrary)
- split buildGlobalFlags on auth mode to drop the nested ternary
@EhabY EhabY force-pushed the feat/global-config branch from c320dd2 to 5ddf592 Compare June 26, 2026 12:18
@EhabY EhabY merged commit a5941a3 into main Jun 26, 2026
13 checks passed
@EhabY EhabY deleted the feat/global-config branch June 26, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add support for sharing login/auth between Coder CLI and VS Code extension

2 participants