Shelly

A module for shell-like / perl-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 ShIO maintains its own environment and its own working directory.

I highly recommend 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 Data.Text.Lazy as LT
 default (LT.Text)

Entering ShIO.

type ShIO a = ReaderT (IORef State) IO a

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

Enter a ShIO 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 ShIO.

sub :: ShIO a -> ShIO a

Enter a sub-ShIO that inherits the environment The original state will be restored when the sub-ShIO completes. Exceptions are propagated normally.

silently :: ShIO a -> ShIO a

Create a sub-ShIO in which external command outputs are not echoed. Also commands are not printed. See sub.

verbosely :: ShIO a -> ShIO a

Create a sub-ShIO in which external command outputs are echoed. Executed commands are printed See sub.

escaping :: Bool -> ShIO a -> ShIO a

print_stdout :: Bool -> ShIO a -> ShIO a

Turn on/off printing stdout

print_commands :: Bool -> ShIO a -> ShIO a

Turn on/off command echoing.

Running external commands.

run :: FilePath -> [Text] -> ShIO Text

Execute an external command. Takes the command name (no shell allowed, just a name of something that can be found via PATH; FIXME: setenv'd PATH is not taken into account when finding the exe name)

stdout and stderr are collected. The stdout is returned as a result of run, and complete stderr output is available after the fact using lastStderr

All of the stdout output will be loaded into memory You can avoid this but still consume the result by using run_, If you want to avoid the memory and need to process the output then use runFoldLines.

run_ :: FilePath -> [Text] -> ShIO ()

cmd :: ShellCommand result => FilePath -> result

variadic argument version of run. The syntax is more convenient but it also allows the use of a FilePath as a command argument. So an argument can be a Text or a FilePath. a FilePath is converted to Text with toTextIgnore. You will need to add the following to your module:

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

(-|-) :: ShIO Text -> ShIO b -> ShIO b

Pipe operator. set the stdout the first command as the stdin of the second.

lastStderr :: ShIO Text

The output of last external command. See run.

setStdin :: Text -> ShIO ()

set the stdin to be used and cleared by the next run.

command :: FilePath -> [Text] -> [Text] -> ShIO Text

bind some arguments to run for re-use Example: monit = command monit [-c, monitrc]

command_ :: FilePath -> [Text] -> [Text] -> ShIO ()

bind some arguments to run_ for re-use Example: monit_ = command_ monit [-c, monitrc]

command1 :: FilePath -> [Text] -> Text -> [Text] -> ShIO Text

bind some arguments to run for re-use, and expect 1 argument Example: git = command1 git []; git pull [origin, master]

command1_ :: FilePath -> [Text] -> Text -> [Text] -> ShIO ()

bind some arguments to run for re-use, and expect 1 argument Example: git_ = command1_ git []; git+ pull [origin, master]

sshPairs :: Text -> [(FilePath, [Text])] -> ShIO Text

run commands over SSH. An ssh executable is expected in your path. Commands are in the same form as run, but given as pairs

 sshPairs "server-name" [("cd", "dir"), ("rm",["-r","dir2"])]

I am not fond of this interface, but it seems to work.

Please note this sets escaping to False: the commands will not be shell escaped. I think this should be more convenient for ssh. Internally the list of commands are combined with the string && before given to ssh.

sshPairs_ :: Text -> [(FilePath, [Text])] -> ShIO ()

same as sshPairs, but returns ()

Modifying and querying environment.

setenv :: Text -> Text -> ShIO ()

Set an environment variable. The environment is maintained in ShIO internally, and is passed to any external commands to be executed.

getenv :: Text -> ShIO Text

Fetch the current value of an environment variable. Both empty and non-existent variables give empty string as a result.

getenv_def :: Text -> Text -> ShIO Text

Fetch the current value of an environment variable. Both empty and non-existent variables give the default value as a result

appendToPath :: FilePath -> ShIO ()

add the filepath onto the PATH env variable FIXME: only effects the PATH once the process is ran, as per comments in which

Environment directory

cd :: FilePath -> ShIO ()

Change current working directory of ShIO. This does *not* change the working directory of the process we are running it. Instead, ShIO keeps track of its own workking directory and builds absolute paths internally instead of passing down relative paths. This may have performance repercussions if you are doing hundreds of thousands of filesystem operations. You will want to handle these issues differently in those cases.

chdir :: FilePath -> ShIO a -> ShIO a

cd, execute a ShIO action in the new directory and then pop back to the original directory

pwd :: ShIO FilePath

Obtain the current (ShIO) working directory.

Printing

echo, echo_n_err, echo_err, echo_n :: Text -> ShIO ()

Echo text to standard (error, when using _err variants) output. The _n variants do not print a final newline.

inspect :: Show s => s -> ShIO ()

a print lifted into ShIO

inspect_err :: Show s => s -> ShIO ()

a print lifted into ShIO using stderr

tag :: ShIO a -> Text -> ShIO a

same as trace, but use it combinator style

trace :: Text -> ShIO ()

log actions that occur

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

Querying filesystem.

ls :: FilePath -> ShIO [FilePath]

List directory contents. Does *not* include "." and "..", but it does include (other) hidden files.

ls' :: FilePath -> ShIO [Text]

Get back [Text] instead of [FilePath]

test_e :: FilePath -> ShIO Bool

Does a path point to an existing filesystem object?

test_f :: FilePath -> ShIO Bool

Does a path point to an existing file?

test_d :: FilePath -> ShIO Bool

Does a path point to an existing directory?

test_s :: FilePath -> ShIO Bool

Does a path point to a symlink?

which :: FilePath -> ShIO (Maybe FilePath)

Get a full path to an executable on PATH, if exists. FIXME does not respect setenv'd environment and uses findExecutable which uses the PATH inherited from the process environment. FIXME: findExecutable does not maintain a hash of existing commands and does a ton of file stats

Finding files

find :: FilePath -> ShIO [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 -> (FilePath -> ShIO Bool) -> ShIO [FilePath]

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

findFold :: FilePath -> a -> (a -> FilePath -> ShIO a) -> ShIO 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 -> (FilePath -> ShIO Bool) -> ShIO [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

directory

-> (FilePath -> ShIO Bool)

directory filter

-> (FilePath -> ShIO Bool)

file filter

-> ShIO [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 :: FilePath -> (FilePath -> ShIO Bool) -> a -> (a -> FilePath -> ShIO a) -> ShIO a

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

Filename helpers

path :: FilePath -> ShIO FilePath

makes an absolute path. Like canonic, but on an exception returns absPath

absPath :: FilePath -> ShIO FilePath

makes an absolute path based on the working directory. path will also canonicalize

(</>) :: (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

relativeTo

Arguments

:: FilePath

anchor path, the prefix

-> FilePath

make this relative to anchor path

-> ShIO FilePath

make the second path relative to the first Uses stripPrefix, but will canonicalize the paths if necessary

canonic :: FilePath -> ShIO FilePath

Obtain a (reasonably) canonic file path to a filesystem object. Based on canonicalizePath in FileSystem.

Manipulating filesystem.

mv :: FilePath -> FilePath -> ShIO ()

Currently a renameFile wrapper. TODO: Support cross-filesystem move. TODO: Support directory paths in the second parameter, like in cp.

rm :: FilePath -> ShIO ()

Remove a file. Does fail if the file does not exist (use rm_f instead) or is not a file.

rm_f :: FilePath -> ShIO ()

Remove a file. Does not fail if the file already is not there. Does fail if the file is not a file.

rm_rf :: FilePath -> ShIO ()

A swiss army cannon for removing things. Actually this goes farther than a normal rm -rf, as it will circumvent permission problems for the files we own. Use carefully. Uses removeTree

cp :: FilePath -> FilePath -> ShIO ()

Copy a file. The second path could be a directory, in which case the original file name is used, in that directory.

cp_r :: FilePath -> FilePath -> ShIO ()

Copy a file, or a directory recursively.

mkdir :: FilePath -> ShIO ()

Create a new directory (fails if the directory exists).

mkdir_p :: FilePath -> ShIO ()

Create a new directory, including parents (succeeds if the directory already exists).

readfile :: FilePath -> ShIO Text

(Strictly) read file into a Text. All other functions use Lazy Text. So Internally this reads a file as strict text and then converts it to lazy text, which is inefficient

writefile :: FilePath -> Text -> ShIO ()

Write a Lazy Text to a file.

appendfile :: FilePath -> Text -> ShIO ()

Append a Lazy Text to a file.

withTmpDir :: (FilePath -> ShIO a) -> ShIO a

Create a temporary directory and pass it as a parameter to a ShIO computation. The directory is nuked afterwards.

exiting the program

exit :: Int -> ShIO ()

errorExit :: Text -> ShIO ()

terror :: Text -> ShIO a

fail that takes a Text

Utilities.

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

An infix synonym for fmap.

(<$$>) :: Functor m => (b -> c) -> (a -> m b) -> a -> m c

A functor-lifting function composition.

grep :: PredicateLike pattern hay => pattern -> [hay] -> [hay]

Like filter, but more conveniently used with String lists, where a substring match (TODO: also provide globs) is expressed as grep "needle" [ "the", "stack", "of", "hay" ]. Boolean predicates just like with filter are supported too: grep ("fun" isPrefixOf) [...].

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.

catchany :: IO a -> (SomeException -> IO a) -> IO a

A helper to catch any exception (same as ... catch (e :: SomeException) -> ...).

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

Catch an exception in the ShIO monad.

data ShellyHandler a

You need this when using catches_sh.

Constructors

forall e . Exception e => ShellyHandler (e -> ShIO a)

catches_sh :: ShIO a -> [ShellyHandler a] -> ShIO a

Catch multiple exceptions in the ShIO monad.

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

Catch an exception in the ShIO monad.

data Timing

Constructors

Timing Double

Instances

Eq Timing

Ord Timing

Read Timing

Show Timing

time :: ShIO a -> ShIO (Timing, a)

Run a ShIO computation and collect timing information.

data RunFailed

Constructors

RunFailed FilePath [Text] Int Text

Instances

Show RunFailed

Typeable RunFailed

Exception RunFailed

convert between Text and FilePath

toTextIgnore :: FilePath -> Text

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

toTextWarn :: FilePath -> ShIO Text

fromText :: Text -> FilePath

Re-exported for your convenience

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

Lift a computation from the IO monad.

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

Conditional execution of monadic expressions. For example,

       when debug (putStr "Debugging\n")

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

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

The reverse of when.

data FilePath

Instances

Eq FilePath

Data FilePath

Ord FilePath

Show FilePath

Typeable FilePath

IsString FilePath

Monoid FilePath

NFData FilePath

ToFilePath FilePath

ShellArg FilePath

internal functions for writing extension

get :: ShIO State

put :: State -> ShIO ()