Git::Repository::Command - Command objects for running git
use Git::Repository::Command; # invoke an external git command, and return an object $cmd = Git::Repository::Command->new(@cmd); # a Git::Repository object can provide more context $cmd = Git::Repository::Command->new( $r, @cmd ); # options can be passed as a hashref $cmd = Git::Repository::Command->new( $r, @cmd, \%option ); # $cmd is basically a hash, with keys / accessors $cmd->stdin(); # filehandle to the process' stdin (write) $cmd->stdout(); # filehandle to the process' stdout (read) $cmd->stderr(); # filehandle to the process' stdout (read) $cmd->pid(); # pid of the child process # done! $cmd->close(); # exit information $cmd->exit(); # exit status $cmd->signal(); # signal $cmd->core(); # core dumped? (boolean)
Git::Repository::Command is a class that actually launches a git commands, allowing to interact with it through its
This module is meant to be invoked through
Git::Repository::Command supports the following methods:
Runs a git command with the parameters in
@cmd contains a
Git::Repository object, it is used to provide context to the git command.
@cmd contains a hash reference, it is taken as an option hash. The recognized keys are:
The actual git binary to run. By default, it is just
The current working directory in which the git command will be run.
A hashref containing key / values to add to the git command environment.
A string that is send to the git command standard input, which is then closed.
Using the empty string as
inputwill close the git command standard input without writing to it.
inputwill not do anything. This behaviour provides a way to modify options inherited from
new()or a hash populated by some other part of the program.
On some systems, some git commands may close standard input on startup, which will cause a SIGPIPE when trying to write to it. This will raise an exception.
Git::Repository object has its own option hash, it will be used to provide default values that can be overriden by the actual option hash passed to
If several option hashes are passed to
new(), only the first one will be used.
Git::Repository::Command object returned by
new() has a number of attributes defined (see below).
Close all pipes to the child process, and collects exit status, etc. and defines a number of attributes (see below).
close() is automatically called when the
Git::Repository::Command object is destroyed. Annoyingly, this means that in the following example
$fh will be closed when you tried to use it:
my $fh = Git::Repository::Command->new( @cmd )->stdout;
The attributes of a
Git::Repository::Command object are also accessible through a number of accessors.
The object returned by
new() will have the following attributes defined:
Return the command-line actually executed, as a list of strings.
The PID of the underlying git command.
A filehandle opened in write mode to the child process' standard input.
A filehandle opened in read mode to the child process' standard output.
A filehandle opened in read mode to the child process' standard error output.
After the call to
close(), the following attributes will be defined:
The exit status of the underlying git command.
A boolean value indicating if the command dumped core.
The signal, if any, that killed the command.
Philippe Bruhat (BooK),
<book at cpan.org>
Copyright 2010 Philippe Bruhat (BooK), all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.