System.Hapistrano.Commands

Collection of type safe shell commands that can be fed into runCommand.

Documentation

class Command a where

Class for data types that represent shell commands in typed way.

Associated Types

type Result a :: Type

Type of result.

Methods

renderCommand :: a -> String

How to render the command before feeding it into shell (possibly via SSH).

parseResult :: Proxy a -> String -> Result a

How to parse the result from stdout.

Instances

Command BasicWrite

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result BasicWrite

Methods

renderCommand :: BasicWrite -> String

parseResult :: Proxy BasicWrite -> String -> Result BasicWrite

Command Cat

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Cat

Methods

renderCommand :: Cat -> String

parseResult :: Proxy Cat -> String -> Result Cat

Command CheckExists

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result CheckExists

Methods

renderCommand :: CheckExists -> String

parseResult :: Proxy CheckExists -> String -> Result CheckExists

Command GenericCommand

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GenericCommand

Methods

renderCommand :: GenericCommand -> String

parseResult :: Proxy GenericCommand -> String -> Result GenericCommand

Command GitCheckout

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitCheckout

Methods

renderCommand :: GitCheckout -> String

parseResult :: Proxy GitCheckout -> String -> Result GitCheckout

Command GitClone

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitClone

Methods

renderCommand :: GitClone -> String

parseResult :: Proxy GitClone -> String -> Result GitClone

Command GitFetch

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitFetch

Methods

renderCommand :: GitFetch -> String

parseResult :: Proxy GitFetch -> String -> Result GitFetch

Command GitReset

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitReset

Methods

renderCommand :: GitReset -> String

parseResult :: Proxy GitReset -> String -> Result GitReset

Command GitSetOrigin

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitSetOrigin

Methods

renderCommand :: GitSetOrigin -> String

parseResult :: Proxy GitSetOrigin -> String -> Result GitSetOrigin

Command Ln

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Ln

Methods

renderCommand :: Ln -> String

parseResult :: Proxy Ln -> String -> Result Ln

Command Ls

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Ls

Methods

renderCommand :: Ls -> String

parseResult :: Proxy Ls -> String -> Result Ls

Command MkDir

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result MkDir

Methods

renderCommand :: MkDir -> String

parseResult :: Proxy MkDir -> String -> Result MkDir

Command Rm

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Rm

Methods

renderCommand :: Rm -> String

parseResult :: Proxy Rm -> String -> Result Rm

Command Touch

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Touch

Methods

renderCommand :: Touch -> String

parseResult :: Proxy Touch -> String -> Result Touch

Command Whoami

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Whoami

Methods

renderCommand :: Whoami -> String

parseResult :: Proxy Whoami -> String -> Result Whoami

Command cmd => Command (Cd cmd)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Cd cmd)

Methods

renderCommand :: Cd cmd -> String

parseResult :: Proxy (Cd cmd) -> String -> Result (Cd cmd)

Command (Find Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Find Dir)

Methods

renderCommand :: Find Dir -> String

parseResult :: Proxy (Find Dir) -> String -> Result (Find Dir)

Command (Find File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Find File)

Methods

renderCommand :: Find File -> String

parseResult :: Proxy (Find File) -> String -> Result (Find File)

Command (Mv Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Mv Dir)

Methods

renderCommand :: Mv Dir -> String

parseResult :: Proxy (Mv Dir) -> String -> Result (Mv Dir)

Command (Mv File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Mv File)

Methods

renderCommand :: Mv File -> String

parseResult :: Proxy (Mv File) -> String -> Result (Mv File)

Command (Readlink Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Readlink Dir)

Methods

renderCommand :: Readlink Dir -> String

parseResult :: Proxy (Readlink Dir) -> String -> Result (Readlink Dir)

Command (Readlink File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Readlink File)

Methods

renderCommand :: Readlink File -> String

parseResult :: Proxy (Readlink File) -> String -> Result (Readlink File)

data Whoami

Unix whoami.

Constructors

Whoami

Instances

Show Whoami

Defined in System.Hapistrano.Commands.Internal

Methods

showsPrec :: Int -> Whoami -> ShowS

show :: Whoami -> String

showList :: [Whoami] -> ShowS

Eq Whoami

Defined in System.Hapistrano.Commands.Internal

Methods

(==) :: Whoami -> Whoami -> Bool

(/=) :: Whoami -> Whoami -> Bool

Ord Whoami

Defined in System.Hapistrano.Commands.Internal

Methods

compare :: Whoami -> Whoami -> Ordering

(<) :: Whoami -> Whoami -> Bool

(<=) :: Whoami -> Whoami -> Bool

(>) :: Whoami -> Whoami -> Bool

(>=) :: Whoami -> Whoami -> Bool

max :: Whoami -> Whoami -> Whoami

min :: Whoami -> Whoami -> Whoami

