-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: cli newline keybinding #6823
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
There was a problem hiding this 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_KEYto 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 |
Copilot
AI
Jan 30, 2026
There was a problem hiding this comment.
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.
| - **`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 |
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <[email protected]>
There was a problem hiding this 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.
* '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)
* 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)
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Summary
This PR documents the
GOOSE_CLI_NEWLINE_KEYcustomization feature.Documentation updates:
documentation/docs/guides/environment-variables.md:GOOSE_CLI_NEWLINE_KEYto "Session Management" table and examplesdocumentation/docs/guides/goose-cli-commands.md:Ctrl+Jdescription to doc customizationCtrl+Cdescription to sync with behaviorType of Change
AI Assistance
Testing
Manual testing