/ 
App-github-cmd-0.008
River stage one • 1 direct dependent • 1 total dependent
/ github-cmd

NAME

github-cmd - Yet another github CLI

VERSION

This document describes version 0.008 of github-cmd (from Perl distribution App-github-cmd), released on 2020-04-08.

SYNOPSIS

Setup

In ~/.config/github-cmd.conf:

login = YOUR_GITHUB_LOGIN
pass  = YOUR_GITHUB_PASSWORD

# or
access_token = YOUR_API_TOKEN

or just run github-cmd, which will prompt you login+pass and write them to configuration.

User commands

% github-cmd get-user
% github-cmd get-user perlancar

Repo commands

% github-cmd list-repos
% github-cmd list-repos -l
% github-cmd list-repos --start 100

% github-cmd get-repo perl-App-github-cmd
% github-cmd get-repo --user perlancar perl-App-github-cmd

% github-cmd repo-exists perl-App-github-cmd
1

% github-cmd repo-exists --user perlancar perl-App-github-cmd-FOO
0

% github-cmd create-repo foo

% github-cmd delete-repo foo

% github-cmd rename-repo foo bar

DESCRIPTION

EARLY RELEASE. More subcommands coming soon.

This is yet another Github CLI, written in Perl using the Perinci::CmdLine framework and Net::GitHub::V3 API client.

SUBCOMMANDS

create-repo

Create a repository.

delete-repo

get-repo

Get information about a repository.

get-user

Get information about a user.

list-repos

List user's repositories.

rename-repo

Rename a repository.

repo-exists

Check whether a repository exists.

OPTIONS

* marks required options.

Common options

--access-token=s
--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--help, -h, -?

Display help message and exit.

--json

Set output format to json.

--log-level=s

Set log level.

--login=s
--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--no-config

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

--pass=s
--quiet

Shortcut for --log-level=error.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

Options for subcommand create-repo

--description=s
--homepage-json=s

See --homepage.

--homepage=s
--repo=s*

Options for subcommand delete-repo

--repo=s*
--user=s

Options for subcommand get-repo

--repo=s*
--user=s

Options for subcommand get-user

--user=s

Options for subcommand list-repos

--detail, -l
--start=s

Default value:

0

Options for subcommand rename-repo

--new-name=s*
--repo=s*
--user=s

Options for subcommand repo-exists

--repo=s*
--user=s

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C github-cmd github-cmd

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete github-cmd 'p/*/`github-cmd`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): /home/s1/.config/github-cmd.conf, /home/s1/github-cmd.conf, or /etc/github-cmd.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

Common for all subcommands

access_token (see --access-token)
format (see --format)
log_level (see --log-level)
login (see --login)
naked_res (see --naked-res)
pass (see --pass)

Configuration for subcommand create-repo

description (see --description)
homepage (see --homepage)
repo (see --repo)

Configuration for subcommand delete-repo

repo (see --repo)
user (see --user)

Configuration for subcommand get-repo

repo (see --repo)
user (see --user)

Configuration for subcommand get-user

user (see --user)

Configuration for subcommand list-repos

detail (see --detail)
start (see --start)

Configuration for subcommand rename-repo

new_name (see --new-name)
repo (see --repo)
user (see --user)

Configuration for subcommand repo-exists

repo (see --repo)
user (see --user)

ENVIRONMENT

HP_SGGQBDS_OPT => str

Specify additional command-line options.

FILES

/home/s1/.config/github-cmd.conf

/home/s1/github-cmd.conf

/etc/github-cmd.conf

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

App::ph - another GitHub CLI written by TOKUHIROM. It is last released in 2013 and only contains a few subcommands.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 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.