The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-lcpan-1.022
River stage two • 41 direct dependents • 69 total dependents
14 ++
/ App::lcpan::Cmd::scripts

NAME

App::lcpan::Cmd::scripts - List scripts

VERSION

This document describes version 1.022 of App::lcpan::Cmd::scripts (from Perl distribution App-lcpan), released on 2018-02-08.

FUNCTIONS

handle_cmd

Usage:

 handle_cmd(%args) -> [status, msg, result, meta]

List scripts.

This subcommand lists scripts. Scripts are identified heuristically from contents of release archives matching this regex:

 #         container dir,  script dir,       script name
 \A (\./)? ([^/]+)/?       (s?bin|scripts?)/ ([^/]+) \z

A few exception are excluded, e.g. if script name begins with a dot (e.g. bin/.exists which is usually a marker only).

Scripts are currently indexed by its release file and its name, so if a single release contains both bin/foo and script/foo, only one of those will be indexed. Normally a proper release shouldn't be like that though.

This function is not exported.

Arguments ('*' denotes required arguments):

  • author => str

    Filter by author.

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan.

  • detail => bool

  • dist => perl::distname

    Filter by distribution.

  • index_name => filename (default: "index.db")

    Filename of index.

  • or => bool

    When there are more than one query, perform OR instead of AND logic.

  • query => array[str]

    Search query.

  • query_type => str (default: "any")

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-lcpan.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-lcpan.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-lcpan

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018, 2017, 2016, 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.