Command Whoami

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Whoami

Methods

renderCommand :: Whoami -> String

parseResult :: Proxy Whoami -> String -> Result Whoami

type Result Whoami

Defined in System.Hapistrano.Commands.Internal

type Result Whoami = String

data Cd cmd

Specify directory in which to perform another command.

Constructors

Cd (Path Abs Dir) cmd

Instances

Command cmd => Command (Cd cmd)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Cd cmd)

Methods

renderCommand :: Cd cmd -> String

parseResult :: Proxy (Cd cmd) -> String -> Result (Cd cmd)

type Result (Cd cmd)

Defined in System.Hapistrano.Commands.Internal

type Result (Cd cmd) = Result cmd

newtype MkDir

Create a directory. Does not fail if the directory already exists.

Constructors

MkDir (Path Abs Dir)

Instances

Command MkDir

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result MkDir

Methods

renderCommand :: MkDir -> String

parseResult :: Proxy MkDir -> String -> Result MkDir

type Result MkDir

Defined in System.Hapistrano.Commands.Internal

type Result MkDir = ()

data Rm where

Delete file or directory.

Constructors

Rm :: Path Abs t -> Rm

Instances

Command Rm

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Rm

Methods

renderCommand :: Rm -> String

parseResult :: Proxy Rm -> String -> Result Rm

type Result Rm

Defined in System.Hapistrano.Commands.Internal

type Result Rm = ()

data Mv t

Move or rename files or directories.

Constructors

Mv TargetSystem (Path Abs t) (Path Abs t)

Instances

Command (Mv Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Mv Dir)

Methods

renderCommand :: Mv Dir -> String

parseResult :: Proxy (Mv Dir) -> String -> Result (Mv Dir)

Command (Mv File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Mv File)

Methods

renderCommand :: Mv File -> String

parseResult :: Proxy (Mv File) -> String -> Result (Mv File)

type Result (Mv Dir)

Defined in System.Hapistrano.Commands.Internal

type Result (Mv Dir) = ()

type Result (Mv File)

Defined in System.Hapistrano.Commands.Internal

type Result (Mv File) = ()

data Ln where

Create symlinks.

Constructors

Ln :: TargetSystem -> Path Abs t -> Path Abs File -> Ln

Instances

Command Ln

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Ln

Methods

renderCommand :: Ln -> String

parseResult :: Proxy Ln -> String -> Result Ln

type Result Ln

Defined in System.Hapistrano.Commands.Internal

type Result Ln = ()

newtype Ls

ls, so far used only to check existence of directories, so it's not very functional right now.

Constructors

Ls (Path Abs Dir)

Instances

Command Ls

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Ls

Methods

renderCommand :: Ls -> String

parseResult :: Proxy Ls -> String -> Result Ls

type Result Ls

Defined in System.Hapistrano.Commands.Internal

type Result Ls = ()

data Readlink t

Read link.

Constructors

Readlink TargetSystem (Path Abs File)

Instances

Command (Readlink Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Readlink Dir)

Methods

renderCommand :: Readlink Dir -> String

parseResult :: Proxy (Readlink Dir) -> String -> Result (Readlink Dir)

Command (Readlink File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Readlink File)

Methods

renderCommand :: Readlink File -> String

parseResult :: Proxy (Readlink File) -> String -> Result (Readlink File)

type Result (Readlink Dir)

Defined in System.Hapistrano.Commands.Internal

type Result (Readlink Dir) = Path Abs Dir

type Result (Readlink File)

Defined in System.Hapistrano.Commands.Internal

type Result (Readlink File) = Path Abs File

data Find t

Find (a very limited version).

Constructors

Find Natural (Path Abs Dir)

Instances

Command (Find Dir)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Find Dir)

Methods

renderCommand :: Find Dir -> String

parseResult :: Proxy (Find Dir) -> String -> Result (Find Dir)

Command (Find File)

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result (Find File)

Methods

renderCommand :: Find File -> String

parseResult :: Proxy (Find File) -> String -> Result (Find File)

type Result (Find Dir)

Defined in System.Hapistrano.Commands.Internal

type Result (Find Dir) = [Path Abs Dir]

type Result (Find File)

Defined in System.Hapistrano.Commands.Internal

type Result (Find File) = [Path Abs File]

newtype Touch

touch.

Constructors

Touch (Path Abs File)

Instances

Command Touch

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Touch

Methods

renderCommand :: Touch -> String

parseResult :: Proxy Touch -> String -> Result Touch

type Result Touch

Defined in System.Hapistrano.Commands.Internal

type Result Touch = ()

newtype Cat

Command used to read the contents of a particular file in the host.

Constructors

Cat (Path Abs File)

The absolute path to the file you want to read

Instances

Command Cat

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result Cat

Methods

renderCommand :: Cat -> String

