API-CLI

 view release on metacpan or  search on metacpan

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


<pre><code>    --q-since    Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.    
                 Only gists updated at or after this time are returned.</code></pre>

<h3 id="GET-gitignore-templates">GET /gitignore/templates</h3>

<pre><code>    githubcl GET /gitignore/templates</code></pre>

<p>Listing available templates.</p>

<h3 id="GET-gitignore-templates-:language">GET /gitignore/templates/:language</h3>

<pre><code>    githubcl GET /gitignore/templates/:language &lt;language&gt;</code></pre>

<p>Get a single template.</p>

<p>Parameters:</p>

<pre><code>    language  *  </code></pre>

<h3 id="GET-issues">GET /issues</h3>

<pre><code>    githubcl GET /issues [options]</code></pre>

<p>List issues.</p>

<p>Options:</p>

<pre><code>    --q-filter     *  Issues assigned to you / created by you / mentioning you / you&#39;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.                 </code></pre>

<h3 id="GET-legacy-issues-search-:owner-:repository-:state-:keyword">GET /legacy/issues/search/:owner/:repository/:state/:keyword</h3>

<pre><code>    githubcl GET /legacy/issues/search/:owner/:repository/:state/:keyword &lt;keyword&gt; &lt;state&gt; &lt;owner&gt; &lt;repository&gt;</code></pre>

<p>Find issues by state and keyword....</p>

<p>Parameters:</p>

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

<h3 id="GET-legacy-repos-search-:keyword">GET /legacy/repos/search/:keyword</h3>

<pre><code>    githubcl GET /legacy/repos/search/:keyword [options] &lt;keyword&gt;</code></pre>

<p>Find repositories by keyword. Note, this legacy me...</p>

<p>Options:</p>

<pre><code>    --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.</code></pre>

<p>Parameters:</p>

<pre><code>    keyword  *  The search term</code></pre>

<h3 id="GET-legacy-user-email-:email">GET /legacy/user/email/:email</h3>

<pre><code>    githubcl GET /legacy/user/email/:email &lt;email&gt;</code></pre>

<p>This API call is added for compatibility reasons o...</p>

<p>Parameters:</p>

<pre><code>    email  *  The email address</code></pre>

<h3 id="GET-legacy-user-search-:keyword">GET /legacy/user/search/:keyword</h3>

<pre><code>    githubcl GET /legacy/user/search/:keyword [options] &lt;keyword&gt;</code></pre>

<p>Find users by keyword.</p>

<p>Options:</p>

<pre><code>    --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.</code></pre>

<p>Parameters:</p>

<pre><code>    keyword  *  The search term</code></pre>

<h3 id="GET-meta">GET /meta</h3>

<pre><code>    githubcl GET /meta</code></pre>

<p>This gives some information about GitHub.com, the ...</p>

<h3 id="GET-networks-:owner-:repo-events">GET /networks/:owner/:repo/events</h3>

<pre><code>    githubcl GET /networks/:owner/:repo/events &lt;owner&gt; &lt;repo&gt;</code></pre>

<p>List public events for a network of repositories....</p>

<p>Parameters:</p>

<pre><code>    owner  *  Name of the owner. 
    repo   *  Name of repository.</code></pre>

<h3 id="GET-notifications">GET /notifications</h3>

<pre><code>    githubcl GET /notifications [options]</code></pre>

<p>List your notifications.</p>

<p>Options:</p>

<pre><code>    --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: &quot;2012-10-09T23:39:01Z&quot;.                                                 </code></pre>

<h3 id="GET-notifications-threads-:id">GET /notifications/threads/:id</h3>

<pre><code>    githubcl GET /notifications/threads/:id &lt;id&gt;</code></pre>

<p>View a single thread.</p>

<p>Parameters:</p>

<pre><code>    id  *  Id of thread.</code></pre>

<h3 id="GET-notifications-threads-:id-subscription">GET /notifications/threads/:id/subscription</h3>

<pre><code>    githubcl GET /notifications/threads/:id/subscription &lt;id&gt;</code></pre>

<p>Get a Thread Subscription.</p>

<p>Parameters:</p>

<pre><code>    id  *  Id of thread.</code></pre>

<h3 id="GET-orgs-:org">GET /orgs/:org</h3>

<pre><code>    githubcl GET /orgs/:org &lt;org&gt;</code></pre>

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

<pre><code>    owner   *  Name of repository owner.
    repo    *  Name of repository.      
    branch  *  Name of the branch.      </code></pre>

