API-CLI

 view release on metacpan or  search on metacpan

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


=head3 GET /gitignore/templates

    githubcl GET /gitignore/templates

Listing available templates.


=head3 GET /gitignore/templates/:language

    githubcl GET /gitignore/templates/:language <language>

Get a single template.

Parameters:

    language  *  

=head3 GET /issues

    githubcl GET /issues [options]

List issues.

Options:

    --q-filter     *  Issues assigned to you / created by you / mentioning you / you're       
                      subscribed to updates for / All issues the authenticated user can see   
    --q-state      *                                                                          
    --q-labels     *  String list of comma separated Label names. Example - bug,ui,@high.     
    --q-sort       *                                                                          
    --q-direction  *                                                                          
    --q-since         Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
                      Only issues updated at or after this time are returned.                 


=head3 GET /legacy/issues/search/:owner/:repository/:state/:keyword

    githubcl GET /legacy/issues/search/:owner/:repository/:state/:keyword <keyword> <state> <owner> <repository>

Find issues by state and keyword....

Parameters:

    keyword     *  The search term.                                                          
    state       *  Indicates the state of the issues to return. Can be either open or closed.
    owner       *                                                                            
    repository  *                                                                            

=head3 GET /legacy/repos/search/:keyword

    githubcl GET /legacy/repos/search/:keyword [options] <keyword>

Find repositories by keyword. Note, this legacy me...

Options:

    --q-order         The sort field. if sort param is provided. Can be either asc or desc.                      
    --q-language      Filter results by language                                                                 
    --q-start_page    The page number to fetch                                                                   
    --q-sort          The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

Parameters:

    keyword  *  The search term

=head3 GET /legacy/user/email/:email

    githubcl GET /legacy/user/email/:email <email>

This API call is added for compatibility reasons o...

Parameters:

    email  *  The email address

=head3 GET /legacy/user/search/:keyword

    githubcl GET /legacy/user/search/:keyword [options] <keyword>

Find users by keyword.

Options:

    --q-order         The sort field. if sort param is provided. Can be either asc or desc.                      
    --q-start_page    The page number to fetch                                                                   
    --q-sort          The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

Parameters:

    keyword  *  The search term

=head3 GET /meta

    githubcl GET /meta

This gives some information about GitHub.com, the ...


=head3 GET /networks/:owner/:repo/events

    githubcl GET /networks/:owner/:repo/events <owner> <repo>

List public events for a network of repositories....

Parameters:

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

=head3 GET /notifications

    githubcl GET /notifications [options]

List your notifications.

Options:

    --q-all              True to show notifications marked as read.                                       
    --q-participating    True to show only notifications in which the user is directly participating      
                         or mentioned.                                                                    
    --q-since            The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
                         Example: "2012-10-09T23:39:01Z".                                                 


=head3 GET /notifications/threads/:id

    githubcl GET /notifications/threads/:id <id>

View a single thread.

Parameters:

    id  *  Id of thread.

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

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

Get a Thread Subscription.

Parameters:

    id  *  Id of thread.

=head3 GET /orgs/:org

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

    repo   *  Name of repository.      

=head3 GET /repos/:owner/:repo/teams

    githubcl GET /repos/:owner/:repo/teams <owner> <repo>

Get list of teams

Parameters:

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

=head3 GET /repos/:owner/:repo/watchers

    githubcl GET /repos/:owner/:repo/watchers <owner> <repo>

List Stargazers. New implementation....

Parameters:

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

=head3 GET /repositories

    githubcl GET /repositories [options]

List all public repositories.

Options:

    --q-since    The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
                 Example: "2012-10-09T23:39:01Z".                                                 


=head3 GET /search/code

    githubcl GET /search/code [options]

Search code.

