Skip to content

Conversation

@dianed-square
Copy link
Contributor

@dianed-square dianed-square commented Jan 29, 2026

Summary

This PR documents the GOOSE_CLI_NEWLINE_KEY customization feature.

Documentation updates:

  • documentation/docs/guides/environment-variables.md:
    • Add GOOSE_CLI_NEWLINE_KEYto "Session Management" table and examples
  • documentation/docs/guides/goose-cli-commands.md:
    • Update Ctrl+J description to doc customization
    • Update Ctrl+C description to sync with behavior

Type of Change

  • Feature
  • Bug fix
  • Refactor / Code quality
  • Performance improvement
  • Documentation
  • Tests
  • Security fix
  • Build / Release
  • Other (specify below)

AI Assistance

  • This PR was created or reviewed with AI assistance

Testing

Manual testing


Copilot AI review requested due to automatic review settings January 29, 2026 23:58
@dianed-square dianed-square requested a review from a team as a code owner January 29, 2026 23:58
@github-actions
Copy link
Contributor

github-actions bot commented Jan 30, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-01-30 00:45 UTC

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR documents the GOOSE_CLI_NEWLINE_KEY environment variable that allows users to customize the keyboard shortcut for inserting newlines in the CLI. The documentation also updates the Ctrl+C behavior description.

Changes:

  • Adds GOOSE_CLI_NEWLINE_KEY to the Session Management environment variables table with usage examples
  • Documents the Ctrl+J newline shortcut customization in keyboard shortcuts section
  • Updates Ctrl+C behavior description

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
documentation/docs/guides/environment-variables.md Adds GOOSE_CLI_NEWLINE_KEY variable to Session Management table and includes usage example
documentation/docs/guides/goose-cli-commands.md Updates keyboard shortcuts to document Ctrl+C behavior and Ctrl+J customization via GOOSE_CLI_NEWLINE_KEY

**Session Control:**
- **`Ctrl+C`** - Interrupt the current request
- **`Ctrl+J`** - Add a newline
- **`Ctrl+C`** - Clear the current line if text is entered, interrupt the current request if processing, or exit the session if line is empty
Copy link

Copilot AI Jan 30, 2026

Choose a reason for hiding this comment

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

The Ctrl+C description appears inaccurate. The actual implementation in crates/goose-cli/src/session/input.rs (lines 42-57) only clears the current line if text is entered, or exits if the line is empty. It does not interrupt a request during processing. The behavior should be documented as "Clear the current line if text is entered, or exit the session if line is empty" to match the actual code behavior.

Suggested change
- **`Ctrl+C`** - Clear the current line if text is entered, interrupt the current request if processing, or exit the session if line is empty
- **`Ctrl+C`** - Clear the current line if text is entered, or exit the session if the line is empty

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Per testing, it does interrupt:
^CInterrupted before the model replied and removed the last message.

Copilot AI review requested due to automatic review settings January 30, 2026 00:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@dianed-square dianed-square merged commit 22e10b1 into main Jan 30, 2026
26 checks passed
@dianed-square dianed-square deleted the docs/cli-newline-key branch January 30, 2026 00:40
zanesq added a commit that referenced this pull request Jan 30, 2026
* 'main' of github.com:block/goose:
  Fix: Small update UI settings prompt injection (#6830)
  Remove autogenerated .gooseignore files that don't belong in repo (#6824)
  Fix case-insensitive matching for builtin extension names (#6825)
  docs: cli newline keybinding (#6823)
  Update version to 1.22.0 (#6821)
  Refactor: move persisting extension to session outside of route (#6685)
  acp: load configured extensions and refactor tests (#6803)
  docs: usage data collection (#6822)
  feat: platform extension migrator + code mode rename (#6611)
  feat: CLI flag to skip loading profile extensions (#6780)
lifeizhou-ap added a commit that referenced this pull request Feb 2, 2026
* main:
  fix: fixed the broken release (#6887)
  feat: Streamable HTTP transport for ACP + goose-acp usage (#6741)
  Add Laminar for Observability (#6514)
  Missed a couple of places that hard code J for the newline key (#6853)
  fix(ui): preserve working directory when creating new chat (#6789)
  blog: add 5 tips for building MCP Apps that work (#6855)
  docs: session isolation (#6846)
  upgrade react and electron to latest (#6845)
  Fix: Small update UI settings prompt injection (#6830)
  Remove autogenerated .gooseignore files that don't belong in repo (#6824)
  Fix case-insensitive matching for builtin extension names (#6825)
  docs: cli newline keybinding (#6823)
  Update version to 1.22.0 (#6821)
  Refactor: move persisting extension to session outside of route (#6685)
  acp: load configured extensions and refactor tests (#6803)
Tyler-Hardin pushed a commit to Tyler-Hardin/goose that referenced this pull request Feb 11, 2026
Tyler-Hardin pushed a commit to Tyler-Hardin/goose that referenced this pull request Feb 11, 2026
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