refactor: apiKeyEnv → apiKey, store actual secret in config #530

2026-05-26T05:34:20Z

xiaoju commented

2026-05-26 05:34:20 +00:00

What

Rename ProviderConfig.apiKeyEnv to apiKey — store actual API key value in config instead of env var name.

Why

~/.uncaged/workflow/config.yaml is local, never committed. Env var indirection is unnecessary complexity (#528).

Changes

workflow-protocol — apiKeyEnv → apiKey in ProviderConfig type
workflow-util-agent/extract.ts — use providerEntry.apiKey directly
workflow-util-agent/storage.ts — validation updated
cli-workflow/setup.ts — removed apiKeyEnvName(), writes key value directly
docs/READMEs — updated references
Tests — updated setup-validate tests

Breaking Change

Yes — existing config.yaml with apiKeyEnv needs uwf setup to reconfigure.

Ref

Fixes #528

## What Rename ProviderConfig.apiKeyEnv to apiKey — store actual API key value in config instead of env var name. ## Why ~/.uncaged/workflow/config.yaml is local, never committed. Env var indirection is unnecessary complexity (#528). ## Changes - **workflow-protocol** — apiKeyEnv → apiKey in ProviderConfig type - **workflow-util-agent/extract.ts** — use providerEntry.apiKey directly - **workflow-util-agent/storage.ts** — validation updated - **cli-workflow/setup.ts** — removed apiKeyEnvName(), writes key value directly - **docs/READMEs** — updated references - **Tests** — updated setup-validate tests ## Breaking Change Yes — existing config.yaml with apiKeyEnv needs uwf setup to reconfigure. ## Ref Fixes #528

xiaoju added 1 commit 2026-05-26 05:34:21 +00:00

refactor(protocol,cli,agent): replace apiKeyEnv with apiKey (#528 )

CI / test (pull_request) Failing after 7m20s

Details

0c90b88e08

Breaking change: Store API keys directly in config.yaml instead of
environment variable names.

## Changes

### @uncaged/workflow-protocol
- Change ProviderConfig.apiKeyEnv: string → apiKey: string
- Update README to reflect new type

### @uncaged/workflow-util-agent
- extract.ts: Remove dotenv loading, use providerEntry.apiKey directly
- storage.ts: Update normalizeProviders to validate apiKey field
- Update error messages to reference apiKey instead of apiKeyEnv

### @uncaged/cli-workflow
- setup.ts: Write actual API key to config.yaml, not .env
- Remove apiKeyEnvName(), loadEnvFile(), saveEnvFile() functions
- Remove getEnvPath() function
- Update cmdSetup to not return envPath in result
- Update README to reflect config.yaml stores API keys
- Fix setup-validate.test.ts to not expect envPath in result

## Verification
- ✅ bun run build passes
- ✅ All tests pass (260/260 in cli-workflow, 55/55 in util-agent)
- ✅ bun run check passes (only pre-existing warnings)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

xiaoju added 1 commit 2026-05-26 05:37:04 +00:00

docs: update all documentation to reflect apiKey refactoring (#528 )

CI / test (pull_request) Failing after 33s

Details

47a4268b9b

Update all documentation files that contained outdated apiKeyEnv
references to use the new apiKey approach.

## Changes

- docs/architecture.md: Update config example to use apiKey field
- docs/wf-stateless-design.md: Update config examples and type
  definitions to use apiKey instead of apiKeyEnv
- docs/builtin-agent-research.md: Update ProviderConfig type
  definition and code examples

All documentation now consistent with the code implementation.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

xiaonuo merged commit bbbe4651c2 into main

2026-05-26 05:37:51 +00:00

xiaonuo referenced this issue from a commit

2026-05-26 05:37:53 +00:00

Merge pull request 'refactor: apiKeyEnv → apiKey, store actual secret in config' (#530) from fix/528-refactor-apikey into main

xiaomo referenced this pull request

2026-05-26 05:44:36 +00:00

bug: config list 未 mask apiKey（#530 重构遗漏） #531

xiaoju referenced this pull request

2026-05-27 01:56:18 +00:00

fix(cli): mask apiKey in config list (#531) #556

This repo is archived. You cannot comment on pull requests.