| Copyright | © 2015-Present Stack Builders |
|---|---|
| License | MIT |
| Maintainer | Juan Paucar <jpaucar@stackbuilders.com> |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
System.Hapistrano.Core
Description
Core Hapistrano functions that provide basis on which all the functionality is built.
Synopsis
- runHapistrano :: MonadIO m => Maybe SshOptions -> Shell -> (OutputDest -> String -> IO ()) -> Hapistrano a -> m (Either Int a)
- failWith :: Int -> Maybe String -> Hapistrano a
- exec :: forall a. Command a => a -> Hapistrano (Result a)
- execWithInheritStdout :: Command a => a -> Hapistrano ()
- scpFile :: Path Abs File -> Path Abs File -> Hapistrano ()
- scpDir :: Path Abs Dir -> Path Abs Dir -> Hapistrano ()
Documentation
Arguments
| :: MonadIO m | |
| => Maybe SshOptions | SSH options to use or |
| -> Shell | Shell to run commands |
| -> (OutputDest -> String -> IO ()) | How to print messages |
| -> Hapistrano a | The computation to run |
| -> m (Either Int a) |
Run the Hapistrano monad. The monad hosts exec actions.
failWith :: Int -> Maybe String -> Hapistrano a Source #
Fail returning the following status code and message.
exec :: forall a. Command a => a -> Hapistrano (Result a) Source #
Run the given sequence of command. Whether to use SSH or not is
determined from settings contained in the Hapistrano monad
configuration. Commands that return non-zero exit codes will result in
short-cutting of execution.
NOTE: the commands executed with exec will create their own pipe and
will stream output there and once the command finishes its execution it will
parse the result.
execWithInheritStdout :: Command a => a -> Hapistrano () Source #
Same as exec but it streams to stdout only for _GenericCommand_s