githubcl - GitHub
--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)
githubcl DELETE <subcommands>
DELETE call
githubcl DELETE /gists/:id <id>
Delete a gist.
Parameters:
id * Id of gist.
githubcl DELETE /gists/:id/comments/:commentId <id> <commentId>
Delete a comment.
Parameters:
id * Id of gist.
commentId * Id of comment.
githubcl DELETE /gists/:id/star <id>
Unstar a gist.
Parameters:
id * Id of gist.
githubcl DELETE /notifications/threads/:id/subscription <id>
Delete a Thread Subscription.
Parameters:
id * Id of thread.
githubcl DELETE /orgs/:org/members/:username <org> <username>
Remove a member.
Parameters:
org * Name of organisation.
username * Name of the user.
githubcl DELETE /orgs/:org/public_members/:username <org> <username>
Conceal a user's membership.
Parameters:
org * Name of organisation.
username * Name of the user.
githubcl DELETE /repos/:owner/:repo <owner> <repo>
Delete a Repository.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl DELETE /repos/:owner/:repo/collaborators/:user <owner> <repo> <user>
Remove collaborator.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
user * Login of the user.
githubcl DELETE /repos/:owner/:repo/comments/:commentId <owner> <repo> <commentId>
Delete a commit comment
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl DELETE /repos/:owner/:repo/contents/:path <owner> <repo> <path>
Delete a file.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
path *
githubcl DELETE /repos/:owner/:repo/downloads/:downloadId <owner> <repo> <downloadId>
Deprecated. Delete a download.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
downloadId * Id of download.
githubcl DELETE /repos/:owner/:repo/git/refs/:ref <owner> <repo> <ref>
Delete a Reference
Parameters:
owner * Name of repository owner.
repo * Name of repository.
ref *
githubcl DELETE /repos/:owner/:repo/hooks/:hookId <owner> <repo> <hookId>
Delete a hook.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
hookId * Id of hook.
githubcl DELETE /repos/:owner/:repo/issues/:number/labels <owner> <repo> <number>
Remove all labels from an issue....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl DELETE /repos/:owner/:repo/issues/:number/labels/:name <owner> <repo> <number> <name>
Remove a label from an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
name * Name of the label.
githubcl DELETE /repos/:owner/:repo/issues/comments/:commentId <owner> <repo> <commentId>
Delete a comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * ID of comment.
githubcl DELETE /repos/:owner/:repo/keys/:keyId <owner> <repo> <keyId>
Delete a key.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
keyId * Id of key.
githubcl DELETE /repos/:owner/:repo/labels/:name <owner> <repo> <name>
Delete a label.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
name * Name of the label.
githubcl DELETE /repos/:owner/:repo/milestones/:number <owner> <repo> <number>
Delete a milestone.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of milestone.
githubcl DELETE /repos/:owner/:repo/pulls/comments/:commentId <owner> <repo> <commentId>
Delete a comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl DELETE /repos/:owner/:repo/releases/:id <owner> <repo> <id>
Users with push access to the repository can delet...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl DELETE /repos/:owner/:repo/releases/assets/:id <owner> <repo> <id>
Delete a release asset
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl DELETE /repos/:owner/:repo/subscription <owner> <repo>
Delete a Repository Subscription....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl DELETE /teams/:teamId <teamId>
Delete team.
Parameters:
teamId * Id of team.
githubcl DELETE /teams/:teamId/members/:username <teamId> <username>
The "Remove team member" API is deprecated and is ...
Parameters:
teamId * Id of team.
username * Name of a member.
githubcl DELETE /teams/:teamId/memberships/:username <teamId> <username>
Remove team membership.
Parameters:
teamId * Id of team.
username * Name of a member.
githubcl DELETE /teams/:teamId/repos/:owner/:repo <teamId> <owner> <repo>
In order to remove a repository from a team, the a...
Parameters:
teamId * Id of team.
owner * Name of a repository owner.
repo * Name of a repository.
githubcl DELETE /user/emails
Delete email address(es).
githubcl DELETE /user/following/:username <username>
Unfollow a user.
Parameters:
username * Name of user.
githubcl DELETE /user/keys/:keyId <keyId>
Delete a public key. Removes a public key. Require...
Parameters:
keyId * ID of key.
githubcl DELETE /user/starred/:owner/:repo <owner> <repo>
Unstar a repository
Parameters:
owner * Name of a repository owner.
repo * Name of a repository.
githubcl DELETE /user/subscriptions/:owner/:repo <owner> <repo>
Stop watching a repository
Parameters:
owner * Name of the owner.
repo * Name of repository.
githubcl GET <subcommands>
GET call
githubcl GET /emojis
Lists all the emojis available to use on GitHub....
githubcl GET /events
List public events.
githubcl GET /feeds
List Feeds.
githubcl GET /gists [options]
List the authenticated user's gists or if called a...
Options:
--q-since Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
githubcl GET /gists/:id <id>
Get a single gist.
Parameters:
id * Id of gist.
githubcl GET /gists/:id/comments <id>
List comments on a gist.
Parameters:
id * Id of gist.
githubcl GET /gists/:id/comments/:commentId <id> <commentId>
Get a single comment.
Parameters:
id * Id of gist.
commentId * Id of comment.
githubcl GET /gists/:id/star <id>
Check if a gist is starred.
Parameters:
id * Id of gist.
githubcl GET /gists/public [options]
List all public gists.
Options:
--q-since Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
githubcl GET /gists/starred [options]
List the authenticated user's starred gists....
Options:
--q-since Timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
Only gists updated at or after this time are returned.
githubcl GET /gitignore/templates
Listing available templates.
githubcl GET /gitignore/templates/:language <language>
Get a single template.
Parameters:
language *
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.
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 *
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
githubcl GET /legacy/user/email/:email <email>
This API call is added for compatibility reasons o...
Parameters:
email * The email address
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
githubcl GET /meta
This gives some information about GitHub.com, the ...
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.
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".
githubcl GET /notifications/threads/:id <id>
View a single thread.
Parameters:
id * Id of thread.
githubcl GET /notifications/threads/:id/subscription <id>
Get a Thread Subscription.
Parameters:
id * Id of thread.
githubcl GET /orgs/:org <org>
Get an Organization.
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/events <org>
List public events for an organization....
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/issues [options] <org>
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.
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/members <org>
Members list.
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/members/:username <org> <username>
Check if a user is, publicly or privately, a membe...
Parameters:
org * Name of organisation.
username * Name of the user.
githubcl GET /orgs/:org/public_members <org>
Public members list.
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/public_members/:username <org> <username>
Check public membership.
Parameters:
org * Name of organisation.
username * Name of the user.
githubcl GET /orgs/:org/repos [options] <org>
List repositories for the specified org....
Options:
--q-type
Parameters:
org * Name of organisation.
githubcl GET /orgs/:org/teams <org>
List teams.
Parameters:
org * Name of organisation.
githubcl GET /rate_limit
Get your current rate limit status...
githubcl GET /repos/:owner/:repo <owner> <repo>
Get repository.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/:archive_format/:path <owner> <repo> <archive_format> <path>
Get archive link.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
archive_format *
path * Valid Git reference, defaults to 'master'.
githubcl GET /repos/:owner/:repo/assignees <owner> <repo>
List assignees.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/assignees/:assignee <owner> <repo> <assignee>
Check assignee.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
assignee * Login of the assignee.
githubcl GET /repos/:owner/:repo/branches <owner> <repo>
Get list of branches
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/branches/:branch <owner> <repo> <branch>
Get Branch
Parameters:
owner * Name of repository owner.
repo * Name of repository.
branch * Name of the branch.
githubcl GET /repos/:owner/:repo/collaborators <owner> <repo>
List.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/collaborators/:user <owner> <repo> <user>
Check if user is a collaborator...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
user * Login of the user.
githubcl GET /repos/:owner/:repo/comments <owner> <repo>
List commit comments for a repository....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/comments/:commentId <owner> <repo> <commentId>
Get a single commit comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl GET /repos/:owner/:repo/commits [options] <owner> <repo>
List commits on a repository.
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".
--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.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/commits/:ref/status <owner> <repo> <ref>
Get the combined Status for a specific Ref...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
ref *
githubcl GET /repos/:owner/:repo/commits/:shaCode <owner> <repo> <shaCode>
Get a single commit.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * SHA-1 code of the commit.
githubcl GET /repos/:owner/:repo/commits/:shaCode/comments <owner> <repo> <shaCode>
List comments for a single commitList comments for...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * SHA-1 code of the commit.
githubcl GET /repos/:owner/:repo/compare/:baseId...:headId <owner> <repo> <baseId> <headId>
Compare two commits
Parameters:
owner * Name of repository owner.
repo * Name of repository.
baseId *
headId *
githubcl GET /repos/:owner/:repo/contents/:path [options] <owner> <repo> <path>
Get contents.
Options:
--q-path The content path.
--q-ref The String name of the Commit/Branch/Tag. Defaults to 'master'.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
path *
githubcl GET /repos/:owner/:repo/contributors [options] <owner> <repo>
Get list of contributors.
Options:
--q-anon * Set to 1 or true to include anonymous contributors in results.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/deployments <owner> <repo>
Users with pull access can view deployments for a ...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/deployments/:id/statuses <owner> <repo> <id>
Users with pull access can view deployment statuse...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id * The Deployment ID to list the statuses from.
githubcl GET /repos/:owner/:repo/downloads <owner> <repo>
Deprecated. List downloads for a repository....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/downloads/:downloadId <owner> <repo> <downloadId>
Deprecated. Get a single download....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
downloadId * Id of download.
githubcl GET /repos/:owner/:repo/events <owner> <repo>
Get list of repository events.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/forks [options] <owner> <repo>
List forks.
Options:
--q-sort
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/git/blobs/:shaCode <owner> <repo> <shaCode>
Get a Blob.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * SHA-1 code.
githubcl GET /repos/:owner/:repo/git/commits/:shaCode <owner> <repo> <shaCode>
Get a Commit.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * SHA-1 code.
githubcl GET /repos/:owner/:repo/git/refs <owner> <repo>
Get all References
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/git/refs/:ref <owner> <repo> <ref>
Get a Reference
Parameters:
owner * Name of repository owner.
repo * Name of repository.
ref *
githubcl GET /repos/:owner/:repo/git/tags/:shaCode <owner> <repo> <shaCode>
Get a Tag.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode *
githubcl GET /repos/:owner/:repo/git/trees/:shaCode [options] <owner> <repo> <shaCode>
Get a Tree.
Options:
--q-recursive Get a Tree Recursively. (0 or 1)
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * Tree SHA.
githubcl GET /repos/:owner/:repo/hooks <owner> <repo>
Get list of hooks.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/hooks/:hookId <owner> <repo> <hookId>
Get single hook.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
hookId * Id of hook.
githubcl GET /repos/:owner/:repo/issues [options] <owner> <repo>
List issues for a repository.
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.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/issues/:number <owner> <repo> <number>
Get a single issue
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl GET /repos/:owner/:repo/issues/:number/comments <owner> <repo> <number>
List comments on an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl GET /repos/:owner/:repo/issues/:number/events <owner> <repo> <number>
List events for an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl GET /repos/:owner/:repo/issues/:number/labels <owner> <repo> <number>
List labels on an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl GET /repos/:owner/:repo/issues/comments [options] <owner> <repo>
List comments in a repository.
Options:
--q-direction Ignored without 'sort' parameter.
--q-sort
--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".
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/issues/comments/:commentId <owner> <repo> <commentId>
Get a single comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * ID of comment.
githubcl GET /repos/:owner/:repo/issues/events <owner> <repo>
List issue events for a repository....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/issues/events/:eventId <owner> <repo> <eventId>
Get a single event.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
eventId * Id of the event.
githubcl GET /repos/:owner/:repo/keys <owner> <repo>
Get list of keys.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/keys/:keyId <owner> <repo> <keyId>
Get a key
Parameters:
owner * Name of repository owner.
repo * Name of repository.
keyId * Id of key.
githubcl GET /repos/:owner/:repo/labels <owner> <repo>
List all labels for this repository....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/labels/:name <owner> <repo> <name>
Get a single label.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
name * Name of the label.
githubcl GET /repos/:owner/:repo/languages <owner> <repo>
List languages.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/milestones [options] <owner> <repo>
List milestones for a repository....
Options:
--q-state String to filter by state.
--q-direction Ignored without 'sort' parameter.
--q-sort
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/milestones/:number <owner> <repo> <number>
Get a single milestone.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of milestone.
githubcl GET /repos/:owner/:repo/milestones/:number/labels <owner> <repo> <number>
Get labels for every issue in a milestone....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of milestone.
githubcl GET /repos/:owner/:repo/notifications [options] <owner> <repo>
List your notifications in a repository...
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".
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/pulls [options] <owner> <repo>
List pull requests.
Options:
--q-state String to filter by state.
--q-head Filter pulls by head user and branch name in the format of 'user:ref-name'.
Example: github:new-script-format.
--q-base Filter pulls by base branch name. Example - gh-pages.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/pulls/:number <owner> <repo> <number>
Get a single pull request.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl GET /repos/:owner/:repo/pulls/:number/comments <owner> <repo> <number>
List comments on a pull request....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl GET /repos/:owner/:repo/pulls/:number/commits <owner> <repo> <number>
List commits on a pull request....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl GET /repos/:owner/:repo/pulls/:number/files <owner> <repo> <number>
List pull requests files.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl GET /repos/:owner/:repo/pulls/:number/merge <owner> <repo> <number>
Get if a pull request has been merged....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl GET /repos/:owner/:repo/pulls/comments [options] <owner> <repo>
List comments in a repository.
Options:
--q-direction Ignored without 'sort' parameter.
--q-sort
--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".
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/pulls/comments/:commentId <owner> <repo> <commentId>
Get a single comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl GET /repos/:owner/:repo/readme [options] <owner> <repo>
Get the README.
Options:
--q-ref The String name of the Commit/Branch/Tag. Defaults to master.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/releases <owner> <repo>
Users with push access to the repository will rece...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/releases/:id <owner> <repo> <id>
Get a single release
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl GET /repos/:owner/:repo/releases/:id/assets <owner> <repo> <id>
List assets for a release
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl GET /repos/:owner/:repo/releases/assets/:id <owner> <repo> <id>
Get a single release asset
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl GET /repos/:owner/:repo/stargazers <owner> <repo>
List Stargazers.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/stats/code_frequency <owner> <repo>
Get the number of additions and deletions per week...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/stats/commit_activity <owner> <repo>
Get the last year of commit activity data....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/stats/contributors <owner> <repo>
Get contributors list with additions, deletions, a...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/stats/participation <owner> <repo>
Get the weekly commit count for the repo owner and...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/stats/punch_card <owner> <repo>
Get the number of commits per hour in each day....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/statuses/:ref <owner> <repo> <ref>
List Statuses for a specific Ref....
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.
githubcl GET /repos/:owner/:repo/subscribers <owner> <repo>
List watchers.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/subscription <owner> <repo>
Get a Repository Subscription.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/tags <owner> <repo>
Get list of tags.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/teams <owner> <repo>
Get list of teams
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl GET /repos/:owner/:repo/watchers <owner> <repo>
List Stargazers. New implementation....
Parameters:
owner * Name of repository owner.
repo * Name of repository.
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".
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.
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.
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.
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.
githubcl GET /teams/:teamId <teamId>
Get team.
Parameters:
teamId * Id of team.
githubcl GET /teams/:teamId/members <teamId>
List team members.
Parameters:
teamId * Id of team.
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.
githubcl GET /teams/:teamId/memberships/:username <teamId> <username>
Get team membership.
Parameters:
teamId * Id of team.
username * Name of a member.
githubcl GET /teams/:teamId/repos <teamId>
List team repos
Parameters:
teamId * Id of team.
githubcl GET /teams/:teamId/repos/:owner/:repo <teamId> <owner> <repo>
Check if a team manages a repository...
Parameters:
teamId * Id of team.
owner * Name of a repository owner.
repo * Name of a repository.
githubcl GET /user
Get the authenticated user.
githubcl GET /user/emails
List email addresses for a user....
githubcl GET /user/followers
List the authenticated user's followers...
githubcl GET /user/following
List who the authenticated user is following....
githubcl GET /user/following/:username <username>
Check if you are following a user....
Parameters:
username * Name of user.
githubcl GET /user/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.
githubcl GET /user/keys
List your public keys.
githubcl GET /user/keys/:keyId <keyId>
Get a single public key.
Parameters:
keyId * ID of key.
githubcl GET /user/orgs
List public and private organizations for the auth...
githubcl GET /user/repos [options]
List repositories for the authenticated user. Note...
Options:
--q-type
githubcl GET /user/starred [options]
List repositories being starred by the authenticat...
Options:
--q-direction Ignored without 'sort' parameter.
--q-sort
githubcl GET /user/starred/:owner/:repo <owner> <repo>
Check if you are starring a repository....
Parameters:
owner * Name of a repository owner.
repo * Name of a repository.
githubcl GET /user/subscriptions
List repositories being watched by the authenticat...
githubcl GET /user/subscriptions/:owner/:repo <owner> <repo>
Check if you are watching a repository....
Parameters:
owner * Name of the owner.
repo * Name of repository.
githubcl GET /user/teams
List all of the teams across all of the organizati...
githubcl GET /users [options]
Get all users.
Options:
--q-since The integer ID of the last User that you've seen.
githubcl GET /users/:username <username>
Get a single user.
Parameters:
username * Name of user.
githubcl GET /users/:username/events <username>
If you are authenticated as the given user, you wi...
Parameters:
username * Name of user.
githubcl GET /users/:username/events/orgs/:org <username> <org>
This is the user's organization dashboard. You mus...
Parameters:
username * Name of user.
org *
githubcl GET /users/:username/followers <username>
List a user's followers
Parameters:
username * Name of user.
githubcl GET /users/:username/following/:targetUser <username> <targetUser>
Check if one user follows another....
Parameters:
username * Name of user.
targetUser * Name of user.
githubcl GET /users/:username/gists [options] <username>
List a users gists.
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".
Parameters:
username * Name of user.
githubcl GET /users/:username/keys <username>
List public keys for a user.
Parameters:
username * Name of user.
githubcl GET /users/:username/orgs <username>
List all public organizations for a user....
Parameters:
username * Name of user.
githubcl GET /users/:username/received_events <username>
These are events that you'll only see public event...
Parameters:
username * Name of user.
githubcl GET /users/:username/received_events/public <username>
List public events that a user has received...
Parameters:
username * Name of user.
githubcl GET /users/:username/repos [options] <username>
List public repositories for the specified user....
Options:
--q-type
Parameters:
username * Name of user.
githubcl GET /users/:username/starred <username>
List repositories being starred by a user....
Parameters:
username * Name of user.
githubcl GET /users/:username/subscriptions <username>
List repositories being watched by a user....
Parameters:
username * Name of user.
githubcl PATCH <subcommands>
PATCH call
githubcl PATCH /gists/:id <id>
Edit a gist.
Parameters:
id * Id of gist.
githubcl PATCH /gists/:id/comments/:commentId <id> <commentId>
Edit a comment.
Parameters:
id * Id of gist.
commentId * Id of comment.
githubcl PATCH /notifications/threads/:id <id>
Mark a thread as read
Parameters:
id * Id of thread.
githubcl PATCH /orgs/:org <org>
Edit an Organization.
Parameters:
org * Name of organisation.
githubcl PATCH /repos/:owner/:repo <owner> <repo>
Edit repository.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl PATCH /repos/:owner/:repo/comments/:commentId <owner> <repo> <commentId>
Update a commit comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl PATCH /repos/:owner/:repo/git/refs/:ref <owner> <repo> <ref>
Update a Reference
Parameters:
owner * Name of repository owner.
repo * Name of repository.
ref *
githubcl PATCH /repos/:owner/:repo/hooks/:hookId <owner> <repo> <hookId>
Edit a hook.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
hookId * Id of hook.
githubcl PATCH /repos/:owner/:repo/issues/:number <owner> <repo> <number>
Edit an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl PATCH /repos/:owner/:repo/issues/comments/:commentId <owner> <repo> <commentId>
Edit a comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * ID of comment.
githubcl PATCH /repos/:owner/:repo/labels/:name <owner> <repo> <name>
Update a label.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
name * Name of the label.
githubcl PATCH /repos/:owner/:repo/milestones/:number <owner> <repo> <number>
Update a milestone.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of milestone.
githubcl PATCH /repos/:owner/:repo/pulls/:number <owner> <repo> <number>
Update a pull request.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Id of pull.
githubcl PATCH /repos/:owner/:repo/pulls/comments/:commentId <owner> <repo> <commentId>
Edit a comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
commentId * Id of comment.
githubcl PATCH /repos/:owner/:repo/releases/:id <owner> <repo> <id>
Users with push access to the repository can edit ...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl PATCH /repos/:owner/:repo/releases/assets/:id <owner> <repo> <id>
Edit a release asset
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id *
githubcl PATCH /teams/:teamId <teamId>
Edit team.
Parameters:
teamId * Id of team.
githubcl PATCH /user
Update the authenticated user.
githubcl POST <subcommands>
POST call
githubcl POST /gists
Create a gist.
githubcl POST /gists/:id/comments <id>
Create a commen
Parameters:
id * Id of gist.
githubcl POST /gists/:id/forks <id>
Fork a gist.
Parameters:
id * Id of gist.
githubcl POST /markdown
Render an arbitrary Markdown document...
githubcl POST /markdown/raw
Render a Markdown document in raw mode...
githubcl POST /orgs/:org/repos <org>
Create a new repository for the authenticated user...
Parameters:
org * Name of organisation.
githubcl POST /orgs/:org/teams <org>
Create team.
Parameters:
org * Name of organisation.
githubcl POST /repos/:owner/:repo/commits/:shaCode/comments <owner> <repo> <shaCode>
Create a commit comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
shaCode * SHA-1 code of the commit.
githubcl POST /repos/:owner/:repo/deployments <owner> <repo>
Users with push access can create a deployment for...
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/deployments/:id/statuses <owner> <repo> <id>
Create a Deployment Status
Parameters:
owner * Name of repository owner.
repo * Name of repository.
id * The Deployment ID to list the statuses from.
githubcl POST /repos/:owner/:repo/forks <owner> <repo>
Create a fork.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/git/blobs <owner> <repo>
Create a Blob.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/git/commits <owner> <repo>
Create a Commit.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/git/refs <owner> <repo>
Create a Reference
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/git/tags <owner> <repo>
Create a Tag Object.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/git/trees <owner> <repo>
Create a Tree.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/hooks <owner> <repo>
Create a hook.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/hooks/:hookId/tests <owner> <repo> <hookId>
Test a push hook.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
hookId * Id of hook.
githubcl POST /repos/:owner/:repo/issues <owner> <repo>
Create an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/issues/:number/comments <owner> <repo> <number>
Create a comment.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl POST /repos/:owner/:repo/issues/:number/labels <owner> <repo> <number>
Add labels to an issue.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
number * Number of issue.
githubcl POST /repos/:owner/:repo/keys <owner> <repo>
Create a key.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/labels <owner> <repo>
Create a label.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/merges <owner> <repo>
Perform a merge.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/milestones <owner> <repo>
Create a milestone.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
githubcl POST /repos/:owner/:repo/pulls <owner> <repo>
Create a pull request.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
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.
githubcl POST /repos/:owner/:repo/releases <owner> <repo>
Create a release
Parameters:
owner * Name of repository owner.
repo * Name of repository.
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.
githubcl POST /user/emails
Add email address(es).
githubcl POST /user/keys
Create a public key.
githubcl POST /user/repos
Create a new repository for the authenticated user...
githubcl PUT <subcommands>
PUT call
githubcl PUT /gists/:id/star <id>
Star a gist.
Parameters:
id * Id of gist.
githubcl PUT /notifications
Mark as read.
githubcl PUT /notifications/threads/:id/subscription <id>
Set a Thread Subscription.
Parameters:
id * Id of thread.
githubcl PUT /orgs/:org/public_members/:username <org> <username>
Publicize a user's membership.
Parameters:
org * Name of organisation.
username * Name of the 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.
githubcl PUT /repos/:owner/:repo/contents/:path <owner> <repo> <path>
Create a file.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
path *
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.
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.
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.
githubcl PUT /repos/:owner/:repo/subscription <owner> <repo>
Set a Repository Subscription
Parameters:
owner * Name of repository owner.
repo * Name of repository.
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.
githubcl PUT /teams/:teamId/memberships/:username <teamId> <username>
Add team membership.
Parameters:
teamId * Id of team.
username * Name of a member.
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.
githubcl PUT /user/following/:username <username>
Follow a user.
Parameters:
username * Name of user.
githubcl PUT /user/starred/:owner/:repo <owner> <repo>
Star a repository.
Parameters:
owner * Name of a repository owner.
repo * Name of a repository.
githubcl PUT /user/subscriptions/:owner/:repo <owner> <repo>
Watch a repository.
Parameters:
owner * Name of the owner.
repo * Name of repository.
githubcl help <subcommands> [options]
Show command help
Options:
--all (flag)
githubcl _meta <subcommands>
Information and utilities for this app
githubcl _meta completion <subcommands>
Shell completion functions
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)
githubcl _meta pod <subcommands>
Pod documentation
githubcl _meta pod generate
Generate self pod