Shelly.Pipe

Contents

• Entering Sh.
• List functions
• Running external commands.
• 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
• Utilities.
• Re-exported for your convenience
• internal functions for writing extensions
• find functions

Description

import qualified Shelly as S

newtype Sh a = Sh { unSh :: S.Sh [a] }

findExt ext = findWhen (pure . hasExt ext)

main :: IO ()
main = shs $ do
    mkdir "new"
    findExt "hs"  "." >>= flip cp "new"
    findExt "cpp" "." >>= rm_f 
    liftIO $ putStrLn "done"

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

Synopsis

• data Sh a
• shs :: MonadIO m => Sh () -> m ()
• shelly :: MonadIO m => Sh a -> m [a]
• shellyFailDir :: MonadIO m => Sh a -> m [a]
• shsFailDir :: MonadIO m => Sh () -> m ()
• sub :: Sh a -> Sh a
• silently :: Sh a -> Sh a
• verbosely :: Sh a -> Sh a
• escaping :: Bool -> Sh a -> Sh a
• print_stdout :: Bool -> Sh a -> Sh a
• print_commands :: Bool -> Sh a -> Sh a
• tracing :: Bool -> Sh a -> Sh a
• errExit :: Bool -> Sh a -> Sh a
• roll :: Sh [a] -> Sh a
• unroll :: Sh a -> Sh [a]
• liftSh :: ([a] -> [b]) -> Sh a -> Sh b
• type FoldCallback a = a -> Text -> a
• run :: FilePath -> [Text] -> Sh Text
• run_ :: FilePath -> [Text] -> Sh ()
• runFoldLines :: a -> FoldCallback a -> FilePath -> [Text] -> Sh a
• cmd :: ShellCommand result => FilePath -> result
• (-|-) :: Sh Text -> Sh b -> Sh b
• lastStderr :: Sh Text
• setStdin :: Text -> Sh ()
• lastExitCode :: Sh Int
• command :: FilePath -> [Text] -> [Text] -> Sh Text
• command_ :: FilePath -> [Text] -> [Text] -> Sh ()
• command1 :: FilePath -> [Text] -> Text -> [Text] -> Sh Text
• command1_ :: FilePath -> [Text] -> Text -> [Text] -> Sh ()
• sshPairs :: Text -> [(FilePath, [Text])] -> Sh Text
• sshPairs_ :: Text -> [(FilePath, [Text])] -> Sh ()
• setenv :: Text -> Text -> Sh ()
• get_env :: Text -> Sh (Maybe Text)
• get_env_text :: Text -> Sh Text
• get_env_def :: Text -> Text -> Sh Text
• appendToPath :: FilePath -> Sh ()
• cd :: FilePath -> Sh ()
• chdir :: FilePath -> Sh a -> Sh a
• pwd :: Sh FilePath
• echo :: Text -> Sh ()
• echo_n :: Text -> Sh ()
• echo_err :: Text -> Sh ()
• echo_n_err :: Text -> Sh ()
• inspect :: Show s => s -> Sh ()
• inspect_err :: Show s => s -> Sh ()
• tag :: Sh a -> Text -> Sh a
• trace :: Text -> Sh ()
• show_command :: FilePath -> [Text] -> Text
• ls :: FilePath -> Sh FilePath
• lsT :: FilePath -> Sh Text
• test_e :: FilePath -> Sh Bool
• test_f :: FilePath -> Sh Bool
• test_d :: FilePath -> Sh Bool
• test_s :: FilePath -> Sh Bool
• which :: FilePath -> Sh (Maybe FilePath)
• absPath :: FilePath -> Sh FilePath
• (</>) :: (ToFilePath filepath1, ToFilePath filepath2) => filepath1 -> filepath2 -> FilePath
• (<.>) :: ToFilePath filepath => filepath -> Text -> FilePath
• canonic :: FilePath -> Sh FilePath
• canonicalize :: FilePath -> Sh FilePath
• relPath :: FilePath -> Sh FilePath
• relativeTo :: FilePath -> FilePath -> Sh FilePath
• hasExt :: Text -> FilePath -> Bool
• mv :: FilePath -> FilePath -> Sh ()
• rm :: FilePath -> Sh ()
• rm_f :: FilePath -> Sh ()
• rm_rf :: FilePath -> Sh ()
• cp :: FilePath -> FilePath -> Sh ()
• cp_r :: FilePath -> FilePath -> Sh ()
• mkdir :: FilePath -> Sh ()
• mkdir_p :: FilePath -> Sh ()
• mkdirTree :: Tree FilePath -> Sh ()
• readfile :: FilePath -> Sh Text
• readBinary :: FilePath -> Sh ByteString
• writefile :: FilePath -> Text -> Sh ()
• appendfile :: FilePath -> Text -> Sh ()
• touchfile :: FilePath -> Sh ()
• withTmpDir :: (FilePath -> Sh a) -> Sh a
• exit :: Int -> Sh ()
• errorExit :: Text -> Sh ()
• quietExit :: Int -> Sh ()
• terror :: Text -> Sh a
• catchany :: IO a -> (SomeException -> IO a) -> IO a
• catch_sh :: Exception e => Sh a -> (e -> Sh a) -> Sh a
• finally_sh :: Sh a -> Sh b -> Sh a
• data ShellyHandler a = forall e . Exception e => ShellyHandler (e -> Sh a)
• catches_sh :: Sh a -> [ShellyHandler a] -> Sh a
• catchany_sh :: Sh a -> (SomeException -> Sh a) -> Sh a
• toTextIgnore :: FilePath -> Text
• toTextWarn :: FilePath -> Sh Text
• fromText :: Text -> FilePath
• (<$>) :: Functor f => (a -> b) -> f a -> f b
• whenM :: Monad m => m Bool -> m () -> m ()
• unlessM :: Monad m => m Bool -> m () -> m ()
• time :: Sh a -> Sh (Double, a)
• liftIO :: MonadIO m => forall a. IO a -> m a
• when :: Monad m => Bool -> m () -> m ()
• unless :: Monad m => Bool -> m () -> m ()
• data FilePath :: *
• get :: Sh State
• put :: State -> Sh ()
• 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

Entering Sh.

List functions

Running external commands.

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

Utilities.

Re-exported for your convenience

      when debug (putStr "Debugging\n")

internal functions for writing extensions

find functions