NAME
App::github::cmd - Yet another github CLI
VERSION
This document describes version 0.006 of App::github::cmd (from Perl distribution App-github-cmd), released on 2019-07-24.
SYNOPSIS
Please see included script github-cmd.
FUNCTIONS
create_repo
Usage:
create_repo(%args) -> [status, msg, payload, meta]Create a repository.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
description => str
homepage => url
login => str
pass => str
repo* => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
delete_repo
Usage:
delete_repo() -> [status, msg, payload, meta]This function is not exported.
No arguments.
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
get_repo
Usage:
get_repo(%args) -> [status, msg, payload, meta]Get information about a repository.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
login => str
pass => str
repo* => str
user => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
get_user
Usage:
get_user(%args) -> [status, msg, payload, meta]Get information about a user.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
login => str
pass => str
user => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_repos
Usage:
list_repos(%args) -> [status, msg, payload, meta]List user's repositories.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
detail => bool
login => str
pass => str
start => nonnegint (default: 0)
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
rename_repo
Usage:
rename_repo(%args) -> [status, msg, payload, meta]Rename a repository.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
login => str
new_name* => str
pass => str
repo* => str
user => str
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 (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
repo_exists
Usage:
repo_exists(%args) -> [status, msg, payload, meta]Check whether a repository exists.
This function is not exported.
Arguments ('*' denotes required arguments):
access_token => str
login => str
pass => str
repo* => str
user => str
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 (payload) 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-github-cmd.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-github-cmd.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-github-cmd
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.
SEE ALSO
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2018 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.