shelly-1.12.1: shell-like (systems) programming in Haskell

Safe Haskell | Safe-Inferred
Language | Haskell2010

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
- Orphan instances

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

- class Monad m => MonadSh m where
  - liftSh :: Sh a -> m a
- class Monad m => MonadShControl m where
  - data ShM m a
  - liftShWith :: ((forall x. m x -> Sh (ShM m x)) -> Sh a) -> m a
  - restoreSh :: ShM m a -> m a
- data Sh a
- type ShIO a = Sh a
- shelly :: MonadIO m => Sh a -> m a
- shellyNoDir :: MonadIO m => Sh a -> m a
- shellyFailDir :: MonadIO m => Sh a -> m a
- 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
- print_commands_with :: MonadShControl m => (Text -> IO ()) -> 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
- 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
- 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
  - cmdAll :: FilePath -> [Text] -> t
- class CmdArg a where
  - toTextArgs :: a -> [Text]
- runHandle :: MonadShControl m => FilePath -> [Text] -> (Handle -> m a) -> m a
- runHandles :: MonadShControl m => FilePath -> [Text] -> [StdHandle] -> (Handle -> Handle -> Handle -> m a) -> m a
- transferLinesAndCombine :: MonadIO m => Handle -> (Text -> IO ()) -> m Text
- transferFoldHandleLines :: a -> FoldCallback a -> Handle -> (Text -> IO ()) -> IO a
- data StdHandle
  - = InHandle StdStream
  - | OutHandle StdStream
  - | ErrorHandle StdStream
- data StdStream
  - = Inherit
  - | UseHandle Handle
  - | CreatePipe
  - | NoStream
- 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 ()
- prependToPath :: MonadSh m => FilePath -> m ()
- 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
- echo :: MonadSh m => Text -> m ()
- echo_n :: MonadSh m => Text -> m ()
- echo_err :: MonadSh m => Text -> m ()
- echo_n_err :: MonadSh m => Text -> m ()
- echoWith :: MonadSh m => (Text -> IO ()) -> 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
- 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)
- absPath :: MonadSh m => FilePath -> m FilePath
- (</>) :: (ToFilePath filepath1, ToFilePath filepath2) => filepath1 -> filepath2 -> FilePath
- (<.>) :: ToFilePath filepath => filepath -> Text -> FilePath
- canonic :: MonadSh m => FilePath -> m FilePath
- canonicalize :: MonadSh m => FilePath -> m FilePath
- relPath :: MonadSh m => FilePath -> m FilePath
- relativeTo :: MonadSh m => FilePath -> FilePath -> m FilePath
- hasExt :: Text -> FilePath -> Bool
- 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 ()
- 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
- exit :: MonadSh m => Int -> m a
- errorExit :: MonadSh m => Text -> m a
- quietExit :: MonadSh m => Int -> m a
- terror :: MonadSh m => Text -> m a
- bracket_sh :: Sh a -> (a -> Sh b) -> (a -> Sh c) -> Sh c
- catchany :: MonadBaseControl IO m => m a -> (SomeException -> m a) -> m a
- catch_sh :: Exception e => Sh a -> (e -> Sh a) -> Sh a
- handle_sh :: Exception e => (e -> Sh a) -> Sh a -> Sh a
- handleany_sh :: (SomeException -> Sh a) -> Sh a -> Sh a
- finally_sh :: Sh a -> Sh b -> Sh a
- catches_sh :: Sh a -> [Handler Sh a] -> Sh a
- catchany_sh :: Sh a -> (SomeException -> Sh a) -> Sh a
- toTextIgnore :: FilePath -> Text
- toTextWarn :: MonadSh m => FilePath -> m Text
- fromText :: Text -> FilePath
- whenM :: Monad m => m Bool -> m () -> m ()
- unlessM :: Monad m => m Bool -> m () -> m ()
- time :: MonadShControl m => m a -> m (Double, a)
- sleep :: MonadSh m => Int -> m ()
- liftIO :: MonadIO m => IO a -> m a
- when :: Applicative f => Bool -> f () -> f ()
- unless :: Applicative f => Bool -> f () -> f ()
- type FilePath = String
- (<$>) :: Functor f => (a -> b) -> f a -> f b
- get :: MonadSh m => m State
- put :: MonadSh m => State -> m ()
- find :: FilePath -> Sh [FilePath]
- findWhen :: (FilePath -> Sh Bool) -> FilePath -> Sh [FilePath]
- findFold :: (a -> FilePath -> Sh a) -> a -> FilePath -> Sh a
- findDirFilter :: (FilePath -> Sh Bool) -> FilePath -> Sh [FilePath]
- findDirFilterWhen :: (FilePath -> Sh Bool) -> (FilePath -> Sh Bool) -> FilePath -> Sh [FilePath]
- findFoldDirFilter :: (a -> FilePath -> Sh a) -> a -> (FilePath -> Sh Bool) -> FilePath -> Sh a
- followSymlink :: MonadShControl m => Bool -> m a -> m a

