feat(cli): add experimental.useOSC52Copy setting

[scidomino]

Summary

Adds an experimental setting experimental.useOSC52Copy to allow users to force the use of OSC 52 escape sequences for copying to the clipboard, bypassing clipboardy.

Details

• Added useOSC52Copy to settingsSchema.ts and settings.schema.json.
• Updated copyToClipboard in commandUtils.ts to respect this setting, bypassing the standard SSH/WSL heuristics if enabled.
• Updated copyCommand.ts to pass the settings to copyToClipboard.
• Added tests to verify the new behavior.
• Updated documentation.

Related Issues

Fixes #19086

How to Validate

1. Set "experimental": { "useOSC52Copy": true } in your config.json.
2. Run a command that generates output.
3. Run /copy.
4. Verify the content is in your system clipboard.
5. (Optional) Verify in an environment where standard clipboard tools fail (e.g., Emacs eat terminal).

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed)
• Noted breaking changes (if any)
• Validated on required platforms/methods:
  • MacOS
    • npm run

[gemini-code-assist]

Summary of Changes

Hello @scidomino, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new experimental configuration option that allows users to explicitly control the clipboard copy mechanism. By enabling experimental.useOSC52Copy, users can force the use of OSC 52 escape sequences for copying content, which is particularly beneficial in remote environments or specific terminal setups where standard clipboard tools might be unreliable. This enhancement provides greater flexibility and robustness for clipboard operations within the CLI.

Highlights

• New Experimental Setting: Introduced an experimental setting experimental.useOSC52Copy to explicitly enable OSC 52 for clipboard copying, bypassing clipboardy.
• Clipboard Logic Update: Modified the copyToClipboard utility to respect this new setting, allowing users to force OSC 52 usage in specific environments.
• Documentation and Schema: Updated relevant documentation and schema definitions to reflect the new useOSC52Copy setting.
• Test Coverage: Added comprehensive tests to ensure the correct behavior of the new setting and the copyToClipboard function.

Changelog

• docs/cli/settings.md
  • Documented the new experimental.useOSC52Copy setting.
• docs/get-started/configuration.md
  • Added detailed description for the experimental.useOSC52Copy setting.
• packages/cli/src/config/settings.ts
  • Added a getSettings() method to LoadedSettings to retrieve the merged settings.
• packages/cli/src/config/settingsSchema.ts
  • Defined the experimental.useOSC52Copy boolean setting within the settings schema.
• packages/cli/src/test-utils/mockCommandContext.ts
  • Updated the mock command context to include the getSettings method for testing.
• packages/cli/src/ui/commands/copyCommand.test.ts
  • Modified test calls to mockCopyToClipboard to pass expect.anything() for the new settings parameter.
• packages/cli/src/ui/commands/copyCommand.ts
  • Retrieved current settings and passed them to the copyToClipboard function.
• packages/cli/src/ui/utils/commandUtils.test.ts
  • Added a new test case to verify OSC-52 usage when useOSC52Copy is enabled, even without SSH/WSL heuristics.
• packages/cli/src/ui/utils/commandUtils.ts
  • Updated shouldUseOsc52 to incorporate the experimental.useOSC52Copy setting.
  • Modified copyToClipboard to accept an optional Settings object.
• schemas/settings.schema.json
  • Added the useOSC52Copy property to the main JSON schema for settings.

Activity

• Updated relevant documentation and README.
• Added/updated tests for the new functionality.
• Validated the changes on MacOS.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a new experimental setting experimental.useOSC52Copy to allow users to force OSC 52 for clipboard copy operations. The changes are well-implemented across the configuration schema, command logic, and utility functions. The addition of corresponding documentation and tests, including a specific test for the new setting's behavior, is thorough. The code quality is good, and I don't see any critical or high-severity issues.

[github-actions]

Size Change: +146 B (0%)

Total Size: 24.5 MB

ℹ️ View Unchanged

Filename	Size	Change
./bundle/gemini.js	24.5 MB	+146 B (0%)
./bundle/sandbox-macos-permissive-open.sb	890 B	0 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB	0 B
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB	0 B
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB	0 B
./bundle/sandbox-macos-strict-open.sb	4.82 kB	0 B
./bundle/sandbox-macos-strict-proxied.sb	5.02 kB	0 B

_{compressed-size-action}

[lesteral]

@scidomino - thank you very much. This works well. Regards, Lester