feat(knowledge): Phase 7 — setup wizard#256
Open
leeovery wants to merge 5 commits intofeat/knowledge-base-phase-6from
Open
feat(knowledge): Phase 7 — setup wizard#256leeovery wants to merge 5 commits intofeat/knowledge-base-phase-6from
leeovery wants to merge 5 commits intofeat/knowledge-base-phase-6from
Conversation
Replace the setup stub with an interactive readline wizard that handles system config (~/.config/workflows/config.json) and project init (.workflows/.knowledge/config.json + store.msp + metadata.json) in one guided flow. Aborts cleanly on non-TTY invocation. Idempotent: fully configured projects prompt to skip; partial configs are completed. OpenAI path validates the API key via a test embed; stub path writes a minimal config for keyword-only mode. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Wire the existing bulk index as the wizard's final step. cmdIndexBulk is dependency-injected into cmdSetup to avoid a circular require — esbuild's CJS wrapping breaks `require.main === module` on the entry when two modules require each other. Readline closes before indexing so a non-interactive long-running embed pass doesn't leave a lingering TTY handle. Indexing failures don't abort the setup — the project is initialised and the pending queue retains partial state. On stub-to-full upgrade, the wizard surfaces the rebuild instruction rather than auto-rebuilding. SKILL.md loses the "not yet implemented" wording. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the credentials-at-rest half of a hybrid auth model: a separate
~/.config/workflows/credentials.json at mode 0600, keyed by provider
({ "credentials": { "openai": { "api_key": "sk-..." } } }), resolved
only when the provider-specific env var (OPENAI_API_KEY for openai)
is not set. Env var wins — matches the AWS SDK pattern.
config.js gains loadCredentials, writeCredentials, resolveApiKey, and
a PROVIDER_ENV_VARS map. loadConfig stops reading api_key_env from
config files and instead delegates to resolveApiKey. Design doc's
Configuration Hierarchy section is rewritten: two config files
(non-secret) plus one credentials file (secret, 0600), explicit
precedence, rationale for the split.
The wizard still writes the old api_key_env field into config.json
— that field is now inert and gets cleaned up in the next commit.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Rewrites the openai branch of the setup wizard to match the hybrid
credential model introduced in the previous commit. Flow becomes:
1. Prompt for model and dimensions.
2. Write the non-secret system config to disk (can be kept even if
the key step aborts or the user Ctrl-Cs mid-key-entry).
3. Resolve the API key via the same precedence loadConfig uses:
a. $OPENAI_API_KEY if set — validate inline, nothing written.
b. Existing credentials.json — validate; if broken, offer to
replace with an inline prompt.
c. No key anywhere — show the explainer (portal link, dedicated-
key recommendation, where it's stored, env-override escape
hatch), prompt inline, validate, write to credentials.json.
Secret input is read through a new askSecret helper: stdin goes into
raw mode during the key prompt, each character is echoed as a '*' so
the key never touches terminal scrollback. Ctrl-C aborts cleanly,
Ctrl-D submits, backspace edits.
Validation failures route through describeValidationError, which maps
common OpenAI responses (401, 403, 429, 5xx, network errors) to a
short cause line plus a practical next-step hint — no raw
"Provider/model changed" errors bubble up to the user.
The api_key_env field is gone from buildSystemConfigOpenAI and from
every wizard prompt. Config.js already ignored it on read.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…silently returning {}
The previous try/catch swallowed every read error, including JSON
parse failures on a corrupt manifest. Callers then initialised
work_units = {}, merged in their own entry, and wrote back — erasing
every previously-registered work unit. This silently ate 7 of 8
work_units in a real project (tick) when an unrelated Go refactor
commit introduced a trailing comma into the manifest and the next
workflow command hit the swallow path.
Now distinguishes ENOENT (legitimate first-write, return {}) from
parse errors and other I/O errors (die with a clear message pointing
the user at the file). Corrupt manifests are preserved on disk —
they're surfaced, not silently overwritten.
Test covers the exact clobber pattern: trailing-comma manifest +
init command. Asserts exit 1, error mentions "not valid JSON" and
"by hand", and the corrupt file is still corrupt afterwards (no
write happened). Also a positive test that missing manifest is
treated as first-write.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
knowledge setupstub with a real interactive wizard (src/knowledge/setup.js): system config at~/.config/workflows/config.json, project init at.workflows/.knowledge/, and initial bulk indexing in one guided readline flow.knowledge rebuild" instruction rather than auto-rebuilding.cmdIndexBulkis dependency-injected intocmdSetupto avoid a circular require that broke esbuild's CJS wrapping.Stacks on
feat/knowledge-base-phase-6, notmain— do not merge until the knowledge-base rollout is ready for go-live.Test plan
bash tests/scripts/test-knowledge-cli.sh— 129 passed (includes new non-TTY-abort + dispatch assertions)node --test tests/scripts/test-knowledge-config.cjs— 39 passed (new unit tests forwriteConfigFile, config builders,detectSystemConfig,detectProjectInit)bash tests/scripts/test-workflow-manifest.sh— 176 passednpm run buildclean; committed bundle matches source.workflows/to$TMPDIR/kb-phase7-test/and from there run:skipat provider): writes stub config, project init proceeds, indexing runs in keyword-only modeecho '' | node .../knowledge.cjs setup→ aborts with "requires an interactive terminal" (covered by Test 3)🤖 Generated with Claude Code