Skip to content

Navigation Menu

Explore
By company size
By use case
By industry
View all solutions
Topics
- AI
- DevOps
- Security
- Software Development
- View all
Explore
- GitHub Sponsors
  Fund open source developers
- The ReadME Project
  GitHub community articles
Repositories
- Enterprise platform
  AI-powered developer platform
Available add-ons
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

Sign up

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

reeflective / readline Public

Notifications You must be signed in to change notification settings
Fork 14
Star 113

Code
Issues 3
Pull requests 1
Actions
Projects
Wiki
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Actions
Projects
Wiki
Security
Insights

Home

Jump to bottom

maxlandon edited this page Jan 3, 2023 · 28 revisions

Documentation

Introduction
Configuration file
Keymaps & Widgets
Prompts
History Sources
Vim mode
Custom callbacks & handlers
Completions & Hints
Other features

Toggle table of contents Pages 14

Home
Completions & Hints
Configuration File
Default Binds & Options
History Sources
Introduction
Keymaps & Commands
Macros
Multiline
Options
Programmable Commands
Prompts
Syntax Highlighting
Vim Mode

Home

Users

Options

Introduction
Setting options in the .inputrc file
Options

Keymaps & Commands

Table of Contents
Keymaps
Commands

Default Binds & Options

Options
Emacs
Vim
Completion & Isearch

Macros

Emacs mode
Vim mode

Vim (additional features)

Registers
Text objects (examples)

Developers

Introduction

Current shell libraries
Original readline compatiblity
Aims and choices of this package
- Architecture & inspirations
- Simpler APIs, same user experience

Configuration File

Loading configurations
Global options
Key bindings

History Sources

File-based command history
Adding and removing histories
Custom history sources

Prompts

Prompt handlers
Logging to the shell

Programable Commands

Introduction
Accessing readline components
The keymap engine
Example 1: Adding a URL-selection command
Example 2: Adding a surround-change command

Completions & Hints

The Completions container
Completion Candidates
Autosuffix removal
Hints and usage strings

Syntax Highlighting

Builtin highlighting
Writing the callback

Multiline support

Writing the callback
Example

Clone this wiki locally

Footer

© 2025 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Docs
Contact

You can’t perform that action at this time.