API-CLI

 view release on metacpan or  search on metacpan

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

<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body>



<ul id="index">
  <li><a href="#NAME">NAME</a></li>
  <li><a href="#ABSTRACT">ABSTRACT</a></li>
  <li><a href="#DESCRIPTION">DESCRIPTION</a>
    <ul>
      <li><a href="#GLOBAL-OPTIONS">GLOBAL OPTIONS</a></li>
      <li><a href="#SUBCOMMANDS">SUBCOMMANDS</a>
        <ul>
          <li><a href="#DELETE">DELETE</a></li>
          <li><a href="#DELETE-gists-:id">DELETE /gists/:id</a></li>
          <li><a href="#DELETE-gists-:id-comments-:commentId">DELETE /gists/:id/comments/:commentId</a></li>
          <li><a href="#DELETE-gists-:id-star">DELETE /gists/:id/star</a></li>
          <li><a href="#DELETE-notifications-threads-:id-subscription">DELETE /notifications/threads/:id/subscription</a></li>
          <li><a href="#DELETE-orgs-:org-members-:username">DELETE /orgs/:org/members/:username</a></li>
          <li><a href="#DELETE-orgs-:org-public_members-:username">DELETE /orgs/:org/public_members/:username</a></li>
          <li><a href="#DELETE-repos-:owner-:repo">DELETE /repos/:owner/:repo</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-collaborators-:user">DELETE /repos/:owner/:repo/collaborators/:user</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-comments-:commentId">DELETE /repos/:owner/:repo/comments/:commentId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-contents-:path">DELETE /repos/:owner/:repo/contents/:path</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-downloads-:downloadId">DELETE /repos/:owner/:repo/downloads/:downloadId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-git-refs-:ref">DELETE /repos/:owner/:repo/git/refs/:ref</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-hooks-:hookId">DELETE /repos/:owner/:repo/hooks/:hookId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-issues-:number-labels">DELETE /repos/:owner/:repo/issues/:number/labels</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-issues-:number-labels-:name">DELETE /repos/:owner/:repo/issues/:number/labels/:name</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-issues-comments-:commentId">DELETE /repos/:owner/:repo/issues/comments/:commentId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-keys-:keyId">DELETE /repos/:owner/:repo/keys/:keyId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-labels-:name">DELETE /repos/:owner/:repo/labels/:name</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-milestones-:number">DELETE /repos/:owner/:repo/milestones/:number</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-pulls-comments-:commentId">DELETE /repos/:owner/:repo/pulls/comments/:commentId</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-releases-:id">DELETE /repos/:owner/:repo/releases/:id</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-releases-assets-:id">DELETE /repos/:owner/:repo/releases/assets/:id</a></li>
          <li><a href="#DELETE-repos-:owner-:repo-subscription">DELETE /repos/:owner/:repo/subscription</a></li>
          <li><a href="#DELETE-teams-:teamId">DELETE /teams/:teamId</a></li>
          <li><a href="#DELETE-teams-:teamId-members-:username">DELETE /teams/:teamId/members/:username</a></li>
          <li><a href="#DELETE-teams-:teamId-memberships-:username">DELETE /teams/:teamId/memberships/:username</a></li>
          <li><a href="#DELETE-teams-:teamId-repos-:owner-:repo">DELETE /teams/:teamId/repos/:owner/:repo</a></li>
          <li><a href="#DELETE-user-emails">DELETE /user/emails</a></li>
          <li><a href="#DELETE-user-following-:username">DELETE /user/following/:username</a></li>
          <li><a href="#DELETE-user-keys-:keyId">DELETE /user/keys/:keyId</a></li>
          <li><a href="#DELETE-user-starred-:owner-:repo">DELETE /user/starred/:owner/:repo</a></li>
          <li><a href="#DELETE-user-subscriptions-:owner-:repo">DELETE /user/subscriptions/:owner/:repo</a></li>
          <li><a href="#GET">GET</a></li>
          <li><a href="#GET-emojis">GET /emojis</a></li>
          <li><a href="#GET-events">GET /events</a></li>
          <li><a href="#GET-feeds">GET /feeds</a></li>
          <li><a href="#GET-gists">GET /gists</a></li>
          <li><a href="#GET-gists-:id">GET /gists/:id</a></li>
          <li><a href="#GET-gists-:id-comments">GET /gists/:id/comments</a></li>
          <li><a href="#GET-gists-:id-comments-:commentId">GET /gists/:id/comments/:commentId</a></li>
          <li><a href="#GET-gists-:id-star">GET /gists/:id/star</a></li>
          <li><a href="#GET-gists-public">GET /gists/public</a></li>
          <li><a href="#GET-gists-starred">GET /gists/starred</a></li>
          <li><a href="#GET-gitignore-templates">GET /gitignore/templates</a></li>

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

    --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>

<p>Parameters:</p>

<pre><code>    org  *  Name of organisation.</code></pre>

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

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

<p>Members list.</p>

<p>Parameters:</p>

<pre><code>    org  *  Name of organisation.</code></pre>

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

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

<p>Check if a user is, publicly or privately, a membe...</p>

<p>Parameters:</p>

<pre><code>    org       *  Name of organisation.
    username  *  Name of the user.    </code></pre>

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

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

<p>Public members list.</p>

<p>Parameters:</p>

<pre><code>    org  *  Name of organisation.</code></pre>

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

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

<p>Check public membership.</p>

<p>Parameters:</p>

<pre><code>    org       *  Name of organisation.
    username  *  Name of the user.    </code></pre>

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

<pre><code>    githubcl GET /orgs/:org/repos [options] &lt;org&gt;</code></pre>

<p>List repositories for the specified org....</p>

<p>Options:</p>