<h3 id="GET-repos-:owner-:repo-collaborators">GET /repos/:owner/:repo/collaborators</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/collaborators &lt;owner&gt; &lt;repo&gt;</code></pre>

<p>List.</p>

<p>Parameters:</p>

<pre><code>    owner  *  Name of repository owner.
    repo   *  Name of repository.      </code></pre>

<h3 id="GET-repos-:owner-:repo-collaborators-:user">GET /repos/:owner/:repo/collaborators/:user</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/collaborators/:user &lt;owner&gt; &lt;repo&gt; &lt;user&gt;</code></pre>

<p>Check if user is a collaborator...</p>

<p>Parameters:</p>

<pre><code>    owner  *  Name of repository owner.
    repo   *  Name of repository.      
    user   *  Login of the user.       </code></pre>

<h3 id="GET-repos-:owner-:repo-comments">GET /repos/:owner/:repo/comments</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/comments &lt;owner&gt; &lt;repo&gt;</code></pre>

<p>List commit comments for a repository....</p>

<p>Parameters:</p>

<pre><code>    owner  *  Name of repository owner.
    repo   *  Name of repository.      </code></pre>

<h3 id="GET-repos-:owner-:repo-comments-:commentId">GET /repos/:owner/:repo/comments/:commentId</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/comments/:commentId &lt;owner&gt; &lt;repo&gt; &lt;commentId&gt;</code></pre>

<p>Get a single commit comment.</p>

<p>Parameters:</p>

<pre><code>    owner      *  Name of repository owner.
    repo       *  Name of repository.      
    commentId  *  Id of comment.           </code></pre>

<h3 id="GET-repos-:owner-:repo-commits">GET /repos/:owner/:repo/commits</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/commits [options] &lt;owner&gt; &lt;repo&gt;</code></pre>

<p>List commits on a repository.</p>

<p>Options:</p>

<pre><code>    --q-since     The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
                  Example: &quot;2012-10-09T23:39:01Z&quot;.                                                 
    --q-sha       Sha or branch to start listing commits from.                                     
    --q-path      Only commits containing this file path will be returned.                         
    --q-author    GitHub login, name, or email by which to filter by commit author.                
    --q-until     ISO 8601 Date - Only commits before this date will be returned.                  </code></pre>

<p>Parameters:</p>

<pre><code>    owner  *  Name of repository owner.
    repo   *  Name of repository.      </code></pre>

<h3 id="GET-repos-:owner-:repo-commits-:ref-status">GET /repos/:owner/:repo/commits/:ref/status</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/commits/:ref/status &lt;owner&gt; &lt;repo&gt; &lt;ref&gt;</code></pre>

<p>Get the combined Status for a specific Ref...</p>

<p>Parameters:</p>

<pre><code>    owner  *  Name of repository owner.
    repo   *  Name of repository.      
    ref    *                           </code></pre>

<h3 id="GET-repos-:owner-:repo-commits-:shaCode">GET /repos/:owner/:repo/commits/:shaCode</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/commits/:shaCode &lt;owner&gt; &lt;repo&gt; &lt;shaCode&gt;</code></pre>

<p>Get a single commit.</p>

<p>Parameters:</p>

<pre><code>    owner    *  Name of repository owner.
    repo     *  Name of repository.      
    shaCode  *  SHA-1 code of the commit.</code></pre>

<h3 id="GET-repos-:owner-:repo-commits-:shaCode-comments">GET /repos/:owner/:repo/commits/:shaCode/comments</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/commits/:shaCode/comments &lt;owner&gt; &lt;repo&gt; &lt;shaCode&gt;</code></pre>

<p>List comments for a single commitList comments for...</p>

<p>Parameters:</p>

<pre><code>    owner    *  Name of repository owner.
    repo     *  Name of repository.      
    shaCode  *  SHA-1 code of the commit.</code></pre>

<h3 id="GET-repos-:owner-:repo-compare-:baseId...:headId">GET /repos/:owner/:repo/compare/:baseId...:headId</h3>

<pre><code>    githubcl GET /repos/:owner/:repo/compare/:baseId...:headId &lt;owner&gt; &lt;repo&gt; &lt;baseId&gt; &lt;headId&gt;</code></pre>

<p>Compare two commits</p>

<p>Parameters:</p>

<pre><code>    owner   *  Name of repository owner.
    repo    *  Name of repository.      
    baseId  *                           
    headId  *                           </code></pre>

<h3 id="GET-repos-:owner-:repo-contents-:path">GET /repos/:owner/:repo/contents/:path</h3>



( run in 0.699 second using v1.01-cache-2.11-cpan-cdf2f3d4e48 )