Copyright	This file is part of the package byline. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at: https://github.com/pjones/byline No part of this package including this file may be copied modified propagated or distributed except according to the terms contained in the LICENSE file.
License	BSD-2-Clause
Safe Haskell	None
Language	Haskell2010

Byline.Shell

Contents

Description

Interactive shells.

Synopsis

Shell-like Interfaces

A type that describes how to process user-entered shells.

Since: 1.1.0.0

Constructors

Shell
Fields shellPrefs :: ParserPrefs Optparse-applicative parser preferences. If you don't have any specific needs you can use `defaultPrefs` to get the default parser preferences. shellInfo :: ParserInfo a The shell parser wrapped in a `ParserInfo`. This is generally created with the `info` function. shellPrompt :: Stylized Text The prompt to display.

runShell :: MonadByline m => (a -> m ()) -> Shell a -> m () Source #

Run a single iteration of the shell.

Since: 1.1.0.0

Print a list of shell commands.

Since: 1.1.0.0

A completion function for shell commands.

Adds completion for subcommand names and their flags.

Since: 1.1.0.0

Re-exports