view release on metacpan or  search on metacpan

lib/CASCM/CLI.pm  view on Meta::CPAN

CASCM::CLI - A unified CLI for CA Harvest SCM

=head1 USAGE

    hv [options] subcommand [options] [arguments]

=head1 DESCRIPTION

C<hv> provides a unified, context aware CLI for CA Harvest SCM.

=head1 CONTEXT

C<hv> looks for, collects, merges and passes on context and options to
underlying Harvest commands. This allows context to be configured in
various locations.

Context files are C<.ini> files. Please see the documentation in
L<CASCM::Wrapper> for the format and examples of context files.

The following precedence is used when merging context from various
sources.

=over

=item command-line

    hv hci -st Developement

Harvest CLI options can be provided directly on the command line, just
like you would when running harvest commands directly

=item Project-specific Context

The project context is a context file C<.hvcontext> in the current
directory

=item User-specific Context

The user's context file defaults to C<.hvcontext> in the user's home
directory. This can also be specified using the C<HVCONTEXT>
environment variable.

=item System-wide Context

The system wide context file defaults to C<$CA_SCM_HOME/hvcontext> or
C<$HARVEST_HOME/hvcontext>

=back

=head1 LOGGING

Unlike harvest commands, C<hv> will, by default, log to STDOUT(or
STDERR). Harvest specific log files are not created.

=head1 SUBCOMMANDS

Almost all harvest commands are supported as subcommands. Please see
L<CASCM::Wrapper> for a full list of supported commands.

=head1 BUGS AND LIMITATIONS

Please report any bugs or feature requests at
L<https://github.com/mithun/perl-cascm-cli/issues>

=head1 AUTHOR

Mithun Ayachit C<mithun@cpan.org>

=head1 LICENSE AND COPYRIGHT

Copyright (c) 2014, Mithun Ayachit. All rights reserved.

This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. See L<perlartistic>.

=cut