API-CLI
view release on metacpan or search on metacpan
examples/html/githubcl.html view on Meta::CPAN
<p>Parameters:</p>
<pre><code> keyId * ID of key.</code></pre>
<h3 id="DELETE-user-starred-:owner-:repo">DELETE /user/starred/:owner/:repo</h3>
<pre><code> githubcl DELETE /user/starred/:owner/:repo <owner> <repo></code></pre>
<p>Unstar a repository</p>
<p>Parameters:</p>
<pre><code> owner * Name of a repository owner.
repo * Name of a repository. </code></pre>
<h3 id="DELETE-user-subscriptions-:owner-:repo">DELETE /user/subscriptions/:owner/:repo</h3>
<pre><code> githubcl DELETE /user/subscriptions/:owner/:repo <owner> <repo></code></pre>
<p>Stop watching a repository</p>
<p>Parameters:</p>
<pre><code> owner * Name of the owner.
repo * Name of repository.</code></pre>
<h3 id="GET">GET</h3>
<pre><code> githubcl GET <subcommands></code></pre>
<p>GET call</p>
<h3 id="GET-emojis">GET /emojis</h3>
<pre><code> githubcl GET /emojis</code></pre>
<p>Lists all the emojis available to use on GitHub....</p>
<h3 id="GET-events">GET /events</h3>
<pre><code> githubcl GET /events</code></pre>
<p>List public events.</p>
<h3 id="GET-feeds">GET /feeds</h3>
<pre><code> githubcl GET /feeds</code></pre>
<p>List Feeds.</p>
<h3 id="GET-gists">GET /gists</h3>
<pre><code> githubcl GET /gists [options]</code></pre>
<p>List the authenticated user's gists or if called a...</p>
<p>Options:</p>
<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-gists-:id">GET /gists/:id</h3>
<pre><code> githubcl GET /gists/:id <id></code></pre>
<p>Get a single gist.</p>
<p>Parameters:</p>
<pre><code> id * Id of gist.</code></pre>
<h3 id="GET-gists-:id-comments">GET /gists/:id/comments</h3>
<pre><code> githubcl GET /gists/:id/comments <id></code></pre>
<p>List comments on a gist.</p>
<p>Parameters:</p>
<pre><code> id * Id of gist.</code></pre>
<h3 id="GET-gists-:id-comments-:commentId">GET /gists/:id/comments/:commentId</h3>
<pre><code> githubcl GET /gists/:id/comments/:commentId <id> <commentId></code></pre>
<p>Get a single comment.</p>
<p>Parameters:</p>
<pre><code> id * Id of gist.
commentId * Id of comment.</code></pre>
<h3 id="GET-gists-:id-star">GET /gists/:id/star</h3>
<pre><code> githubcl GET /gists/:id/star <id></code></pre>
<p>Check if a gist is starred.</p>
<p>Parameters:</p>
<pre><code> id * Id of gist.</code></pre>
<h3 id="GET-gists-public">GET /gists/public</h3>
<pre><code> githubcl GET /gists/public [options]</code></pre>
<p>List all public gists.</p>
<p>Options:</p>
<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-gists-starred">GET /gists/starred</h3>
<pre><code> githubcl GET /gists/starred [options]</code></pre>
<p>List the authenticated user's starred gists....</p>
<p>Options:</p>
<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 <language></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'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 <keyword> <state> <owner> <repository></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] <keyword></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 <email></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] <keyword></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 <owner> <repo></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: "2012-10-09T23:39:01Z". </code></pre>
<h3 id="GET-notifications-threads-:id">GET /notifications/threads/:id</h3>
<pre><code> githubcl GET /notifications/threads/:id <id></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 <id></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 <org></code></pre>
<p>Get an Organization.</p>
<p>Parameters:</p>
<pre><code> org * Name of organisation.</code></pre>
<h3 id="GET-orgs-:org-events">GET /orgs/:org/events</h3>
<pre><code> githubcl GET /orgs/:org/events <org></code></pre>
<p>List public events for an organization....</p>
<p>Parameters:</p>
<pre><code> org * Name of organisation.</code></pre>
<h3 id="GET-orgs-:org-issues">GET /orgs/:org/issues</h3>
<pre><code> githubcl GET /orgs/:org/issues [options] <org></code></pre>
<p>List issues.</p>
<p>Options:</p>
<pre><code> --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. </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 <org></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 <org> <username></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 <org></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 <org> <username></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] <org></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>
examples/html/githubcl.html view on Meta::CPAN
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
shaCode * </code></pre>
<h3 id="GET-repos-:owner-:repo-git-trees-:shaCode">GET /repos/:owner/:repo/git/trees/:shaCode</h3>
<pre><code> githubcl GET /repos/:owner/:repo/git/trees/:shaCode [options] <owner> <repo> <shaCode></code></pre>
<p>Get a Tree.</p>
<p>Options:</p>
<pre><code> --q-recursive Get a Tree Recursively. (0 or 1)</code></pre>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
shaCode * Tree SHA. </code></pre>
<h3 id="GET-repos-:owner-:repo-hooks">GET /repos/:owner/:repo/hooks</h3>
<pre><code> githubcl GET /repos/:owner/:repo/hooks <owner> <repo></code></pre>
<p>Get list of hooks.</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository. </code></pre>
<h3 id="GET-repos-:owner-:repo-hooks-:hookId">GET /repos/:owner/:repo/hooks/:hookId</h3>
<pre><code> githubcl GET /repos/:owner/:repo/hooks/:hookId <owner> <repo> <hookId></code></pre>
<p>Get single hook.</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
hookId * Id of hook. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues">GET /repos/:owner/:repo/issues</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues [options] <owner> <repo></code></pre>
<p>List issues for a repository.</p>
<p>Options:</p>
<pre><code> --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. </code></pre>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues-:number">GET /repos/:owner/:repo/issues/:number</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues/:number <owner> <repo> <number></code></pre>
<p>Get a single issue</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
number * Number of issue. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues-:number-comments">GET /repos/:owner/:repo/issues/:number/comments</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues/:number/comments <owner> <repo> <number></code></pre>
<p>List comments on an issue.</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
number * Number of issue. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues-:number-events">GET /repos/:owner/:repo/issues/:number/events</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues/:number/events <owner> <repo> <number></code></pre>
<p>List events for an issue.</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
number * Number of issue. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues-:number-labels">GET /repos/:owner/:repo/issues/:number/labels</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues/:number/labels <owner> <repo> <number></code></pre>
<p>List labels on an issue.</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository.
number * Number of issue. </code></pre>
<h3 id="GET-repos-:owner-:repo-issues-comments">GET /repos/:owner/:repo/issues/comments</h3>
<pre><code> githubcl GET /repos/:owner/:repo/issues/comments [options] <owner> <repo></code></pre>
<p>List comments in a repository.</p>
examples/html/githubcl.html view on Meta::CPAN
repo * Name of repository. </code></pre>
<h3 id="GET-repos-:owner-:repo-watchers">GET /repos/:owner/:repo/watchers</h3>
<pre><code> githubcl GET /repos/:owner/:repo/watchers <owner> <repo></code></pre>
<p>List Stargazers. New implementation....</p>
<p>Parameters:</p>
<pre><code> owner * Name of repository owner.
repo * Name of repository. </code></pre>
<h3 id="GET-repositories">GET /repositories</h3>
<pre><code> githubcl GET /repositories [options]</code></pre>
<p>List all public repositories.</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: "2012-10-09T23:39:01Z". </code></pre>
<h3 id="GET-search-code">GET /search/code</h3>
<pre><code> githubcl GET /search/code [options]</code></pre>
<p>Search code.</p>
<p>Options:</p>
<pre><code> --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. </code></pre>
<h3 id="GET-search-issues">GET /search/issues</h3>
<pre><code> githubcl GET /search/issues [options]</code></pre>
<p>Find issues by state and keyword. (This method ret...</p>
<p>Options:</p>
<pre><code> --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.</code></pre>
<h3 id="GET-search-repositories">GET /search/repositories</h3>
<pre><code> githubcl GET /search/repositories [options]</code></pre>
<p>Search repositories.</p>
<p>Options:</p>
<pre><code> --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. </code></pre>
<h3 id="GET-search-users">GET /search/users</h3>
<pre><code> githubcl GET /search/users [options]</code></pre>
<p>Search users.</p>
<p>Options:</p>
<pre><code> --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. </code></pre>
<h3 id="GET-teams-:teamId">GET /teams/:teamId</h3>
<pre><code> githubcl GET /teams/:teamId <teamId></code></pre>
<p>Get team.</p>
<p>Parameters:</p>
<pre><code> teamId * Id of team.</code></pre>
<h3 id="GET-teams-:teamId-members">GET /teams/:teamId/members</h3>
<pre><code> githubcl GET /teams/:teamId/members <teamId></code></pre>
<p>List team members.</p>
<p>Parameters:</p>
<pre><code> teamId * Id of team.</code></pre>
<h3 id="GET-teams-:teamId-members-:username">GET /teams/:teamId/members/:username</h3>
<pre><code> githubcl GET /teams/:teamId/members/:username <teamId> <username></code></pre>
<p>The "Get team member" API is deprecated and is sch...</p>
<p>Parameters:</p>
<pre><code> teamId * Id of team.
username * Name of a member.</code></pre>
<h3 id="GET-teams-:teamId-memberships-:username">GET /teams/:teamId/memberships/:username</h3>
examples/html/githubcl.html view on Meta::CPAN
<pre><code> githubcl GET /teams/:teamId/repos/:owner/:repo <teamId> <owner> <repo></code></pre>
<p>Check if a team manages a repository...</p>
<p>Parameters:</p>
<pre><code> teamId * Id of team.
owner * Name of a repository owner.
repo * Name of a repository. </code></pre>
<h3 id="GET-user">GET /user</h3>
<pre><code> githubcl GET /user</code></pre>
<p>Get the authenticated user.</p>
<h3 id="GET-user-emails">GET /user/emails</h3>
<pre><code> githubcl GET /user/emails</code></pre>
<p>List email addresses for a user....</p>
<h3 id="GET-user-followers">GET /user/followers</h3>
<pre><code> githubcl GET /user/followers</code></pre>
<p>List the authenticated user's followers...</p>
<h3 id="GET-user-following">GET /user/following</h3>
<pre><code> githubcl GET /user/following</code></pre>
<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 <username></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'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 <keyId></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 'sort' 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 <owner> <repo></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>
( run in 0.394 second using v1.01-cache-2.11-cpan-acebb50784d )