[![Build Status](https://travis-ci.org/chzyer/readline.svg?branch=master)](https://travis-ci.org/chzyer/readline)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)
[![Version](https://img.shields.io/github/tag/chzyer/readline.svg)](https://github.com/chzyer/readline/releases)
[![GoDoc](https://pkg.go.dev/github.com/chzyer/readline?status.svg)](https://pkg.go.dev/github.com/chzyer/readline)

The most popular multi-platform readline library for Go, featuring powerful line editing capabilities.

## Features

- Multi-platform support
- Line editing with common shortcut keys
- History support with customizable persistence
- Completion support
- Custom prompt support

## Guide

* [Demo](example/readline-demo/readline-demo.go)
* [Keyboard Shortcuts](doc/shortcut.md)
* [API Documentation](https://pkg.go.dev/github.com/chzyer/readline)

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=chzyer/readline&type=Date)](https://star-history.com/#chzyer/readline&Date)

## Contributors

<a href="https://github.com/chzyer/readline/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=chzyer/readline" alt="Readline project contributors" />
</a>