NAME
Shell::Carapace - cpanm style logging for shell commands
SYNOPSIS
use Shell::Carapace;
my $shell = Shell::Carapace->new(
verbose => 1, # tee shell cmd output to STDOUT/STDERR
logfile => '/path/to/file.log', # log cmd output
);
my $output = $shell->local(@cmd);
my $output = $shell->remote($user, $host, @cmd);
# Useful for testing:
# The noop attr tells local() to not run the shell cmd
# Instead local() will return the cmd as a quoted string
$shell->noop(1);
my $cmd = $shell->local(@cmd);DESCRIPTION
cpanm does a great job of not printing unnecessary output to the screen. But sometimes you need verbose output in order to debug problems. To solve this problem cpanm logs at a verbose level to a logfile.
This module provides infrastructure so developers can easily add similar functionality to their command line applications.
Shell::Carapace is mostly a small wrapper around Capture::Tiny.
ERROR HANDLING
local() and remote() both die if a command fails by returning a positive exit code.
CAVEATS
There isn't a good Perly way to tee output to both stdout and a log file. To enable this feature this module pipes your cmd to "tee -a $logfile". This will fail if you don't have tee in your $PATH.
You can disable this behavior by setting the 'tee_logfile' attribute to false. In that case, command output will get written to the logfile only after the command completes instead of in real time.
Doesn't work on win32.
SEE ALSO
About the name
Carapace: n. A protective, shell-like covering likened to that of a turtle or crustacean
LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
AUTHOR
Eric Johnson <eric.git@iijo.org>