parseResult :: Proxy Cat -> String -> Result Cat

type Result Cat

Defined in System.Hapistrano.Commands.Internal

type Result Cat = String

newtype CheckExists

Command that checks for the existance of a particular file in the host.

Constructors

CheckExists (Path Abs File)

The absolute path to the file you want to check for existence

Instances

Command CheckExists

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result CheckExists

Methods

renderCommand :: CheckExists -> String

parseResult :: Proxy CheckExists -> String -> Result CheckExists

type Result CheckExists

Defined in System.Hapistrano.Commands.Internal

type Result CheckExists = Bool

data BasicWrite

Basic command that writes to a file some contents. It uses the file > contents shell syntax and the contents is represented as a String, so it shouldn't be used for bigger writing operations. Currently used to write fail or success to the .hapistrano_deploy_state file.

Constructors

BasicWrite

Fields

• (Path Abs File)

  The absolute path to the file to which you want to write

• String

  The contents that will be written to the file

Instances

Command BasicWrite

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result BasicWrite

Methods

renderCommand :: BasicWrite -> String

parseResult :: Proxy BasicWrite -> String -> Result BasicWrite

type Result BasicWrite

Defined in System.Hapistrano.Commands.Internal

type Result BasicWrite = ()

newtype GitCheckout

Git checkout.

Constructors

GitCheckout String

Instances

Command GitCheckout

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitCheckout

Methods

renderCommand :: GitCheckout -> String

parseResult :: Proxy GitCheckout -> String -> Result GitCheckout

type Result GitCheckout

Defined in System.Hapistrano.Commands.Internal

type Result GitCheckout = ()

data GitClone

Git clone.

Constructors

GitClone Bool (Either String (Path Abs Dir)) (Path Abs Dir)

Instances

Command GitClone

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitClone

Methods

renderCommand :: GitClone -> String

parseResult :: Proxy GitClone -> String -> Result GitClone

type Result GitClone

Defined in System.Hapistrano.Commands.Internal

type Result GitClone = ()

newtype GitSetOrigin

Git set origin

Constructors

GitSetOrigin String

Instances

Command GitSetOrigin

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitSetOrigin

Methods

renderCommand :: GitSetOrigin -> String

parseResult :: Proxy GitSetOrigin -> String -> Result GitSetOrigin

type Result GitSetOrigin

Defined in System.Hapistrano.Commands.Internal

type Result GitSetOrigin = ()

newtype GitFetch

Git fetch (simplified).

Constructors

GitFetch String

Instances

Command GitFetch

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitFetch

Methods

renderCommand :: GitFetch -> String

parseResult :: Proxy GitFetch -> String -> Result GitFetch

type Result GitFetch

Defined in System.Hapistrano.Commands.Internal

type Result GitFetch = ()

newtype GitReset

Git reset.

Constructors

GitReset String

Instances

Command GitReset

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GitReset

Methods

renderCommand :: GitReset -> String

parseResult :: Proxy GitReset -> String -> Result GitReset

type Result GitReset

Defined in System.Hapistrano.Commands.Internal

type Result GitReset = ()

data GenericCommand

Weakly-typed generic command, avoid using it directly.

Instances

Show GenericCommand

Defined in System.Hapistrano.Commands.Internal

Methods

showsPrec :: Int -> GenericCommand -> ShowS

show :: GenericCommand -> String

showList :: [GenericCommand] -> ShowS

Eq GenericCommand

Defined in System.Hapistrano.Commands.Internal

Methods

(==) :: GenericCommand -> GenericCommand -> Bool

(/=) :: GenericCommand -> GenericCommand -> Bool

Ord GenericCommand

Defined in System.Hapistrano.Commands.Internal

Methods

compare :: GenericCommand -> GenericCommand -> Ordering

(<) :: GenericCommand -> GenericCommand -> Bool

(<=) :: GenericCommand -> GenericCommand -> Bool

(>) :: GenericCommand -> GenericCommand -> Bool

(>=) :: GenericCommand -> GenericCommand -> Bool

max :: GenericCommand -> GenericCommand -> GenericCommand

min :: GenericCommand -> GenericCommand -> GenericCommand

Command GenericCommand

Defined in System.Hapistrano.Commands.Internal

Associated Types

type Result GenericCommand

Methods

renderCommand :: GenericCommand -> String

parseResult :: Proxy GenericCommand -> String -> Result GenericCommand

type Result GenericCommand

Defined in System.Hapistrano.Commands.Internal

type Result GenericCommand = ()

mkGenericCommand :: String -> Maybe GenericCommand

Smart constructor that allows to create GenericCommands. Just a little bit more safety.

unGenericCommand :: GenericCommand -> String

Get the raw command back from GenericCommand.

readScript :: MonadIO m => Path Abs File -> m [GenericCommand]

Read commands from a file.