steampipe plugin install github

Table: github_search_user - Query GitHub Users using SQL

GitHub Users is a resource within GitHub that represents an individual or organization account. It holds information about the user's profile, including login name, type, and other details. GitHub Users provide a way to interact with the user's repositories, gists, followers, and more.

Table Usage Guide

The github_search_user table provides insights into user profiles within GitHub. As a developer or a security analyst, explore user-specific details through this table, including login name, type, and score. Utilize it to uncover information about users, such as their activity, repositories they have access to, and their general profile information.

Important Notes

  • You must always include at least one search term when searching users in the where or join clause using the query column. See Searching users for details on the GitHub query syntax.

Examples

List users

Identify instances where users have 'turbot' in their name within GitHub. This can help you find specific user profiles related to 'turbot' for further analysis or contact.

select
id,
login,
type,
url
from
github_search_user
where
query = 'turbot in:name type:user';
select
id,
login,
type,
url
from
github_search_user
where
query = 'turbot in:name type:user';

List organizations

Determine the areas in which specific organizations are operating by exploring their login details and types. This is useful in understanding the organizations' online presence and their categorization.

select
id,
login,
type,
url
from
github_search_user
where
query = 'turbotio in:login type:org';
select
id,
login,
type,
url
from
github_search_user
where
query = 'turbotio in:login type:org';

Get user with specific username

Explore which GitHub user corresponds to a specific username. This is useful for finding detailed information about a particular user, such as their unique ID, login type, and URL.

select
id,
login,
type,
url
from
github_search_user
where
query = 'user:c0d3r-arnab';
select
id,
login,
type,
url
from
github_search_user
where
query = 'user:c0d3r-arnab';

List organizations with over 10000 repositories

This query is useful for identifying large-scale organizations on GitHub, specifically those that have more than 10,000 repositories. It can be used to understand the scale of open-source contributions or to target potential collaborations with prolific organizations.

select
id,
login,
type,
url
from
github_search_user
where
query = 'repos:>10000 type:org';
select
id,
login,
type,
url
from
github_search_user
where
query = 'repos:>10000 type:org';

List users and organizations created between specific timestamp

Discover the segments that were added to your GitHub user base within a specific timeframe. This can help you assess the growth and monitor the activity on your platform during that period.

select
id,
login,
type,
url
from
github_search_user
where
query = 'created:2021-01-01..2021-01-31 turbot';
select
id,
login,
type,
url
from
github_search_user
where
query = 'created:2021-01-01..2021-01-31 turbot';

Schema for github_search_user

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
avatar_urltextThe URL of the user/organization's avatar.
biotextThe biography of the user.
can_followbooleanIf true, you can follow this user/organization.
can_sponsorbooleanIf true, you can sponsor this user/organization.
companytextThe company on the users profile.
created_attimestamp with time zoneTimestamp when user/organization was created.
descriptiontextThe description of the organization.
emailtextThe email of the user/organization.
idbigintThe ID of the user/organization.
is_bounty_hunterbooleanIf true, user is a participant in the GitHub security bug bounty.
is_campus_expertbooleanIf true, user is a participant in the GitHub campus experts program.
is_developer_program_memberbooleanIf true, user is a GitHub developer program member.
is_employeebooleanIf true, user is a GitHub employee.
is_followingbooleanIf true, you are following this user/organization.
is_following_youbooleanIf true, user follows you.
is_github_starbooleanIf true, user is a member of the GitHub Stars Program.
is_hireablebooleanIf true, user has marked themselves as for hire.
is_site_adminbooleanIf true, user is a site administrator.
is_sponsoringbooleanIf true, you are sponsoring this user/organization.
is_youbooleanIf true, user is you.
locationtextThe location of the user/organization.
logintextThe login name of the user/organization.
login_idtext=, !=, ~~, ~~*, !~~, !~~*Unique identifier for the user login.
nametextThe display name of the user/organization.
node_idtextThe node ID of the user/organization.
projects_urltextThe URL listing user/organization's projects.
querytext=The query provided for the search.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
text_matchesjsonbThe text match details.
twitter_usernametextTwitter username of the user/organization.
typetextIndicates if item is User or Organization.
updated_attimestamp with time zoneTimestamp when user/organization was last updated.
urltextThe URL of the user/organization's GitHub page.
website_urltextThe URL pointing to the user/organization's public website/blog.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- github

You can pass the configuration to the command with the --config argument:

steampipe_export_github --config '<your_config>' github_search_user