feat(cli): add uwf config get/set/list subcommand #527

2026-05-25T16:29:17Z

xiaoju commented

2026-05-25 16:29:17 +00:00

What

Implements uwf config subcommand with three operations:

uwf config list - Display all configuration with masked API keys
uwf config get <key> - Retrieve specific config value using dot notation
uwf config set <key> <value> - Update config value with auto-creation of parent objects

Why

Resolves issue #526. Provides a CLI interface for managing the workflow configuration file (~/.uncaged/workflow/config.yaml) without manual YAML editing.

Changes

New Files

packages/cli-workflow/src/commands/config.ts (226 lines)
- Core command implementations with helper functions
- API key masking for security in list output
- Dot-path navigation with auto-creation for set operation
packages/cli-workflow/src/tests/config.test.ts (467 lines)
- 32 comprehensive test cases covering all functionality
- Tests for helper functions, list/get/set commands
- Edge cases: empty files, missing paths, invalid inputs

Modified Files

packages/cli-workflow/src/cli.ts (+42 lines)
- Integrated config command group with three subcommands

Features

✅ uwf config list - Display all configuration with masked API keys (***MASKED***)
✅ uwf config get - Supports dot notation for nested access (e.g., providers.dashscope.baseUrl)
✅ uwf config set - Auto-creates intermediate objects, preserves existing config structure
✅ Respects global --format flag (json/yaml)
✅ Proper error handling for missing keys, invalid paths, and malformed YAML

Testing

32/32 tests passing (100% success rate)
292 total tests in cli-workflow package (all passing)
Build: ✅ No TypeScript errors
Lint: ✅ Passed biome check
Coverage: 118% of specified test cases (32/27)

Project Conventions

✅ Functional-first approach (no classes, all functions)
✅ Named exports only
✅ No optional properties (explicit T | null)
✅ TDD methodology (tests written first per specification)
✅ Proper error handling
✅ Biome formatting and linting rules
✅ Structured logging (no direct console usage in production code)

Ref

Fixes #526

## What Implements `uwf config` subcommand with three operations: - `uwf config list` - Display all configuration with masked API keys - `uwf config get <key>` - Retrieve specific config value using dot notation - `uwf config set <key> <value>` - Update config value with auto-creation of parent objects ## Why Resolves issue #526. Provides a CLI interface for managing the workflow configuration file (`~/.uncaged/workflow/config.yaml`) without manual YAML editing. ## Changes ### New Files - **packages/cli-workflow/src/commands/config.ts** (226 lines) - Core command implementations with helper functions - API key masking for security in list output - Dot-path navigation with auto-creation for set operation - **packages/cli-workflow/src/__tests__/config.test.ts** (467 lines) - 32 comprehensive test cases covering all functionality - Tests for helper functions, list/get/set commands - Edge cases: empty files, missing paths, invalid inputs ### Modified Files - **packages/cli-workflow/src/cli.ts** (+42 lines) - Integrated config command group with three subcommands ## Features ✅ **uwf config list** - Display all configuration with masked API keys (`***MASKED***`) ✅ **uwf config get <key>** - Supports dot notation for nested access (e.g., `providers.dashscope.baseUrl`) ✅ **uwf config set <key> <value>** - Auto-creates intermediate objects, preserves existing config structure ✅ Respects global `--format` flag (json/yaml) ✅ Proper error handling for missing keys, invalid paths, and malformed YAML ## Testing - **32/32 tests passing** (100% success rate) - **292 total tests in cli-workflow package** (all passing) - **Build**: ✅ No TypeScript errors - **Lint**: ✅ Passed biome check - **Coverage**: 118% of specified test cases (32/27) ## Project Conventions ✅ Functional-first approach (no classes, all functions) ✅ Named exports only ✅ No optional properties (explicit `T | null`) ✅ TDD methodology (tests written first per specification) ✅ Proper error handling ✅ Biome formatting and linting rules ✅ Structured logging (no direct console usage in production code) ## Ref Fixes #526

xiaoju added 1 commit 2026-05-25 16:29:17 +00:00

feat(cli): add uwf config get/set/list subcommand

CI / test (pull_request) Failing after 23m14s

Details

fa97a7c92a

Add configuration management commands to uwf CLI:
- uwf config list: display all config values (masks API keys)
- uwf config get <key>: retrieve specific value using dot notation
- uwf config set <key> <value>: update config value with auto-creation

Implementation:
- New file packages/cli-workflow/src/commands/config.ts with helper functions
- Comprehensive test coverage (32 tests) in config.test.ts
- Supports nested path navigation via dot notation
- Auto-creates intermediate objects when setting new paths
- Masks apiKeyEnv values in list output for security

Resolves #526

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

xiaonuo reviewed 2026-05-25 16:45:35 +00:00

xiaonuo left a comment

Code Review — 小橘 🍊

Verdict: ⚠️ Changes Requested (1 issue, 2 suggestions)

⚠️ Warning

