Skip to content

fix: double-quote pip specifiers so copied lines work in cmd.exe - #33244

Merged
bolichen97 merged 1 commit into
mainfrom
fix/32732-pip-double-quotes
Nov 10, 2026
Merged

bolichen97 merged 1 commit into
mainfrom
fix/32732-pip-double-quotes

Conversation

@bolichen97

@bolichen97 bolichen97 commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Problem / Motivation

Goal: Every copy-paste pip install line in the shipped guides, the meetings skill, the Settings SageMaker card and the repository docs works when pasted into cmd.exe, as it already does in bash, zsh and PowerShell.

A Windows user who pastes the WhatsApp guide's pip install 'neonize==0.4.3.post0' into cmd.exe gets ERROR: Invalid requirement: "'neonize==0.4.3.post0'". The Feishu line pip install 'lark-oapi>=1.4,<2' never reaches pip at all: cmd.exe reads < as a redirect, prints "The system cannot find the file specified." and leaves a stray file named 1.4. The same single-quoted form is in nine more lines.

Why it matters

Settings sends users to these guides for channel setup, so on Windows the copied step installs nothing and the channel stays unavailable. A bounded pin is worse than an error: the command fails before pip starts and leaves a file behind. The meetings skill's line is one an agent may run as written.

Not a goal

  • Changing extras.quote_spec, install_hint or pip_install_command, or any hint the server builds: their output stays byte-identical.
  • Server error strings that spell a pin (bedrock_kb's missing-boto3 error, the SageMaker 409 message body), code comments, setup.cfg comments and contributor scripts.
  • Test fixtures and capture scripts that stand in for a server hint.
  • Having the Decisions card read the server's hint instead of a fixed string.

What changed (motivation → approach → change)

Copied install lines now work in cmd.exe. cmd.exe does not treat ' as a quote, so a single-quoted specifier reached pip with its quotes, or split on <. extras.quote_spec already names the fix: double quotes are the one form cmd.exe and PowerShell both strip, and bash and zsh accept them too because no pin holds $, a backtick or " (test_specifiers_hold_no_powershell_metacharacters pins that). Every copied line uses that form:

Where a user copies it Lines
Shipped guides: whatsapp-integration.md, feishu-integration.md, configuration.md (voice), decisions.md 5
The meetings builtin skill 1
Settings, Developer, Decisions: the SageMaker option's "boto3 is not installed" line (BOTO3_INSTALL), plus its entry in the install-command allowlist of website/eslint.i18n.config.js 1
Repository docs: docs/guides/install.md, docs/reference/kiro-cli/chat/voice.md, docs/architecture/design-notes/profiling.md, docs/system-specs/modules/stt-streaming.md 4

A test keeps single-quoted pip install lines out of the docs and builtin skills.

Backwards compatibility

Compatible: each line installs the same packages and pins, and in bash, zsh and PowerShell the double-quoted line hands pip the same requirement the single-quoted one did.

Removes nothing: only the quote character changes; every package, pin and the allowlist entry's meaning stay.

Tests

  • test/test_extras.py::test_docs_never_single_quote_a_pip_specifier: no .md file under src/kiro_crew/docs/, src/kiro_crew/builtin_skills/ or docs/ holds pip install '. It reads the tree through source_corpus.repo_files(), so another checkout under the repository is never scanned.
  • website/src/pages/settings/decisionsProviderPicker.test.tsx ("says what to install when the gateway has no boto3") expects the double-quoted line.

Proof: PROVEN test/test_extras.py::test_docs_never_single_quote_a_pip_specifier (head 36d98b9)

Determinism: the new test passed 20 of 20 runs at -n0 and 10 of 10 at -n 4 --dist loadgroup --max-worker-restart=2 beside test_source_corpus.py and test_feishu_config_handlers.py; test_extras.py in a shuffled order (seed 21074) passed 39 of 39.

Manual verification

  • Each changed line, pasted into bash and zsh with --dry-run --no-index, hands pip the bare requirement: No matching distribution found for lark-oapi<2,>=1.4, and no file is left in the working folder. The voice line resolves against the installed packages.
  • Not run on Windows: that cmd.exe and PowerShell both strip double quotes is the rule extras.quote_spec states, and the reporter's control run of the double-quoted WhatsApp line parsed 3 of 3.

Screenshots / video

The SageMaker option with no boto3 on the gateway, from this head's built SPA (Settings, Developer, Decisions):

SageMaker option, boto3 missing, light

SageMaker option, boto3 missing, dark

Related Issues

Closes #32732

Sibling sweep

Swept: git grep -n "pip install '"
Sibling: src/kiro_crew/docs/whatsapp-integration.md:14 -- changed here
Sibling: src/kiro_crew/docs/feishu-integration.md:15 -- changed here
Sibling: src/kiro_crew/docs/configuration.md:494-504 -- changed here
Sibling: src/kiro_crew/docs/decisions.md:133 -- changed here
Sibling: src/kiro_crew/builtin_skills/meetings/SKILL.md:110 -- changed here
Sibling: website/src/pages/settings/DecisionsProviderPicker.tsx:25 -- changed here
Sibling: docs/guides/install.md:496-497 -- changed here
Sibling: docs/reference/kiro-cli/chat/voice.md:50 -- changed here
Sibling: docs/architecture/design-notes/profiling.md:52 -- changed here
Sibling: docs/system-specs/modules/stt-streaming.md:14 -- changed here
Sibling: src/kiro_crew/knowledge/connectors/bedrock_kb.py:142 -- not affected -- a server error string, not a copied docs, skill or Settings line (Not a goal)
Sibling: src/kiro_crew/config/sections_channels.py:464 -- not affected -- a docstring, read by maintainers in the source only
Sibling: src/kiro_crew/feishu/client.py:13 -- not affected -- a module docstring, read by maintainers in the source only
Sibling: setup.cfg:179 -- not affected -- comments beside the extras declarations, not copy-paste user text
Sibling: scripts/check_black_formatting.py:197 -- not affected -- contributor tooling output, not shipped user docs
Sibling: scripts/check_per_file_coverage.py:220 -- not affected -- contributor tooling output, not shipped user docs
Sibling: website/src/test/FeishuPanel.test.tsx:174 -- not affected -- a fixture standing in for a server hint the server quotes itself
Sibling: website/scripts/capture-feishu-panel.mjs:114 -- not affected -- a capture fixture standing in for a server hint

Pattern harvest

Rule candidate: lint
Pattern: a copy-paste pip install line in shipped text single-quotes its specifier, which cmd.exe passes through to pip

Checklist

  • At most two commits (one is the norm), with a Conventional Commits title (feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)
  • Existing tests pass and new tests added for new functionality
  • Self-review completed; code follows project style guidelines
  • Documentation updated (if applicable)
  • No secrets, credentials, or internal references in the diff

@bolichen97
bolichen97 requested review from a team and KiroCrewCaptain as code owners November 8, 2026 15:14
@github-actions github-actions Bot added the readiness: checking Automated validation is still running label Nov 8, 2026
@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Design Review (Opus 5.5) — ✅ PASS

Design-level review of 36d98b9c6d8ab57a1d1361d439b1d864d528c910 — updated in place on each push. A BLOCK verdict blocks PR readiness; PASS does not.

Design-Verdict: PASS

Nothing blocks: this changes only the quote character in docs and one UI string, and a test stops single-quoted pip install lines from coming back in the doc trees.

[DESIGN-REVIEWED] 36d98b9

Description read

[DESCRIPTION-READ] d9199f8c04e0f4285ccbd2ad2da764a5a18b412ab6ffca4c5a608e80950d17a6

That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with .github/scripts/pr-description-capture.sh over the same inputs; if it differs, the description or that evidence changed after this verdict was formed and any finding drawn from either is unproven.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

First Principles Review (Opus 5.5) — ✅ PASS

Premise-level review of 36d98b9c6d8ab57a1d1361d439b1d864d528c910 — why this exists and whether the shipped surface is the smallest honest version. Updated in place on each push. A BLOCK verdict blocks PR readiness; PASS does not.

First-Principles-Verdict: PASS

Nothing blocks. The fix works on the real cause: the quote character in every copied line. A test stops new single-quoted lines in the doc trees.

Not checked: whether cmd.exe strips the double quotes. The author also did not run it on Windows.

Notes

  • Item 1 — symptom-level: the server error string bedrock_kb.py:142 ("Install the optional extra: pip install 'boto3>=1.34,<2'") reaches users with the same cmd.exe defect. It is left out by "Not a goal". I grepped pip install ' outside tests and fixtures and found 1 user-facing sibling left unfixed. Subtraction: replace that literal with extras.quote_spec output.

What this change ships

Inventory (4 items) — 3 justified

Intent: Windows users can paste the pip install lines from the docs and Settings into cmd.exe and have them work. This is a FIX (#32732).

  1. The copied pip lines in the shipped guides, the meetings skill and the repository docs now double-quote the specifier — symptom-level (one sibling string still single-quoted)
  2. The Settings SageMaker "boto3 is not installed" line now shows the double-quoted command — justified
  3. The i18n lint allowlist regex now matches the double-quoted command — justified
  4. A test fails when any .md file in the doc trees holds pip install ' — justified

[FIRST-PRINCIPLES-REVIEWED] 36d98b9

Description read

[DESCRIPTION-READ] 8e41b0177ddd9a50951c9a1c385d3072ded2737f3ee1421c031967f85381b7b2

That sha256 names the PR description this verdict read. Recompute it with .github/scripts/pr-description-capture.sh; if it differs, the description changed after this verdict was formed and any finding drawn from the description is unproven.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

UX Review (Opus 5.5) — ✅ PASS

UX-level review of 36d98b9c6d8ab57a1d1361d439b1d864d528c910 — updated in place on each push. A BLOCK verdict blocks PR readiness; PASS does not.

UX-Verdict: PASS

The only visible change, the SageMaker card's install line, appears in shot-01, and the blind reader read it correctly as a warning plus a command to run.

[UX-REVIEWED] 36d98b9

Description read

[DESCRIPTION-READ] e94ff16addf535ef0c201cf772b576284c773232ab3ed088b1a08ec1950d34a3

That sha256 names everything this verdict read: the PR description, plus the 5 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with .github/scripts/pr-description-capture.sh over the same inputs; if it differs, the description or that evidence changed after this verdict was formed and any finding drawn from either is unproven.

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Opus 5.5 Review — ✅ no blocking findings

Reviewed 36d98b9c6d8ab57a1d1361d439b1d864d528c910 — this comment is updated in place on each push.

Review details

No findings.

[OPUS-REVIEWED] 36d98b9

Verdict parsed from the review's SHA-scoped output markers for commit 36d98b9c6d8ab57a1d1361d439b1d864d528c910.

False positive or not applicable? A repository writer can comment:
/ai-review override fable 36d98b9c6d8ab57a1d1361d439b1d864d528c910 false-positive: <reason, 20 to 500 characters>

@github-actions

github-actions Bot commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

GPT 6.1 Review — ✅ no blocking findings

GPT 6.1 completed its review of 36d98b9c6d8ab57a1d1361d439b1d864d528c910 and found no blocking issues.

This comment is updated in place on each push.

Review details

No findings.
[GPT-REVIEWED] 36d98b9

False positive or not applicable? A repository writer can comment:
/ai-review override gpt 36d98b9c6d8ab57a1d1361d439b1d864d528c910 false-positive: <reason, 20 to 500 characters>

@github-actions github-actions Bot added readiness: action required A blocking check or review needs attention and removed readiness: checking Automated validation is still running labels Nov 8, 2026
@bolichen97
bolichen97 enabled auto-merge (squash) November 8, 2026 15:44
@bolichen97
bolichen97 force-pushed the fix/32732-pip-double-quotes branch from 56201ea to 788069e Compare November 8, 2026 19:56
@github-actions github-actions Bot added readiness: checking Automated validation is still running and removed readiness: action required A blocking check or review needs attention labels Nov 8, 2026
@bolichen97

Copy link
Copy Markdown
Contributor Author

self-added: no

  • The new docs gate fails on the merge ref: docs/system-specs/modules/stt-streaming.md still single-quotes a pip specifier span=c222f713e6d7

fixed in 788069e: rebased onto main and changed stt-streaming.md:14 to pip install "kirocrew[voice-codex]", so the copied line also works in cmd.exe.
test/test_extras.py::test_docs_never_single_quote_a_pip_specifier now passes on the rebased tree (39 of 39 in test_extras.py); the body's table and sibling sweep name the file.

[operator: bolichen97]

@github-actions github-actions Bot added readiness: action required A blocking check or review needs attention and removed readiness: checking Automated validation is still running labels Nov 8, 2026

@buluoray buluoray left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving. Copy-paste pip lines in the shipped guides, the meetings skill, the SageMaker Settings line and the repo docs switch from single to double quotes, because cmd.exe treats a single quote as literal and < as a redirect (website/src/pages/settings/DecisionsProviderPicker.tsx:25, website/eslint.i18n.config.js:772, src/kiro_crew/docs/feishu-integration.md:15). Packages and pins are unchanged, and a new test keeps single-quoted pip lines out of the doc trees (test/test_extras.py:291-307). The Backend Tests shard 6 red comes from main and is fixed there.

The shipped guides, the meetings skill, the Settings SageMaker card and
three repository docs gave their install step with single-quoted
specifiers. cmd.exe does not treat ' as a quote, so pip received the
quotes and rejected the requirement, or a bounded pin redirected on <
and pip never ran.

Use double quotes, the form extras.quote_spec already returns on
Windows; it works unchanged in bash, zsh, cmd.exe and PowerShell
because no pin holds $, a backtick or ". A test keeps single-quoted
pip lines out of the docs and builtin skills.

Closes #32732
@bolichen97
bolichen97 force-pushed the fix/32732-pip-double-quotes branch from 788069e to 36d98b9 Compare November 10, 2026 14:46
@bolichen97

Copy link
Copy Markdown
Contributor Author

Rebased: main moved in docs/guides/install.md and 100 more files beside this PR's since this head's CI ran (012380a -> fbbb07d); the new base carries #33377, which re-pins the lazy-import count that failed Backend Tests shard 6 on the old head. CI re-running.

[operator: bolichen97]

@github-actions github-actions Bot added readiness: checking Automated validation is still running readiness: passed Eligible automated validation passed for the current revision and removed readiness: action required A blocking check or review needs attention readiness: checking Automated validation is still running labels Nov 10, 2026
@bolichen97
bolichen97 merged commit 34f545d into main Nov 10, 2026
153 of 154 checks passed
@bolichen97
bolichen97 deleted the fix/32732-pip-double-quotes branch November 10, 2026 18:39
@github-actions github-actions Bot removed the readiness: passed Eligible automated validation passed for the current revision label Nov 10, 2026
KiroCrewCaptain added a commit to KiroCrewCaptain/kirocrew-app-meetings that referenced this pull request Nov 13, 2026
Port the Meetings backend and skill changes Kiro Crew made to its
built-in copy since this repository was last kept in step:

- a note editor id or note image name ending in a newline is refused
  (kirodotdev/KiroCrew#34534)
- a Start that omits agents_enabled keeps the roster the meeting holds
  (kirodotdev/KiroCrew#28263)
- the calendar provider loads on aiohttp 3.9
  (kirodotdev/KiroCrew#35292)
- filing a task never saves over an unreadable task ledger
  (kirodotdev/KiroCrew#35846)
- a multipart note image upload with no boundary is a 400
  (kirodotdev/KiroCrew#36046)
- the skill's pip line double-quotes its specifiers
  (kirodotdev/KiroCrew#33244)
- two test-only changes (kirodotdev/KiroCrew#34299, #33539)

Each fix comes with the built-in's test; PORTING.md gains one row each.

Co-authored-by: KiroCrewCaptain <312312717+KiroCrewCaptain@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants