view release on metacpan or  search on metacpan

examples/pod/githubcl.pod  view on Meta::CPAN

=head1 NAME

githubcl - GitHub

=head1 ABSTRACT



=head1 DESCRIPTION



=head2 GLOBAL OPTIONS

    --data-file     File with data for POST/PUT/PATCH/DELETE requests
    --debug -d      debug (flag)                                     
    --verbose -v    verbose (flag)                                   
    --help -h       Show command help (flag)                         


=head2 SUBCOMMANDS

=head3  DELETE

    githubcl  DELETE <subcommands>

DELETE call


=head3 DELETE /gists/:id

    githubcl DELETE /gists/:id <id>

Delete a gist.

Parameters:

    id  *  Id of gist.

=head3 DELETE /gists/:id/comments/:commentId

    githubcl DELETE /gists/:id/comments/:commentId <id> <commentId>

Delete a comment.

Parameters:

    id         *  Id of gist.   
    commentId  *  Id of comment.

=head3 DELETE /gists/:id/star

    githubcl DELETE /gists/:id/star <id>

Unstar a gist.

Parameters:

    id  *  Id of gist.

=head3 DELETE /notifications/threads/:id/subscription

    githubcl DELETE /notifications/threads/:id/subscription <id>

Delete a Thread Subscription.

Parameters:

    id  *  Id of thread.

=head3 DELETE /orgs/:org/members/:username

    githubcl DELETE /orgs/:org/members/:username <org> <username>

Remove a member.

examples/pod/githubcl.pod  view on Meta::CPAN

    owner  *  Name of repository owner.
    repo   *  Name of repository.      

=head3 POST /repos/:owner/:repo/pulls/:number/comments

    githubcl POST /repos/:owner/:repo/pulls/:number/comments <owner> <repo> <number>

Create a comment.

Parameters:

    owner   *  Name of repository owner.
    repo    *  Name of repository.      
    number  *  Id of pull.              

=head3 POST /repos/:owner/:repo/releases

    githubcl POST /repos/:owner/:repo/releases <owner> <repo>

Create a release

Parameters:

    owner  *  Name of repository owner.
    repo   *  Name of repository.      

=head3 POST /repos/:owner/:repo/statuses/:ref

    githubcl POST /repos/:owner/:repo/statuses/:ref <owner> <repo> <ref>

Create a Status.

Parameters:

    owner  *  Name of repository owner.                                                    
    repo   *  Name of repository.                                                          
    ref    *  Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.

=head3 POST /user/emails

    githubcl POST /user/emails

Add email address(es).


=head3 POST /user/keys

    githubcl POST /user/keys

Create a public key.


=head3 POST /user/repos

    githubcl POST /user/repos

Create a new repository for the authenticated user...


=head3  PUT

    githubcl  PUT <subcommands>

PUT call


=head3 PUT /gists/:id/star

    githubcl PUT /gists/:id/star <id>

Star a gist.

Parameters:

    id  *  Id of gist.

=head3 PUT /notifications

    githubcl PUT /notifications

Mark as read.


=head3 PUT /notifications/threads/:id/subscription

    githubcl PUT /notifications/threads/:id/subscription <id>

Set a Thread Subscription.

Parameters:

    id  *  Id of thread.

=head3 PUT /orgs/:org/public_members/:username

    githubcl PUT /orgs/:org/public_members/:username <org> <username>

Publicize a user's membership.

Parameters:

    org       *  Name of organisation.
    username  *  Name of the user.    

=head3 PUT /repos/:owner/:repo/collaborators/:user

    githubcl PUT /repos/:owner/:repo/collaborators/:user <owner> <repo> <user>

Add collaborator.

Parameters:

    owner  *  Name of repository owner.
    repo   *  Name of repository.      
    user   *  Login of the user.       

=head3 PUT /repos/:owner/:repo/contents/:path

    githubcl PUT /repos/:owner/:repo/contents/:path <owner> <repo> <path>

Create a file.

Parameters:

    owner  *  Name of repository owner.
    repo   *  Name of repository.      
    path   *                           

=head3 PUT /repos/:owner/:repo/issues/:number/labels

    githubcl PUT /repos/:owner/:repo/issues/:number/labels <owner> <repo> <number>

Replace all labels for an issue....

Parameters:

    owner   *  Name of repository owner.
    repo    *  Name of repository.      
    number  *  Number of issue.         

=head3 PUT /repos/:owner/:repo/notifications

    githubcl PUT /repos/:owner/:repo/notifications <owner> <repo>

Mark notifications as read in a repository....

Parameters:

    owner  *  Name of repository owner.
    repo   *  Name of repository.      

=head3 PUT /repos/:owner/:repo/pulls/:number/merge

    githubcl PUT /repos/:owner/:repo/pulls/:number/merge <owner> <repo> <number>

Merge a pull request (Merge Button's)...

Parameters:

    owner   *  Name of repository owner.
    repo    *  Name of repository.      
    number  *  Id of pull.              

=head3 PUT /repos/:owner/:repo/subscription

    githubcl PUT /repos/:owner/:repo/subscription <owner> <repo>

Set a Repository Subscription

Parameters:

    owner  *  Name of repository owner.
    repo   *  Name of repository.      

=head3 PUT /teams/:teamId/members/:username

    githubcl PUT /teams/:teamId/members/:username <teamId> <username>

The API (described below) is deprecated and is sch...

Parameters:

    teamId    *  Id of team.      
    username  *  Name of a member.

=head3 PUT /teams/:teamId/memberships/:username

    githubcl PUT /teams/:teamId/memberships/:username <teamId> <username>

Add team membership.

Parameters:

    teamId    *  Id of team.      
    username  *  Name of a member.

=head3 PUT /teams/:teamId/repos/:org/:repo

    githubcl PUT /teams/:teamId/repos/:org/:repo <teamId> <org> <repo>

In order to add a repository to a team, the authen...

Parameters:

    teamId  *  Id of team.            
    org     *  Name of a organization.
    repo    *  Name of a repository.  

=head3 PUT /user/following/:username

    githubcl PUT /user/following/:username <username>

Follow a user.

Parameters:

    username  *  Name of user.

=head3 PUT /user/starred/:owner/:repo

    githubcl PUT /user/starred/:owner/:repo <owner> <repo>

Star a repository.

Parameters:

    owner  *  Name of a repository owner.
    repo   *  Name of a repository.      

=head3 PUT /user/subscriptions/:owner/:repo

    githubcl PUT /user/subscriptions/:owner/:repo <owner> <repo>

Watch a repository.

Parameters:

    owner  *  Name of the owner. 
    repo   *  Name of repository.

=head3  help

    githubcl  help <subcommands> [options]

Show command help

Options:

    --all     (flag)


=head3  _meta

    githubcl  _meta <subcommands>

Information and utilities for this app


=head3 _meta completion

    githubcl _meta completion <subcommands>

Shell completion functions


=head3 _meta completion generate

    githubcl _meta completion generate [options]

Generate self completion

Options:

    --name    name of the program (optional, override name in spec)
    --zsh     for zsh (flag)                                       
    --bash    for bash (flag)                                      


=head3 _meta pod

    githubcl _meta pod <subcommands>

Pod documentation


=head3 _meta pod generate

    githubcl _meta pod generate

Generate self pod