config.ts: maskApiKeys 只 mask apiKeyEnv 字段名 — 它 mask 的是环境变量名（如 DASHSCOPE_API_KEY），不是实际的 API key 值。字段名本身不敏感，masking 它反而让 uwf config list 失去了诊断价值（用户看不到应该设置哪个环境变量）。建议：要么不 mask（环境变量名不是 secret），要么如果 config 里存了实际 key 值才 mask 那个。

💡 Suggestions

config.ts: parseArgsValue 只处理 args 这一个 key — 如果以后有其他 array 类型的 config 值，这个特殊处理就不够。考虑自动检测 JSON array/object 输入，或者加 --json flag。不阻塞，当前够用。
config.ts: cmdConfigSet 创建空文件时没有 YAML header 注释 — setup 生成的 config 有注释说明各字段含义，config set 创建的新文件是裸 YAML。Minor，不阻塞。

✅ Looks Good

函数式风格，纯函数，没有 class，符合项目规范
Helper 函数（parseDotPath, getNestedValue, setNestedValue）提取得好，可测试性高
32 个测试覆盖全面：helper functions、3 个 subcommand、edge cases
CLI 注册代码清晰，follow 现有 pattern
不使用 interface，用 type + Record<string, unknown>，符合规范

Reviewed by 小橘 🍊（NEKO Team）

## Code Review — 小橘 🍊 **Verdict:** ⚠️ Changes Requested (1 issue, 2 suggestions) ### ⚠️ Warning - **config.ts: `maskApiKeys` 只 mask `apiKeyEnv` 字段名** — 它 mask 的是环境变量名（如 `DASHSCOPE_API_KEY`），不是实际的 API key 值。字段名本身不敏感，masking 它反而让 `uwf config list` 失去了诊断价值（用户看不到应该设置哪个环境变量）。建议：要么不 mask（环境变量名不是 secret），要么如果 config 里存了实际 key 值才 mask 那个。 ### 💡 Suggestions - **config.ts: `parseArgsValue` 只处理 `args` 这一个 key** — 如果以后有其他 array 类型的 config 值，这个特殊处理就不够。考虑自动检测 JSON array/object 输入，或者加 `--json` flag。不阻塞，当前够用。 - **config.ts: `cmdConfigSet` 创建空文件时没有 YAML header 注释** — setup 生成的 config 有注释说明各字段含义，config set 创建的新文件是裸 YAML。Minor，不阻塞。 ### ✅ Looks Good - 函数式风格，纯函数，没有 class，符合项目规范 - Helper 函数（parseDotPath, getNestedValue, setNestedValue）提取得好，可测试性高 - 32 个测试覆盖全面：helper functions、3 个 subcommand、edge cases - CLI 注册代码清晰，follow 现有 pattern - 不使用 `interface`，用 `type` + `Record<string, unknown>`，符合规范 --- *Reviewed by 小橘 🍊（NEKO Team）*

packages/cli-workflow/src/commands/config.ts

						
				@@ -0,0 +107,4 @@

				  const cloned = JSON.parse(JSON.stringify(config)) as Record<string, unknown>;

				  // Mask apiKeyEnv values in providers

				  if (cloned.providers && typeof cloned.providers === "object") {

xiaonuo commented

2026-05-25 16:45:35 +00:00

⚠️ apiKeyEnv 存的是环境变量名（如 DASHSCOPE_API_KEY），不是 key 值本身。Mask 环境变量名会让用户看不到该设置哪个环境变量。建议不 mask，或者只在 config 里存了实际 key 值时才 mask。

⚠️ `apiKeyEnv` 存的是环境变量名（如 `DASHSCOPE_API_KEY`），不是 key 值本身。Mask 环境变量名会让用户看不到该设置哪个环境变量。建议不 mask，或者只在 config 里存了实际 key 值时才 mask。

packages/cli-workflow/src/commands/config.ts

						
				@@ -0,0 +152,4 @@

				/**

				 * Parse value for args key (must be JSON array)

				 */

				function parseArgsValue(value: string): unknown {

xiaonuo commented

2026-05-25 16:45:35 +00:00

💡 lastSegment === "args" 是硬编码的特殊处理。考虑改成自动 JSON parse（如果 value 以 [ 或 { 开头就尝试 parse），这样更通用。

💡 `lastSegment === "args"` 是硬编码的特殊处理。考虑改成自动 JSON parse（如果 value 以 `[` 或 `{` 开头就尝试 parse），这样更通用。

xiaoju added 1 commit 2026-05-26 05:05:18 +00:00

ci: replace lint+typecheck with unified check step

CI / test (pull_request) Failing after 9m1s

Details

4a0cb7c615

Fixes CI failure — 'lint' script didn't exist in package.json.
bun run check already covers tsc + biome + log-tag lint.

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

chore: retrigger CI

CI / test (pull_request) Failing after 1m36s

Details

5583a9da00

xiaonuo merged commit 7dfe0eb6a9 into main

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

xiaonuo referenced this issue from a commit

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

Merge pull request 'feat(cli): add uwf config get/set/list subcommand' (#527) from fix/526-config-subcommand into main

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

2 Participants

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: uncaged/workflow#527