Skip to content

docs: catch up with recent repl merges (terminal integration, completion, global options, MCP prompts)#3

Merged
carldebilly merged 6 commits into
mainfrom
docs/shell-integration-marks
Jul 15, 2026
Merged

docs: catch up with recent repl merges (terminal integration, completion, global options, MCP prompts)#3
carldebilly merged 6 commits into
mainfrom
docs/shell-integration-marks

Conversation

@carldebilly

@carldebilly carldebilly commented Jul 8, 2026

Copy link
Copy Markdown
Member

Summary

Catches the hand-written docs up with the recent yllibed/repl merges, one commit per topic:

  • Shell-integration marks + ANSI detection chain (repl #42, #47) — reference/terminal-integration.mdx gets the "Shell integration marks (OSC 133 / OSC 633)" section (opt-in setup, mark table, modes, structural gates, E-mark privacy note, Windows Terminal settings note, ShellIntegrationStatus troubleshooting); reference/customization.mdx replaces the speculative detection steps with the actual chain (session override → AnsiModeNO_COLORCLICOLOR_FORCETERM=dumb → redirection).
  • Interactive and shell completion catch-up (repl #50, #55) — getting-started/repl-mode.mdx documents what the Tab menu completes (option names incl. global and result-flow flags, WithCompletion providers first with enum member fallback); getting-started/cli-mode.mdx documents what shell completion returns, the per-provider opt-in via CompletionProviderScope.InteractiveAndShell, the provider timeout, and the deliberate differences with the interactive menu; reference/configuration.mdx mentions the scope argument.
  • Global options in help (repl #34, #41) — reference/dependency-injection.mdx shows the AddGlobalOption overload with aliases/default/description and notes the Global Options: help section (defaults intentionally not displayed); getting-started/cli-mode.mdx points at it from the help section.
  • MCP prompts (repl #48, #49) — reference/mcp-concepts.mdx notes that non-optional route arguments are required in prompts/list and that string-returning handlers surface plain text.
  • Spectre terminal detection (repl #47) — the two passages deliberately deferred in the original draft are now accurate: host detection gates Spectre colors (with tiered Unicode box-drawing fallback, CI enrichers disabled, SpectreTerminalDetection.CurrentBoxDrawingSupport diagnostic), and true-color is requested only when the host gate allows ANSI.

Covers yllibed/repl PRs #34, #41, #42, #47, #48, #49, #50, #55 (all included in v0.11.0-dev.136).

Verification

  • npm run docs:validate — passed (262 files checked).
  • Full npm run build (DocFX API regeneration + Astro) run locally.

🤖 Generated with Claude Code

carldebilly and others added 5 commits July 8, 2026 17:53
…hain

- terminal-integration: new "Shell integration marks (OSC 133 / OSC 633)"
  section (opt-in setup, mark table, modes, structural gates, E-mark
  privacy note, Windows Terminal settings note, ShellIntegrationStatus
  troubleshooting); move OSC 133 from "not yet implemented" to
  "currently in place".
- customization: replace the speculative detection steps (COLORTERM,
  platform checks) with the actual chain — session override, AnsiMode,
  NO_COLOR, CLICOLOR_FORCE, TERM=dumb, redirection.
- repl-mode: Tab menu completes option names (route, global, result-flow),
  runs WithCompletion providers first with enum member fallback, and runs
  every registered provider (in-process).
- cli-mode: document what shell completion returns, per-provider opt-in
  via CompletionProviderScope.InteractiveAndShell, provider timeout, and
  the two deliberate differences with the interactive menu.
- configuration: mention the CompletionProviderScope argument.

Covers yllibed/repl PRs #50 and #55.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- dependency-injection: show the AddGlobalOption overload with aliases,
  default value, and description; note the Global Options help section
  and that defaults are intentionally not displayed.
- cli-mode: point the help section at global options.

Covers yllibed/repl PRs #34 and #41.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Covers yllibed/repl PRs #48 and #49.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- customization: replace the generic 'Spectre detects automatically'
  claim with the actual behavior — host detection gates colors, tiered
  Unicode box-drawing fallback, CI enrichers disabled, and the
  SpectreTerminalDetection.CurrentBoxDrawingSupport diagnostic; drop a
  duplicated sentence.
- terminal-integration: true-color is requested only when the host gate
  allows ANSI.

Completes the passages deliberately deferred until yllibed/repl#47
merged (now in v0.11.0-dev.124+).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@carldebilly carldebilly changed the title docs: shell-integration marks reference and accurate ANSI detection chain docs: catch up with recent repl merges (terminal integration, completion, global options, MCP prompts) Jul 15, 2026
@carldebilly
carldebilly marked this pull request as ready for review July 15, 2026 17:33
@carldebilly

Copy link
Copy Markdown
Member Author

@codex, please make a review here.

@carldebilly
carldebilly requested a review from autocarl July 15, 2026 17:36

@autocarl autocarl 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.

Quick documentation review of exact head 5c61ddcd253b6d4b32a2e9fa3b19f48f44d02f33. The content matches the corresponding repl implementation overall, and npm run docs:validate passes locally. One API-reference accuracy issue blocks approval: the configuration table documents a .WithCompletion(provider) overload that does not exist; see the inline comment. GitHub docs CI is green.

Comment thread src/content/docs/reference/configuration.mdx Outdated

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5c61ddcd25

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread src/content/docs/reference/terminal-integration.mdx
- configuration: show the real WithCompletion overload shape
  (targetName, provider[, scope]) instead of a non-existent
  .WithCompletion(provider) form.
- terminal-integration: add ShellIntegrationMarks and the vscode
  identity to the capability classifier table; note the OSC 633
  dialect selection and ConEmu's deliberate exclusion.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@carldebilly
carldebilly requested a review from autocarl July 15, 2026 17:46

@autocarl autocarl 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.

Approved exact head 6be34f59dbf91b3ea226c8fb54725ee0b23260ce. The documented completion signature now matches the public CommandBuilder overloads (targetName, provider[, scope]). The additional terminal-capability table updates also match TerminalCapabilitiesClassifier (including vscode, ShellIntegrationMarks, and ConEmu exclusion). GitHub docs CI is green; local npm run docs:validate passes; git diff --check passes; detached worktree is clean; no review thread remains open.

@carldebilly
carldebilly merged commit 245a71f into main Jul 15, 2026
1 check passed
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.

2 participants