<pre><code>    --q-type    </code></pre>

<p>Parameters:</p>

<pre><code>    org  *  Name of organisation.</code></pre>

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

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

<p>List teams.</p>

<p>Parameters:</p>

<pre><code>    org  *  Name of organisation.</code></pre>

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

<pre><code>    githubcl GET /rate_limit</code></pre>

<p>Get your current rate limit status...</p>

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

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

<p>Get repository.</p>

<p>Parameters:</p>

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

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

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

<p>Get archive link.</p>

<p>Parameters:</p>

<pre><code>    owner           *  Name of repository owner.                 
    repo            *  Name of repository.                       
    archive_format  *                                            
    path            *  Valid Git reference, defaults to &#39;master&#39;.</code></pre>

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

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

<p>List assignees.</p>

<p>Parameters:</p>

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

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

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

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


<p>List who the authenticated user is following....</p>

<h3 id="GET-user-following-:username">GET /user/following/:username</h3>

<pre><code>    githubcl GET /user/following/:username &lt;username&gt;</code></pre>

<p>Check if you are following a user....</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

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

<pre><code>    githubcl GET /user/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-user-keys">GET /user/keys</h3>

<pre><code>    githubcl GET /user/keys</code></pre>

<p>List your public keys.</p>

<h3 id="GET-user-keys-:keyId">GET /user/keys/:keyId</h3>

<pre><code>    githubcl GET /user/keys/:keyId &lt;keyId&gt;</code></pre>

<p>Get a single public key.</p>

<p>Parameters:</p>

<pre><code>    keyId  *  ID of key.</code></pre>

<h3 id="GET-user-orgs">GET /user/orgs</h3>

<pre><code>    githubcl GET /user/orgs</code></pre>

<p>List public and private organizations for the auth...</p>

<h3 id="GET-user-repos">GET /user/repos</h3>

<pre><code>    githubcl GET /user/repos [options]</code></pre>

<p>List repositories for the authenticated user. Note...</p>

<p>Options:</p>

<pre><code>    --q-type    </code></pre>

<h3 id="GET-user-starred">GET /user/starred</h3>

<pre><code>    githubcl GET /user/starred [options]</code></pre>

<p>List repositories being starred by the authenticat...</p>

<p>Options:</p>

<pre><code>    --q-direction    Ignored without &#39;sort&#39; parameter.
    --q-sort                                          </code></pre>

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

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

<p>Check if you are starring a repository....</p>

<p>Parameters:</p>

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

<h3 id="GET-user-subscriptions">GET /user/subscriptions</h3>

<pre><code>    githubcl GET /user/subscriptions</code></pre>

<p>List repositories being watched by the authenticat...</p>

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

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

<p>Check if you are watching a repository....</p>

<p>Parameters:</p>

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

<h3 id="GET-user-teams">GET /user/teams</h3>

<pre><code>    githubcl GET /user/teams</code></pre>

<p>List all of the teams across all of the organizati...</p>

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

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

<p>Get all users.</p>

<p>Options:</p>

<pre><code>    --q-since    The integer ID of the last User that you&#39;ve seen.</code></pre>

<h3 id="GET-users-:username">GET /users/:username</h3>

<pre><code>    githubcl GET /users/:username &lt;username&gt;</code></pre>

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


<p>List a users gists.</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;.                                                 </code></pre>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-keys">GET /users/:username/keys</h3>

<pre><code>    githubcl GET /users/:username/keys &lt;username&gt;</code></pre>

<p>List public keys for a user.</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-orgs">GET /users/:username/orgs</h3>

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

<p>List all public organizations for a user....</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-received_events">GET /users/:username/received_events</h3>

<pre><code>    githubcl GET /users/:username/received_events &lt;username&gt;</code></pre>

<p>These are events that you&#39;ll only see public event...</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-received_events-public">GET /users/:username/received_events/public</h3>

<pre><code>    githubcl GET /users/:username/received_events/public &lt;username&gt;</code></pre>

<p>List public events that a user has received...</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-repos">GET /users/:username/repos</h3>

<pre><code>    githubcl GET /users/:username/repos [options] &lt;username&gt;</code></pre>

<p>List public repositories for the specified user....</p>

<p>Options:</p>

<pre><code>    --q-type    </code></pre>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-starred">GET /users/:username/starred</h3>

<pre><code>    githubcl GET /users/:username/starred &lt;username&gt;</code></pre>

<p>List repositories being starred by a user....</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="GET-users-:username-subscriptions">GET /users/:username/subscriptions</h3>

<pre><code>    githubcl GET /users/:username/subscriptions &lt;username&gt;</code></pre>

<p>List repositories being watched by a user....</p>

<p>Parameters:</p>

<pre><code>    username  *  Name of user.</code></pre>

<h3 id="PATCH">PATCH</h3>

<pre><code>    githubcl  PATCH &lt;subcommands&gt;</code></pre>

<p>PATCH call</p>

<h3 id="PATCH-gists-:id">PATCH /gists/:id</h3>

<pre><code>    githubcl PATCH /gists/:id &lt;id&gt;</code></pre>

<p>Edit a gist.</p>

<p>Parameters:</p>

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

<h3 id="PATCH-gists-:id-comments-:commentId">PATCH /gists/:id/comments/:commentId</h3>

<pre><code>    githubcl PATCH /gists/:id/comments/:commentId &lt;id&gt; &lt;commentId&gt;</code></pre>

<p>Edit a comment.</p>

<p>Parameters:</p>

<pre><code>    id         *  Id of gist.   
    commentId  *  Id of comment.</code></pre>

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

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

<p>Mark a thread as read</p>

<p>Parameters:</p>



( run in 0.638 second using v1.01-cache-2.11-cpan-df04353d9ac )