Options:

    --q-order     The sort field. if sort param is provided. Can be either asc or desc.      
    --q-q      *  The search terms. This can be any combination of the supported code        
                  search parameters:                                                         
                  'Search In' Qualifies which fields are searched. With this qualifier       
                  you can restrict the search to just the file contents, the file path,      
                  or both.                                                                   
                  'Languages' Searches code based on the language it's written in.           
                  'Forks' Filters repositories based on the number of forks, and/or          
                  whether code from forked repositories should be included in the results    
                  at all.                                                                    
                  'Size' Finds files that match a certain size (in bytes).                   
                  'Path' Specifies the path that the resulting file must be at.              
                  'Extension' Matches files with a certain extension.                        
                  'Users' or 'Repositories' Limits searches to a specific user or repository.
    --q-sort      Can only be 'indexed', which indicates how recently a file has been indexed
                  by the GitHub search infrastructure. If not provided, results are sorted   
                  by best match.                                                             


=head3 GET /search/issues

    githubcl GET /search/issues [options]

Find issues by state and keyword. (This method ret...

Options:

    --q-order     The sort field. if sort param is provided. Can be either asc or desc.                           
    --q-q      *  The q search term can also contain any combination of the supported issue search qualifiers:    
    --q-sort      The sort field. Can be comments, created, or updated. Default: results are sorted by best match.


=head3 GET /search/repositories

    githubcl GET /search/repositories [options]

Search repositories.

Options:

    --q-order     The sort field. if sort param is provided. Can be either asc or desc.       
    --q-q      *  The search terms. This can be any combination of the supported repository   
                  search parameters:                                                          
                  'Search In' Qualifies which fields are searched. With this qualifier you    
                  can restrict the search to just the repository name, description, readme,   
                  or any combination of these.                                                
                  'Size' Finds repositories that match a certain size (in kilobytes).         
                  'Forks' Filters repositories based on the number of forks, and/or whether   
                  forked repositories should be included in the results at all.               
                  'Created' and 'Last Updated' Filters repositories based on times of         
                  creation, or when they were last updated.                                   
                  'Users or Repositories' Limits searches to a specific user or repository.   
                  'Languages' Searches repositories based on the language they are written in.
                  'Stars' Searches repositories based on the number of stars.                 
    --q-sort      If not provided, results are sorted by best match.                          


=head3 GET /search/users

    githubcl GET /search/users [options]

Search users.

Options:

    --q-order     The sort field. if sort param is provided. Can be either asc or desc.    
    --q-q      *  The search terms. This can be any combination of the supported user      
                  search parameters:                                                       
                  'Search In' Qualifies which fields are searched. With this qualifier you 
                  can restrict the search to just the username, public email, full name,   
                  location, or any combination of these.                                   
                  'Repository count' Filters users based on the number of repositories they
                  have.                                                                    
                  'Location' Filter users by the location indicated in their profile.      
                  'Language' Search for users that have repositories that match a certain  
                  language.                                                                
                  'Created' Filter users based on when they joined.                        
                  'Followers' Filter users based on the number of followers they have.     
    --q-sort      If not provided, results are sorted by best match.                       


=head3 GET /teams/:teamId

    githubcl GET /teams/:teamId <teamId>

Get team.

Parameters:

    teamId  *  Id of team.

=head3 GET /teams/:teamId/members

    githubcl GET /teams/:teamId/members <teamId>

List team members.

Parameters:

    teamId  *  Id of team.

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

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

The "Get team member" API is deprecated and is sch...

Parameters:

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

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

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

Get team membership.

Parameters:

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

=head3 GET /teams/:teamId/repos

    githubcl GET /teams/:teamId/repos <teamId>

List team repos

Parameters:

    teamId  *  Id of team.

=head3 GET /teams/:teamId/repos/:owner/:repo

    githubcl GET /teams/:teamId/repos/:owner/:repo <teamId> <owner> <repo>

Check if a team manages a repository...



( run in 1.158 second using v1.01-cache-2.11-cpan-39bf76dae61 )