# Documentation

class Monad m => MonadSh m where Source #

Methods

liftSh :: Sh a -> m a Source #

#### Instances

Instances details

MonadSh Sh Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> Sh a Source #
MonadSh m => MonadSh (MaybeT m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> MaybeT m a Source #
MonadSh m => MonadSh (ExceptT e m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> ExceptT e m a Source #
MonadSh m => MonadSh (IdentityT m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> IdentityT m a Source #
MonadSh m => MonadSh (ReaderT r m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> ReaderT r m a Source #
MonadSh m => MonadSh (StateT s m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> StateT s m a Source #
MonadSh m => MonadSh (StateT s m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> StateT s m a Source #
(Monoid w, MonadSh m) => MonadSh (WriterT w m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> WriterT w m a Source #
(Monoid w, MonadSh m) => MonadSh (WriterT w m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> WriterT w m a Source #
MonadSh m => MonadSh (ContT r m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> ContT r m a Source #
(Monoid w, MonadSh m) => MonadSh (RWST r w s m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> RWST r w s m a Source #
(Monoid w, MonadSh m) => MonadSh (RWST r w s m) Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> RWST r w s m a Source #

class Monad m => MonadShControl m where Source #

Associated Types

data ShM m a Source #

Methods

liftShWith :: ((forall x. m x -> Sh (ShM m x)) -> Sh a) -> m a Source #

restoreSh :: ShM m a -> m a Source #

#### Instances

Instances details

MonadShControl Sh Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM Sh a Source # Methods liftShWith :: ((forall x. Sh x -> Sh (ShM Sh x)) -> Sh a) -> Sh a Source # restoreSh :: ShM Sh a -> Sh a Source #
MonadShControl m => MonadShControl (MaybeT m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (MaybeT m) a Source # Methods liftShWith :: ((forall x. MaybeT m x -> Sh (ShM (MaybeT m) x)) -> Sh a) -> MaybeT m a Source # restoreSh :: ShM (MaybeT m) a -> MaybeT m a Source #
MonadShControl m => MonadShControl (ExceptT e m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (ExceptT e m) a Source # Methods liftShWith :: ((forall x. ExceptT e m x -> Sh (ShM (ExceptT e m) x)) -> Sh a) -> ExceptT e m a Source # restoreSh :: ShM (ExceptT e m) a -> ExceptT e m a Source #
MonadShControl m => MonadShControl (IdentityT m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (IdentityT m) a Source # Methods liftShWith :: ((forall x. IdentityT m x -> Sh (ShM (IdentityT m) x)) -> Sh a) -> IdentityT m a Source # restoreSh :: ShM (IdentityT m) a -> IdentityT m a Source #
MonadShControl m => MonadShControl (ReaderT r m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (ReaderT r m) a Source # Methods liftShWith :: ((forall x. ReaderT r m x -> Sh (ShM (ReaderT r m) x)) -> Sh a) -> ReaderT r m a Source # restoreSh :: ShM (ReaderT r m) a -> ReaderT r m a Source #
MonadShControl m => MonadShControl (StateT s m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (StateT s m) a Source # Methods liftShWith :: ((forall x. StateT s m x -> Sh (ShM (StateT s m) x)) -> Sh a) -> StateT s m a Source # restoreSh :: ShM (StateT s m) a -> StateT s m a Source #
MonadShControl m => MonadShControl (StateT s m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (StateT s m) a Source # Methods liftShWith :: ((forall x. StateT s m x -> Sh (ShM (StateT s m) x)) -> Sh a) -> StateT s m a Source # restoreSh :: ShM (StateT s m) a -> StateT s m a Source #
(MonadShControl m, Monoid w) => MonadShControl (WriterT w m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (WriterT w m) a Source # Methods liftShWith :: ((forall x. WriterT w m x -> Sh (ShM (WriterT w m) x)) -> Sh a) -> WriterT w m a Source # restoreSh :: ShM (WriterT w m) a -> WriterT w m a Source #
(MonadShControl m, Monoid w) => MonadShControl (WriterT w m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (WriterT w m) a Source # Methods liftShWith :: ((forall x. WriterT w m x -> Sh (ShM (WriterT w m) x)) -> Sh a) -> WriterT w m a Source # restoreSh :: ShM (WriterT w m) a -> WriterT w m a Source #
(MonadShControl m, Monoid w) => MonadShControl (RWST r w s m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (RWST r w s m) a Source # Methods liftShWith :: ((forall x. RWST r w s m x -> Sh (ShM (RWST r w s m) x)) -> Sh a) -> RWST r w s m a Source # restoreSh :: ShM (RWST r w s m) a -> RWST r w s m a Source #
(MonadShControl m, Monoid w) => MonadShControl (RWST r w s m) Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM (RWST r w s m) a Source # Methods liftShWith :: ((forall x. RWST r w s m x -> Sh (ShM (RWST r w s m) x)) -> Sh a) -> RWST r w s m a Source # restoreSh :: ShM (RWST r w s m) a -> RWST r w s m a Source #

# Entering Sh

data Sh a Source #

#### Instances

Instances details

MonadFail Sh Source # |
Instance details Defined in Shelly.Base Methods fail :: String -> Sh a Source #
MonadIO Sh Source # |
Instance details Defined in Shelly.Base Methods liftIO :: IO a -> Sh a Source #
Applicative Sh Source # |
Instance details Defined in Shelly.Base Methods pure :: a -> Sh a Source # (<*>) :: Sh (a -> b) -> Sh a -> Sh b Source # liftA2 :: (a -> b -> c) -> Sh a -> Sh b -> Sh c Source # (*>) :: Sh a -> Sh b -> Sh b Source # (<*) :: Sh a -> Sh b -> Sh a Source #
Functor Sh Source # |
Instance details Defined in Shelly.Base Methods fmap :: (a -> b) -> Sh a -> Sh b Source # (<$) :: a -> Sh b -> Sh a Source #
Monad Sh Source # |
Instance details Defined in Shelly.Base Methods (>>=) :: Sh a -> (a -> Sh b) -> Sh b Source # (>>) :: Sh a -> Sh b -> Sh b Source # return :: a -> Sh a Source #
MonadCatch Sh Source # |
Instance details Defined in Shelly.Base Methods catch :: (HasCallStack, Exception e) => Sh a -> (e -> Sh a) -> Sh a Source #
MonadMask Sh Source # |
Instance details Defined in Shelly.Base Methods mask :: HasCallStack => ((forall a. Sh a -> Sh a) -> Sh b) -> Sh b Source # uninterruptibleMask :: HasCallStack => ((forall a. Sh a -> Sh a) -> Sh b) -> Sh b Source # generalBracket :: HasCallStack => Sh a -> (a -> ExitCase b -> Sh c) -> (a -> Sh b) -> Sh (b, c) Source #
MonadThrow Sh Source # |
Instance details Defined in Shelly.Base Methods throwM :: (HasCallStack, Exception e) => e -> Sh a Source #
MonadSh Sh Source # |
Instance details Defined in Shelly.Lifted Methods liftSh :: Sh a -> Sh a Source #
MonadShControl Sh Source # |
Instance details Defined in Shelly.Lifted Associated Types data ShM Sh a Source # Methods liftShWith :: ((forall x. Sh x -> Sh (ShM Sh x)) -> Sh a) -> Sh a Source # restoreSh :: ShM Sh a -> Sh a Source #
MonadBaseControl IO Sh Source # |
Instance details Defined in Shelly.Base Associated Types type StM Sh a Source # Methods liftBaseWith :: (RunInBase Sh IO -> IO a) -> Sh a Source # restoreM :: StM Sh a -> Sh a Source #
MonadBase IO Sh Source # |
Instance details Defined in Shelly.Base Methods liftBase :: IO α -> Sh α Source #
ShellCmd (Sh Text) Source # |
Instance details Defined in Shelly Methods cmdAll :: FilePath -> [Text] -> Sh Text Source #
s ~ () => ShellCmd (Sh s) Source # |
Instance details Defined in Shelly Methods cmdAll :: FilePath -> [Text] -> Sh s Source #
newtype ShM Sh a Source # |
Instance details Defined in Shelly.Lifted newtype ShM Sh a = ShSh a
type StM Sh a Source # |
Instance details Defined in Shelly.Base type StM Sh a

type ShIO a = Sh a Source #

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 Source #

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 Source #

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 Source #

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

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

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

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

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

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

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

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

print_commands_with :: MonadShControl m => (Text -> IO ()) -> m a -> m a Source #

Since: 1.12.1

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

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

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

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

# Running external commands

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

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

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

cmd :: ShellCmd result => FilePath -> result Source #

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 Source #

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

lastStderr :: MonadSh m => m Text Source #

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

lastExitCode :: MonadSh m => m Int Source #

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

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

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

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

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

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

class ShellCmd t where Source #

For the variadic function `cmd`.

Partially applied variadic functions require type signatures.

Methods

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

#### Instances

Instances details

ShellCmd (Sh Text) Source # |
Instance details Defined in Shelly Methods cmdAll :: FilePath -> [Text] -> Sh Text Source #
s ~ () => ShellCmd (Sh s) Source # |
Instance details Defined in Shelly Methods cmdAll :: FilePath -> [Text] -> Sh s Source #
MonadSh m => ShellCmd (m Text) Source # |
Instance details Defined in Shelly.Lifted Methods cmdAll :: FilePath -> [Text] -> m Text Source #
MonadSh m => ShellCmd (m ()) Source # |
Instance details Defined in Shelly.Lifted Methods cmdAll :: FilePath -> [Text] -> m () Source #
(MonadSh m, s ~ Text, Show s) => ShellCmd (m s) Source # |
Instance details Defined in Shelly.Lifted Methods cmdAll :: FilePath -> [Text] -> m s Source #
(CmdArg arg, ShellCmd result) => ShellCmd (arg -> result) Source # |
Instance details Defined in Shelly Methods cmdAll :: FilePath -> [Text] -> arg -> result Source #

class CmdArg a where Source #

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

Methods

toTextArgs :: a -> [Text] Source #

Since: 1.12.0

#### Instances

Instances details

CmdArg Text Source # |
Instance details Defined in Shelly Methods toTextArgs :: Text -> [Text] Source #
CmdArg String Source # |
Instance details Defined in Shelly Methods toTextArgs :: String -> [Text] Source #
CmdArg a => CmdArg [a] Source # |
Instance details Defined in Shelly Methods toTextArgs :: [a] -> [Text] Source #

# Running commands Using handles

runHandle Source #

Arguments

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

runHandles Source #

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 Source #

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

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 Source #

Constructors

InHandle StdStream |
OutHandle StdStream |
ErrorHandle StdStream |

data StdStream Source #

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`).

NoStream

Close the stream's file descriptor without passing a Handle. On POSIX systems this may lead to strange behavior in the child process because attempting to read or write after the file has been closed throws an error. This should only be used with child processes that don't use the file descriptor at all. If you wish to ignore the child process's output you should either create a pipe and drain it manually or pass a `Handle` that writes to `/dev/null`.

#### Instances

Instances details

Show StdStream |
Instance details Defined in System.Process.Common Methods showsPrec :: Int -> StdStream -> ShowS Source # show :: StdStream -> String Source # showList :: [StdStream] -> ShowS Source #
Eq StdStream |
Instance details Defined in System.Process.Common Methods (==) :: StdStream -> StdStream -> Bool Source # (/=) :: StdStream -> StdStream -> Bool Source #

# Modifying and querying environment

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

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

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

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

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

prependToPath :: MonadSh m => FilePath -> m () Source #

# Environment directory

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

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

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

pwd :: MonadSh m => m FilePath Source #

# Printing

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

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

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

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

echoWith :: MonadSh m => (Text -> IO ()) -> Text -> m () Source #

Since: 1.12.1

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

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

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

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

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

# Querying filesystem

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

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

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

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

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

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

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

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

# Filename helpers

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

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

Uses System.FilePath, but can automatically convert a `Text`.

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

Uses System.FilePath, but can automatically convert a `Text`.

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

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

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

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

relativeTo Source #

Arguments

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

hasExt :: Text -> FilePath -> Bool Source #

Flipped `hasExtension` for `Text`.

# Manipulating filesystem

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

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

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

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

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

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

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

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

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

# reading/writing Files

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

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

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

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

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

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

# exiting the program

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

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

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

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

# Exceptions

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

Deprecated: use Control.Exception.Lifted.bracket instead

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

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

Deprecated: use Control.Exception.Lifted.catch instead

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

Deprecated: use Control.Exception.Lifted.handle instead

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

Deprecated: use Control.Exception.Enclosed.handleAny instead

finally_sh :: Sh a -> Sh b -> Sh a Source #

Deprecated: use Control.Exception.Lifted.finally instead

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

Deprecated: use Control.Exception.Lifted.catches instead

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

Deprecated: use Control.Exception.Enclosed.catchAny instead

# convert between Text and FilePath

toTextIgnore :: FilePath -> Text Source #

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

fromText :: Text -> FilePath Source #

Convert `Text` to a `FilePath`.

# Utility Functions

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

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

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

A monadic-conditional version of the `unless` guard.

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

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

# Re-exported for your convenience

liftIO :: MonadIO m => IO a -> m a Source #

Lift a computation from the `IO` monad. This allows us to run IO computations in any monadic stack, so long as it supports these kinds of operations (i.e. `IO` is the base monad for the stack).

### Example

Expand

    import Control.Monad.Trans.State -- from the "transformers" library

    printState :: Show s => StateT s IO ()
    printState = do
      state <- get
      liftIO $ print state

Had we omitted ``liftIO``, we would have ended up with this error:

    • Couldn't match type ‘IO’ with ‘StateT s IO’
     Expected type: StateT s IO ()
       Actual type: IO ()

The important part here is the mismatch between `StateT s IO ()` and ``IO` ()`.

Luckily, we know of a function that takes an ``IO` a` and returns an `(m a)`: ``liftIO``, enabling us to run the program and see the expected results:

    > evalStateT printState "hello"
    "hello"

    > evalStateT printState 3
    3

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

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 () Source #

The reverse of `when`.

type FilePath = String Source #

File and directory names are values of type `String`, whose precise meaning is operating system dependent. Files can be opened, yielding a handle which can then be used to operate on the contents of that file.

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

An infix synonym for `fmap`.

The name of this operator is an allusion to `$`. Note the similarities between their types:

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

Whereas `$` is function application, `<$>` is function application lifted over a `Functor`.

#### Examples

Expand

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 Source #

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

# find functions

find :: FilePath -> Sh [FilePath] Source #

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] Source #

`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 Source #

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] Source #

`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 Source #

Arguments

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

Similar to `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 Source #

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

followSymlink :: MonadShControl m => Bool -> m a -> m a Source #

# Orphan instances

MonadSh m => ShellCmd (m Text) Source # |
Instance details Methods cmdAll :: FilePath -> [Text] -> m Text Source #
MonadSh m => ShellCmd (m ()) Source # |
Instance details Methods cmdAll :: FilePath -> [Text] -> m () Source #
(MonadSh m, s ~ Text, Show s) => ShellCmd (m s) Source # |
Instance details Methods cmdAll :: FilePath -> [Text] -> m s Source #