API-CLI
view release on metacpan or search on metacpan
examples/pod/githubcl.pod view on Meta::CPAN
=head1 NAME
githubcl - GitHub
=head1 ABSTRACT
=head1 DESCRIPTION
=head2 GLOBAL OPTIONS
--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)
=head2 SUBCOMMANDS
=head3 DELETE
githubcl DELETE <subcommands>
DELETE call
=head3 DELETE /gists/:id
githubcl DELETE /gists/:id <id>
Delete a gist.
Parameters:
id * Id of gist.
=head3 DELETE /gists/:id/comments/:commentId
githubcl DELETE /gists/:id/comments/:commentId <id> <commentId>
Delete a comment.
Parameters:
id * Id of gist.
commentId * Id of comment.
=head3 DELETE /gists/:id/star
githubcl DELETE /gists/:id/star <id>
Unstar a gist.
Parameters:
id * Id of gist.
=head3 DELETE /notifications/threads/:id/subscription
githubcl DELETE /notifications/threads/:id/subscription <id>
Delete a Thread Subscription.
Parameters:
id * Id of thread.
=head3 DELETE /orgs/:org/members/:username
githubcl DELETE /orgs/:org/members/:username <org> <username>
Remove a member.
Parameters:
org * Name of organisation.
username * Name of the user.
=head3 DELETE /orgs/:org/public_members/:username
githubcl DELETE /orgs/:org/public_members/:username <org> <username>
Conceal a user's membership.
Parameters:
org * Name of organisation.
username * Name of the user.
=head3 DELETE /repos/:owner/:repo
githubcl DELETE /repos/:owner/:repo <owner> <repo>
Delete a Repository.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
=head3 DELETE /repos/:owner/:repo/collaborators/:user
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.
=head3 DELETE /repos/:owner/:repo/comments/:commentId
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.
=head3 DELETE /repos/:owner/:repo/contents/:path
examples/pod/githubcl.pod view on Meta::CPAN
=head3 GET /legacy/user/email/:email
githubcl GET /legacy/user/email/:email <email>
This API call is added for compatibility reasons o...
Parameters:
email * The email address
=head3 GET /legacy/user/search/:keyword
githubcl GET /legacy/user/search/:keyword [options] <keyword>
Find users by keyword.
Options:
--q-order The sort field. if sort param is provided. Can be either asc or desc.
--q-start_page The page number to fetch
--q-sort The sort field. One of stars, forks, or updated. Default: results are sorted by best match.
Parameters:
keyword * The search term
=head3 GET /meta
githubcl GET /meta
This gives some information about GitHub.com, the ...
=head3 GET /networks/:owner/:repo/events
githubcl GET /networks/:owner/:repo/events <owner> <repo>
List public events for a network of repositories....
Parameters:
owner * Name of the owner.
repo * Name of repository.
=head3 GET /notifications
githubcl GET /notifications [options]
List your notifications.
Options:
--q-all True to show notifications marked as read.
--q-participating True to show only notifications in which the user is directly participating
or mentioned.
--q-since The time should be passed in as UTC in the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Example: "2012-10-09T23:39:01Z".
=head3 GET /notifications/threads/:id
githubcl GET /notifications/threads/:id <id>
View a single thread.
Parameters:
id * Id of thread.
=head3 GET /notifications/threads/:id/subscription
githubcl GET /notifications/threads/:id/subscription <id>
Get a Thread Subscription.
Parameters:
id * Id of thread.
=head3 GET /orgs/:org
githubcl GET /orgs/:org <org>
Get an Organization.
Parameters:
org * Name of organisation.
=head3 GET /orgs/:org/events
githubcl GET /orgs/:org/events <org>
List public events for an organization....
Parameters:
org * Name of organisation.
=head3 GET /orgs/:org/issues
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.
=head3 GET /orgs/:org/members
githubcl GET /orgs/:org/members <org>
Members list.
Parameters:
org * Name of organisation.
=head3 GET /orgs/:org/members/:username
githubcl GET /orgs/:org/members/:username <org> <username>
Check if a user is, publicly or privately, a membe...
Parameters:
examples/pod/githubcl.pod view on Meta::CPAN
githubcl GET /users/:username/repos [options] <username>
List public repositories for the specified user....
Options:
--q-type
Parameters:
username * Name of user.
=head3 GET /users/:username/starred
githubcl GET /users/:username/starred <username>
List repositories being starred by a user....
Parameters:
username * Name of user.
=head3 GET /users/:username/subscriptions
githubcl GET /users/:username/subscriptions <username>
List repositories being watched by a user....
Parameters:
username * Name of user.
=head3 PATCH
githubcl PATCH <subcommands>
PATCH call
=head3 PATCH /gists/:id
githubcl PATCH /gists/:id <id>
Edit a gist.
Parameters:
id * Id of gist.
=head3 PATCH /gists/:id/comments/:commentId
githubcl PATCH /gists/:id/comments/:commentId <id> <commentId>
Edit a comment.
Parameters:
id * Id of gist.
commentId * Id of comment.
=head3 PATCH /notifications/threads/:id
githubcl PATCH /notifications/threads/:id <id>
Mark a thread as read
Parameters:
id * Id of thread.
=head3 PATCH /orgs/:org
githubcl PATCH /orgs/:org <org>
Edit an Organization.
Parameters:
org * Name of organisation.
=head3 PATCH /repos/:owner/:repo
githubcl PATCH /repos/:owner/:repo <owner> <repo>
Edit repository.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
=head3 PATCH /repos/:owner/:repo/comments/:commentId
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.
=head3 PATCH /repos/:owner/:repo/git/refs/:ref
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 *
=head3 PATCH /repos/:owner/:repo/hooks/:hookId
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.
=head3 PATCH /repos/:owner/:repo/issues/:number
examples/pod/githubcl.pod view on Meta::CPAN
owner * Name of repository owner.
repo * Name of repository.
=head3 POST /repos/:owner/:repo/statuses/:ref
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.
=head3 POST /user/emails
githubcl POST /user/emails
Add email address(es).
=head3 POST /user/keys
githubcl POST /user/keys
Create a public key.
=head3 POST /user/repos
githubcl POST /user/repos
Create a new repository for the authenticated user...
=head3 PUT
githubcl PUT <subcommands>
PUT call
=head3 PUT /gists/:id/star
githubcl PUT /gists/:id/star <id>
Star a gist.
Parameters:
id * Id of gist.
=head3 PUT /notifications
githubcl PUT /notifications
Mark as read.
=head3 PUT /notifications/threads/:id/subscription
githubcl PUT /notifications/threads/:id/subscription <id>
Set a Thread Subscription.
Parameters:
id * Id of thread.
=head3 PUT /orgs/:org/public_members/:username
githubcl PUT /orgs/:org/public_members/:username <org> <username>
Publicize a user's membership.
Parameters:
org * Name of organisation.
username * Name of the user.
=head3 PUT /repos/:owner/:repo/collaborators/: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.
=head3 PUT /repos/:owner/:repo/contents/:path
githubcl PUT /repos/:owner/:repo/contents/:path <owner> <repo> <path>
Create a file.
Parameters:
owner * Name of repository owner.
repo * Name of repository.
path *
=head3 PUT /repos/:owner/:repo/issues/:number/labels
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.
=head3 PUT /repos/:owner/:repo/notifications
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.
=head3 PUT /repos/:owner/:repo/pulls/:number/merge
( run in 0.635 second using v1.01-cache-2.11-cpan-39bf76dae61 )