Safe Haskell	None
Language	Haskell98

Shelly.Lifted

Contents

Entering Sh.
Running external commands.
Running commands Using handles
Modifying and querying environment.
Environment directory
Printing
Querying filesystem.
Filename helpers
Manipulating filesystem.
reading/writing Files
exiting the program
Exceptions
convert between Text and FilePath
Utility Functions
Re-exported for your convenience
internal functions for writing extensions
find functions

Description

A module for shell-like programming in Haskell. Shelly's focus is entirely on ease of use for those coming from shell scripting. However, it also tries to use modern libraries and techniques to keep things efficient.

The functionality provided by this module is (unlike standard Haskell filesystem functionality) thread-safe: each Sh maintains its own environment and its own working directory.

Recommended usage includes putting the following at the top of your program, otherwise you will likely need either type annotations or type conversions

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ExtendedDefaultRules #-}
{-# OPTIONS_GHC -fno-warn-type-defaults #-}
import Shelly
import qualified Data.Text as T
default (T.Text)

Synopsis

Documentation

class Monad m => MonadSh m where

Methods

liftSh :: Sh a -> m a

Instances

MonadSh Sh
MonadSh m => MonadSh (ListT m)
MonadSh m => MonadSh (MaybeT m)
MonadSh m => MonadSh (IdentityT m)
MonadSh m => MonadSh (ContT r m)
MonadSh m => MonadSh (ReaderT r m)
MonadSh m => MonadSh (StateT s m)
MonadSh m => MonadSh (StateT s m)
(Error e, MonadSh m) => MonadSh (ErrorT e m)
(Monoid w, MonadSh m) => MonadSh (WriterT w m)
(Monoid w, MonadSh m) => MonadSh (WriterT w m)
(Monoid w, MonadSh m) => MonadSh (RWST r w s m)
(Monoid w, MonadSh m) => MonadSh (RWST r w s m)

Entering Sh.

data Sh a

Instances

Monad Sh
Functor Sh
Applicative Sh
MonadThrow Sh
MonadCatch Sh
MonadMask Sh
MonadIO Sh
MonadSh Sh
MonadBase IO Sh
MonadBaseControl IO Sh
ShellCmd (Sh ())
((~) * s Text, Show s) => ShellCmd (Sh s)
ShellCmd (Sh Text)
type StM Sh a

type ShIO a = Sh a

Deprecated: Use Sh instead of ShIO

ShIO is Deprecated in favor of Sh, which is easier to type.

shelly :: MonadIO m => Sh a -> m a

Enter a Sh from (Monad)IO. The environment and working directories are inherited from the current process-wide values. Any subsequent changes in processwide working directory or environment are not reflected in the running Sh.

shellyNoDir :: MonadIO m => Sh a -> m a

Deprecated: Just use shelly. The default settings have changed

Deprecated now, just use shelly, whose default has been changed. Using this entry point does not create a .shelly directory in the case of failure. Instead it logs directly into the standard error stream (stderr).

shellyFailDir :: MonadIO m => Sh a -> m a

Using this entry point creates a .shelly directory in the case of failure where errors are recorded.

sub :: MonadShControl m => m a -> m a

silently :: MonadShControl m => m a -> m a

verbosely :: MonadShControl m => m a -> m a

escaping :: MonadShControl m => Bool -> m a -> m a

print_stdout :: MonadShControl m => Bool -> m a -> m a

print_stderr :: MonadShControl m => Bool -> m a -> m a

print_commands :: MonadShControl m => Bool -> m a -> m a

tracing :: MonadShControl m => Bool -> m a -> m a

errExit :: MonadShControl m => Bool -> m a -> m a

log_stdout_with :: MonadShControl m => (Text -> IO ()) -> m a -> m a

log_stderr_with :: MonadShControl m => (Text -> IO ()) -> m a -> m a

Running external commands.

run :: MonadSh m => FilePath -> [Text] -> m Text

run_ :: MonadSh m => FilePath -> [Text] -> m ()

runFoldLines :: MonadSh m => a -> FoldCallback a -> FilePath -> [Text] -> m a

cmd :: ShellCmd result => FilePath -> result

variadic argument version of run. Please see the documenation for run.

The syntax is more convenient, but more importantly it also allows the use of a FilePath as a command argument. So an argument can be a Text or a FilePath without manual conversions. a FilePath is automatically converted to Text with toTextIgnore.

Convenient usage of cmd requires the following:

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ExtendedDefaultRules #-}
{-# OPTIONS_GHC -fno-warn-type-defaults #-}
import Shelly
import qualified Data.Text as T
default (T.Text)

type FoldCallback a = a -> Text -> a

(-|-) :: (MonadShControl m, MonadSh m) => m Text -> m b -> m b

lastStderr :: MonadSh m => m Text

setStdin :: MonadSh m => Text -> m ()

lastExitCode :: MonadSh m => m Int

command :: MonadSh m => FilePath -> [Text] -> [Text] -> m Text

command_ :: MonadSh m => FilePath -> [Text] -> [Text] -> m ()

command1 :: MonadSh m => FilePath -> [Text] -> Text -> [Text] -> m Text

command1_ :: MonadSh m => FilePath -> [Text] -> Text -> [Text] -> m ()

sshPairs :: MonadSh m => Text -> [(FilePath, [Text])] -> m Text

sshPairs_ :: MonadSh m => Text -> [(FilePath, [Text])] -> m ()

class ShellCmd t where

For the variadic function cmd

partially applied variadic functions require type signatures

Methods

cmdAll :: FilePath -> [Text] -> t

Instances

ShellCmd (Sh ())
((~) * s Text, Show s) => ShellCmd (Sh s)
ShellCmd (Sh Text)
(CmdArg arg, ShellCmd result) => ShellCmd ([arg] -> result)
(CmdArg arg, ShellCmd result) => ShellCmd (arg -> result)

class CmdArg a where

Argument converter for the variadic argument version of run called cmd. Useful for a type signature of a function that uses cmd

Methods

toTextArg :: a -> Text

Instances

CmdArg String
CmdArg Text
CmdArg FilePath

Running commands Using handles

runHandle

Arguments

:: MonadShControl m
=> FilePath	command
-> [Text]	arguments
-> (Handle -> m a)	stdout handle
-> m a

runHandles

Arguments

:: MonadShControl m
=> FilePath	command
-> [Text]	arguments
-> [StdHandle]	optionally connect process i/o handles to existing handles
-> (Handle -> Handle -> Handle -> m a)	stdin, stdout and stderr
-> m a

transferLinesAndCombine :: MonadIO m => Handle -> (Text -> IO ()) -> m Text

transferFoldHandleLines :: a -> FoldCallback a -> Handle -> (Text -> IO ()) -> IO a

Transfer from one handle to another For example, send contents of a process output to stdout. does not close the write handle.

Also, fold over the contents being streamed line by line

data StdHandle

Constructors

InHandle StdStream
OutHandle StdStream
ErrorHandle StdStream

data StdStream :: *

Constructors

Inherit	Inherit Handle from parent
UseHandle Handle	Use the supplied Handle
CreatePipe	Create a new pipe. The returned `Handle` will use the default encoding and newline translation mode (just like `Handle`s created by `openFile`).

Modifying and querying environment.

setenv :: MonadSh m => Text -> Text -> m ()

get_env :: MonadSh m => Text -> m (Maybe Text)

get_env_text :: MonadSh m => Text -> m Text

get_env_all :: MonadSh m => m [(String, String)]

appendToPath :: MonadSh m => FilePath -> m ()

Environment directory

cd :: MonadSh m => FilePath -> m ()

chdir :: MonadShControl m => FilePath -> m a -> m a

chdir_p :: MonadShControl m => FilePath -> m a -> m a

pwd :: MonadSh m => m FilePath

Printing

echo :: MonadSh m => Text -> m ()

echo_n :: MonadSh m => Text -> m ()

echo_err :: MonadSh m => Text -> m ()

echo_n_err :: MonadSh m => Text -> m ()

inspect :: (Show s, MonadSh m) => s -> m ()

inspect_err :: (Show s, MonadSh m) => s -> m ()

tag :: (MonadShControl m, MonadSh m) => m a -> Text -> m a

trace :: MonadSh m => Text -> m ()

show_command :: FilePath -> [Text] -> Text

Querying filesystem.

ls :: MonadSh m => FilePath -> m [FilePath]

lsT :: MonadSh m => FilePath -> m [Text]

test_e :: MonadSh m => FilePath -> m Bool

test_f :: MonadSh m => FilePath -> m Bool

test_d :: MonadSh m => FilePath -> m Bool

test_s :: MonadSh m => FilePath -> m Bool

test_px :: MonadSh m => FilePath -> m Bool

which :: MonadSh m => FilePath -> m (Maybe FilePath)

Filename helpers

absPath :: MonadSh m => FilePath -> m FilePath

(</>) :: (ToFilePath filepath1, ToFilePath filepath2) => filepath1 -> filepath2 -> FilePath

uses System.FilePath.CurrentOS, but can automatically convert a Text

(<.>) :: ToFilePath filepath => filepath -> Text -> FilePath

uses System.FilePath.CurrentOS, but can automatically convert a Text

canonic :: MonadSh m => FilePath -> m FilePath

canonicalize :: MonadSh m => FilePath -> m FilePath

Obtain a (reasonably) canonic file path to a filesystem object. Based on "canonicalizePath" in system-fileio.

relPath :: MonadSh m => FilePath -> m FilePath

relativeTo

Arguments

:: MonadSh m
=> FilePath	anchor path, the prefix
-> FilePath	make this relative to anchor path
-> m FilePath

hasExt :: Text -> FilePath -> Bool

flipped hasExtension for Text

Manipulating filesystem.

mv :: MonadSh m => FilePath -> FilePath -> m ()

rm :: MonadSh m => FilePath -> m ()

rm_f :: MonadSh m => FilePath -> m ()

rm_rf :: MonadSh m => FilePath -> m ()

cp :: MonadSh m => FilePath -> FilePath -> m ()

cp_r :: MonadSh m => FilePath -> FilePath -> m ()

mkdir :: MonadSh m => FilePath -> m ()

mkdir_p :: MonadSh m => FilePath -> m ()

mkdirTree :: MonadSh m => Tree FilePath -> m ()

reading/writing Files

readfile :: MonadSh m => FilePath -> m Text

readBinary :: MonadSh m => FilePath -> m ByteString

writefile :: MonadSh m => FilePath -> Text -> m ()

appendfile :: MonadSh m => FilePath -> Text -> m ()

touchfile :: MonadSh m => FilePath -> m ()

withTmpDir :: MonadShControl m => (FilePath -> m a) -> m a

exiting the program

exit :: MonadSh m => Int -> m a

errorExit :: MonadSh m => Text -> m a

quietExit :: MonadSh m => Int -> m a

terror :: MonadSh m => Text -> m a

Exceptions

bracket_sh :: Sh a -> (a -> Sh b) -> (a -> Sh c) -> Sh c

Deprecated: use Control.Exception.Lifted.bracket instead

catchany :: MonadBaseControl IO m => m a -> (SomeException -> m a) -> m a

catch_sh :: Exception e => Sh a -> (e -> Sh a) -> Sh a

Deprecated: use Control.Exception.Lifted.catch instead

handle_sh :: Exception e => (e -> Sh a) -> Sh a -> Sh a

Deprecated: use Control.Exception.Lifted.handle instead

handleany_sh :: (SomeException -> Sh a) -> Sh a -> Sh a

Deprecated: use Control.Exception.Enclosed.handleAny instead

finally_sh :: Sh a -> Sh b -> Sh a

Deprecated: use Control.Exception.Lifted.finally instead

catches_sh :: Sh a -> [Handler Sh a] -> Sh a

Deprecated: use Control.Exception.Lifted.catches instead

catchany_sh :: Sh a -> (SomeException -> Sh a) -> Sh a

Deprecated: use Control.Exception.Enclosed.catchAny instead

convert between Text and FilePath

toTextIgnore :: FilePath -> Text

silently uses the Right or Left value of "Filesystem.Path.CurrentOS.toText"

toTextWarn :: MonadSh m => FilePath -> m Text

fromText :: Text -> FilePath

Convert human‐readable text into a FilePath.

This function ignores the user’s locale, and assumes all file paths are encoded in UTF8. If you need to create file paths with an unusual or obscure encoding, encode them manually and then use decode.

Since: 0.2

Utility Functions

whenM :: Monad m => m Bool -> m () -> m ()

A monadic-conditional version of the "when" guard.

unlessM :: Monad m => m Bool -> m () -> m ()

A monadic-conditional version of the unless guard.

time :: MonadShControl m => m a -> m (Double, a)

sleep :: MonadSh m => Int -> m ()

Re-exported for your convenience

liftIO :: MonadIO m => forall a. IO a -> m a

Lift a computation from the IO monad.

when :: Applicative f => Bool -> f () -> f ()

Conditional execution of Applicative expressions. For example,

when debug (putStrLn "Debugging")

will output the string Debugging if the Boolean value debug is True, and otherwise do nothing.

unless :: Applicative f => Bool -> f () -> f ()

The reverse of when.

data FilePath :: *

Instances

Eq FilePath
Data FilePath
Ord FilePath
NFData FilePath
CmdArg FilePath

(<$>) :: Functor f => (a -> b) -> f a -> f b infixl 4

An infix synonym for fmap.

Examples

Convert from a Maybe Int to a Maybe String using show:

>>> show <$> Nothing
Nothing
>>> show <$> Just 3
Just "3"

Convert from an Either Int Int to an Either Int String using show:

>>> show <$> Left 17
Left 17
>>> show <$> Right 17
Right "17"

Double each element of a list:

>>> (*2) <$> [1,2,3]
[2,4,6]

Apply even to the second element of a pair:

>>> even <$> (2,2)
(2,True)

internal functions for writing extensions

get :: MonadSh m => m State

put :: MonadSh m => State -> m ()

find functions

find :: FilePath -> Sh [FilePath]

List directory recursively (like the POSIX utility "find"). listing is relative if the path given is relative. If you want to filter out some results or fold over them you can do that with the returned files. A more efficient approach is to use one of the other find functions.

findWhen :: (FilePath -> Sh Bool) -> FilePath -> Sh [FilePath]

find that filters the found files as it finds. Files must satisfy the given filter to be returned in the result.

findFold :: (a -> FilePath -> Sh a) -> a -> FilePath -> Sh a

Fold an arbitrary folding function over files froma a find. Like findWhen but use a more general fold rather than a filter.

findDirFilter :: (FilePath -> Sh Bool) -> FilePath -> Sh [FilePath]

find that filters out directories as it finds Filtering out directories can make a find much more efficient by avoiding entire trees of files.

findDirFilterWhen

Arguments

:: (FilePath -> Sh Bool)	directory filter
-> (FilePath -> Sh Bool)	file filter
-> FilePath	directory
-> Sh [FilePath]

similar findWhen, but also filter out directories Alternatively, similar to findDirFilter, but also filter out files Filtering out directories makes the find much more efficient

findFoldDirFilter :: (a -> FilePath -> Sh a) -> a -> (FilePath -> Sh Bool) -> FilePath -> Sh a

like findDirFilterWhen but use a folding function rather than a filter The most general finder: you likely want a more specific one