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

{-# 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
• class Monad m => MonadShControl m where
  • data ShM 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
• 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
• class CmdArg a where
• 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 ()
• 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 => forall a. IO a -> m a
• when :: Applicative f => Bool -> f () -> f ()
• unless :: Applicative f => Bool -> f () -> f ()
• data FilePath :: *
• (<$>) :: 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

Documentation

Entering Sh.

Running external commands.

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

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

when debug (putStrLn "Debugging")

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

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

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

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

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

internal functions for writing extensions

find functions

Orphan instances