class Github::Search
in a repository, etc.).
you’re looking for (e.g., a specific user, a specific file
The Search API is optimized to help you find the specific item
def code(*args)
github.search.code email: 'wycats'
github = Github.new
= Examples
One of asc or desc; the default is desc.
:order - Optional Sort order if sort parameter is provided.
results are sorted by best match.
by the GitHub search infrastructure. If not provided,
indicates how recently a file has been indexed
:sort - Optional sort field. Can only be indexed, which
supported issue search parameters.
:q - The search terms. This can be any combination of the
= Parameters
(This method returns up to 100 results per page.)
Find file contents via various criteria.
def code(*args) params = arguments(args, required: [:q]).params params['q'] ||= q params['accept'] ||= PREVIEW_MEDIA get_request('/search/code', params) end
def issues(*args)
github.search.legacy.issues q: 'query'
github.search.legacy.issues 'query'
github = Github.new
= Examples
One of asc or desc; the default is desc.
:order - Optional Sort order if sort parameter is provided.
best match.
updated. If not provided, results are sorted by
:sort - Optional sort field. One of comments, created, or
supported issue search parameters.
:q - The search terms. This can be any combination of the
= Parameters
(This method returns up to 100 results per page.)
Find issues by state and keyword.
Search issues
def issues(*args) params = arguments(args, required: [:q]).params params['q'] ||= q params['accept'] ||= PREVIEW_MEDIA get_request('/search/issues' , params) end
def legacy(options = {}, &block)
def legacy(options = {}, &block) @legacy ||= ApiFactory.new('Search::Legacy', current_options.merge(options), &block) end
def repos(*args)
github.search.repos q: 'query'
github.search.repos 'query'
github = Github.new
= Examples
One of asc or desc; the default is desc.
:order - Optional Sort order if sort parameter is provided.
If not provided, results are sorted by best match.
:sort - Optional sort field. One of stars, forks, or updated.
supported issue search parameters.
:q - The search terms. This can be any combination of the
= Parameters
(This method returns up to 100 results per page.)
Find repositories via various criteria.
Search repositories
def repos(*args) params = arguments(args, required: [:q]).params params['q'] ||= q params['accept'] ||= PREVIEW_MEDIA get_request('/search/repositories', arguments.params) end
def users(*args)
github.search.users keyword: 'wycats'
github = Github.new
= Examples
One of asc or desc; the default is desc.
:order - Optional Sort order if sort parameter is provided.
If not provided, results are sorted by best match.
:sort - Optional sort field. One of followers, repositories, or
supported issue search parameters.
:q - The search terms. This can be any combination of the
= Parameters
Find users by keyword.
Search users
def users(*args) params = arguments(args, required: [:q]).params params['q'] ||= q params['accept'] ||= PREVIEW_MEDIA get_request('/search/users', arguments.params) end