# cli_repl 0.0.1

A simple library for CLI REPLs




## Installing
```
export PUB_HOSTED_URL=https://pub.mirror.p-hatan.ir
flutter pub add 'cli_repl:0.0.1'
```
Published: 2018-04-05T19:21:28.343553Z
Expected archive SHA-256: 555fec6b6c8b3e7d6742ceb98da0a31de90d82bc27922c38faa198a161dce580

Available in cache; verification: upstream_checksum
## Direct dependencies
- async: ^1.13.3
- io: ^0.3.2

## Package README (untrusted upstream documentation)
# cli_repl

A simple library for creating CLI REPLs in Dart.

## Features

Example Usage:

```dart
/// Echoes all entered lines
await for (var line in new Repl().run()) {
  print(line);
} 
```

### Statement Validation

By passing a `validator` to the `Repl` constructor, you can tell the REPL
whether some entered text is a complete statement or not. The REPL calls this
whenever a newline is entered to determine whether to yield a complete statement
or continue it on a new line. The default validator returns true for all text.

### Custom Prompts

By default, the REPL gives no prompt to the user when asking for a statement.
You can change this by passing a `prompt` to the `Repl` constructor. By default,
statement continuations on a new line will start with whitespace equal to the
length of the `prompt`. You can override this by passing in `continuation`.

See `example/example.dart` for a demonstration of statement validation and
custom prompts.

### History

A history of entered lines is stored. History entries are modified when edited.

By default, a maximum of 50 entries are stored. You can change this by passing
`maxHistory` into the `Repl` constructor.

### Navigation

- `Left`/`Ctrl-B`: Move left one character
- `Right`/`Ctrl-F`: Move right one character
- `Home`/`Ctrl-A`: Move to start of line
- `End`/`Ctrl-E`: Move to end of line
- `Ctrl-L`: Clear the screen
- `Ctrl-D`: If there is text, delete the character under the cursor. If there is
no text, exit.
- `Ctrl-F`: Moves forward one character
- `Ctrl-B`: Moves backward one character
- `Ctrl-U`: Delete to start of line
- `Ctrl-K`: Delete to end of line
- `Up`/`Down`: Navigate within history

## Changelog
# Changelog

## 0.0.1

- Initial release