Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

When Bash prompts you for a command, a library called [readline](https://www.gnu.org/software/bash/manual/html_node/Command-Line-Editing.html) handles your keystrokes. Readline lacks many features users have come to expect. Flyline is a readline replacement that provides an enhanced line editing experience with:
- Undo and redo support
- [Agent assisted command writing](#agent-mode)
- [Rich prompt customizations, (asynchronous widgets), and animations](#rich-prompts)
- [Agent-assisted command writing](#agent-mode)
- [Rich prompt customizations, asynchronous widgets, and animations](#rich-prompts)
- [Fuzzy history searching](#command-history)
- [Mouse support](#mouse-support)
- [Improvements to Bash's tab completion](#tab-completion-improvements)
Expand Down Expand Up @@ -450,7 +450,7 @@ Two possible fixes are:
- Use a terminal emulator that supports [Kitty's extended keyboard protocol](https://sw.kovidgoyal.net/kitty/keyboard-protocol/). This allows flyline to receive `Command+<KEY>` events.

## Shell integration
Flyline prints [OSC 133](https://sw.kovidgoyal.net/kitty/shell-integration/#notes-for-shell-developers) and [OSC 633](https://code.visualstudio.com/docs/terminal/shell-integration#_supported-escape-sequences) escape codes to integrate the shell with the terminal. These are on by default and can be disabled with `flyline --send-shell-integration-codes none`.
Flyline can emit [OSC 133](https://sw.kovidgoyal.net/kitty/shell-integration/#notes-for-shell-developers) and [OSC 633](https://code.visualstudio.com/docs/terminal/shell-integration#_supported-escape-sequences) escape codes to integrate the shell with the terminal. By default it sends only the prompt-position codes (`only-prompt-pos`); use `flyline --send-shell-integration-codes full` for the full set, or `flyline --send-shell-integration-codes none` to disable them entirely.

# Settings

Expand Down Expand Up @@ -501,7 +501,7 @@ Options:
- smart: Mouse capture is on by default with automatic management: disabled on scroll or when the user clicks above the viewport, re-enabled on any keypress or when focus is regained. Also can manually toggle with Escape

--send-shell-integration-codes [<SEND_SHELL_INTEGRATION_CODES>]
Send shell integration escape codes (OSC 133 / OSC 633): none, only-prompt-pos, or full
Send shell integration escape codes (OSC 133 / OSC 633): none, only-prompt-pos, or full. Default is `only-prompt-pos`

Possible values:
- none: Send no shell integration codes
Expand Down
2 changes: 1 addition & 1 deletion examples/settings.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# These would go in your .bashrc after enabling flyline. See flyline --help for more details.
# These commands would go in your .bashrc after enabling flyline. See `flyline --help` for more details.
flyline --load-zsh-history
flyline set-cursor --backend terminal
flyline --set-mouse-mode disabled
Expand Down
3 changes: 2 additions & 1 deletion src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ struct FlylineArgs {
/// Mouse capture mode (disabled, simple, smart). Default is smart.
#[arg(long = "set-mouse-mode", value_name = "MODE")]
mouse_mode: Option<settings::MouseMode>,
/// Send shell integration escape codes (OSC 133 / OSC 633): none, only-prompt-pos, or full
/// Send shell integration escape codes (OSC 133 / OSC 633): none, only-prompt-pos, or full.
/// Default is `only-prompt-pos`.
#[arg(long = "send-shell-integration-codes", default_missing_value = "only-prompt-pos", num_args = 0..=1)]
send_shell_integration_codes: Option<settings::ShellIntegrationLevel>,
/// Whether to request the use of extended (kitty-protocol) keyboard codes during startup.
Expand Down
4 changes: 2 additions & 2 deletions src/tutorial.rs
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ pub fn generate_tutorial_text(
ts_text("."),
]));
lines.push(TaggedLine::from(vec![ts_text(
"Typing enables mouse capture.",
"In smart mode, any keypress re-enables mouse capture.",
)]));

lines.push(empty());
Expand Down Expand Up @@ -629,7 +629,7 @@ pub fn generate_tutorial_text(
text_style,
)));
lines.push(tl(Span::styled(
"This works for parentheses (), square brackets [], curly braces {}, and quotes \" \".",
"This works for parentheses (), square brackets [], curly braces {}, single and double quotes, and backticks.",
text_style,
)));
lines.push(empty());
Expand Down