Name: ok.sh
Owner: Clear Linux* Project for Intel Architecture
Description: A Bourne shell GitHub API client library focused on interfacing with shell scripts
Created: 2015-10-05 14:49:35.0
Updated: 2016-07-26 17:05:05.0
Pushed: 2015-10-05 15:26:44.0
Size: 230
Language: Shell
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Authentication credentials are read from a ~/.netrc
file.
Generate the token on GitHub under “Account Settings -> Applications”.
Restrict permissions on that file with chmod 600 ~/.netrc
!
machine api.github.com
login <username>
password <token>
The following environment variables may be set to customize ok.sh.
Usage: ok.sh [<flags>] (command [<arg>, <name=value>...])
ok.sh -h # Short, usage help text.
ok.sh help # All help text. Warning: long!
ok.sh help command # Command-specific help text.
ok.sh command # Run a command with and without args.
ok.sh command foo bar baz=Baz qux='Qux arg here'
See the full list of commands below.
Flags must be the first argument to ok.sh
, before command
.
Flag | Description —- | ———– -V | Show version. -h | Show this screen. -j | Output raw JSON; don't process with jq. -q | Quiet; don't print to stdout. -r | Print current GitHub API rate limit to stderr. -v | Logging output; specify multiple times: info, debug, trace. -x | Enable xtrace debug logging. -y | Answer 'yes' to any prompts.
all_funcs, main, log, helptext, format_json, format_urlencode, filter_json, get_mime_type, get_confirm, opts_filter, opts_pagination, opts_qs, request, response, get, post, _delete
help, show_scopes, org_repos, org_teams, list_repos, create_repo, delete_repo, list_releases, release, create_release, delete_release, release_assets, upload_asset, list_milestones, list_issues, user_issues, org_issues
Output the help text for a command
Usage:
help commandname
Positional arguments
$1
Function name to search for; if omitted searches whole file.List all functions found in the current file in the order they appear
Keyword arguments
1
0
output one function per line; 1
output a formatted paragraph.1
0
do not output public functions.1
0
do not output private functions.A lightweight logging system based on file descriptors
Usage:
_log debug 'Starting the combobulator!'
Positional arguments
$1
The level for a given log message. (info or debug)$2
The log message.Extract contiguous lines of comments and function params as help text
Indentation will be ignored. She-bangs will be ignored. The _main() function will be ignored. Local variable declarations and their default values can also be pulled in as documentation. Exits upon encountering the first blank line.
Exported environment variables can be used for string interpolation in the extracted commented text.
Input
Positional arguments
$1
A file name to parse.Create formatted JSON from name=value pairs
Usage:
mat_json foo=Foo bar=123 baz=true qux=Qux=Qux quux='Multi-line
ng'
Return:
r":123,"qux":"Qux=Qux","foo":"Foo","quux":"Multi-line\nstring","baz":true}
Tries not to quote numbers and booleans. If jq is installed it will also validate the output.
Positional arguments
name=value
which will be
added to a single, flat JSON object.URL encode and join name=value pairs
Usage:
mat_urlencode foo='Foo Foo' bar='<Bar>&/Bar/'
Return:
Foo%20Foo&bar=%3CBar%3E%26%2FBar%2F
Ignores pairs if the value begins with an underscore.
Filter JSON input using jq; outputs raw JSON if jq is not installed
Usage:
_filter_json '.[] | "\(.foo)"' < something.json
$1
A string of jq filters to apply to the input stream.Guess the mime type for a file based on the file extension
Usage:
local mime_type
_get_mime_type "foo.tar"; printf 'mime is: %s' "$mime_type"
Sets the global variable mime_type
with the result. (If this function
is called from within a function that has declared a local variable of
that name it will update the local copy and not set a global.)
Positional arguments
$1
The full name of the file, with exension.Prompt the user for confirmation
Usage:
local confirm; _get_confirm
[ "$confirm" -eq 1 ] && printf 'Good to go!\n'
If global confirmation is set via $OK_SH_DESTRUCTIVE
then the user
is not prompted. Assigns the user's confirmation to the confirm
global
variable. (If this function is called within a function that has a local
variable of that name, the local variable will be updated instead.)
Positional arguments
$1
The message to prompt the user with.Extract common jq filter keyword options and assign to vars
Usage:
local filter
_opts_filter "$@"
Extract common pagination keyword options and assign to vars
Usage:
local _follow_next
_opts_pagination "$@"
Format a querystring to append to an URL or a blank string
Usage:
local qs
_opts_qs "$@"
_get "/some/path"
A wrapper around making HTTP requests with curl
Usage:
uest /repos/:owner/:repo/issues
tf '{"title": "%s", "body": "%s"}\n' "Stuff" "Things" \
_request /repos/:owner/:repo/issues | jq -r '.[url]'
tf '{"title": "%s", "body": "%s"}\n' "Stuff" "Things" \
_request /repos/:owner/:repo/issues method=PUT | jq -r '.[url]'
Input
Positional arguments
$1
The URL path for the HTTP request.
Must be an absolute path that starts with a /
or a full URL that
starts with http(s). Absolute paths will be append to the value in
$OK_SH_URL
.Keyword arguments
'GET'
The method to use for the HTTP request.'application/json'
The value of the Content-Type header to use for the request.Process an HTTP response from curl
Output only headers of interest followed by the response body. Additional processing is performed on select headers to make them easier to work with in sh. See below.
Usage:
uest /some/path | _response status_code ETag Link_next
-isS example.com/some/path | _response status_code status_text | {
cal status_code status_text
ad -r status_code
ad -r status_text
Header reformatting
http_version
, status_code
, and
status_text
variables.Link_first
, Link_last
, Link_next
.Positional arguments
Guess the mime type for a file based on the file extension
Usage:
local mime_type
_get_mime_type "foo.tar"; printf 'mime is: %s' "$mime_type"
Sets the global variable mime_type
with the result. (If this function
is called from within a function that has declared a local variable of
that name it will update the local copy and not set a global.)
Positional arguments
$1
The full name of the file, with exension.A wrapper around _request() for commoon POST / PUT patterns
Usage:
_format_json foo=Foo bar=Bar | _post /some/path
_format_json foo=Foo bar=Bar | _post /some/path method='PUT'
_post /some/path filename=somearchive.tar
_post /some/path filename=somearchive.tar mime_type=application/x-tar
_post /some/path filename=somearchive.tar \
mime_type=$(file -b --mime-type somearchive.tar)
Input
filename
argument also.
Data that will be used as the request body.Positional arguments
$1
The HTTP path or URL to pass to _request().Keyword arguments
'POST'
The method to use for the HTTP request.filename
Optional. See the stdin
option above also.
Takes precedence over any data passed as stdin and loads a file off the
file system to serve as the request body.mime_type
The value of the Content-Type header to use for the request.
If the filename
argument is given this value will be guessed from the
file extension. If the filename
argument is not given (i.e., using
stdin) this value defaults to application/json
. Specifying this
argument overrides all other defaults or guesses.A wrapper around _request() for common DELETE patterns
Usage:
_delete '/some/url'
Return: 0 for success; 1 for failure.
Positional arguments
$1
The URL to send the DELETE request to.Show the permission scopes for the currently authenticated user
Usage:
show_scopes
List organization repositories
Usage:
org_repos myorg
org_repos myorg type=private per_page=10
org_repos myorg _filter='.[] | "\(.name)\t\(.owner.login)"'
Positional arguments
$1
Organization GitHub login or id for which to list repos.Keyword arguments
'.[] | "\(.name)\t\(.ssh_url)"'
A jq filter to apply to the return data.Querystring arguments may also be passed as keyword arguments: per_page, type
List teams
Usage:
org_teams org
Positional arguments
$1
Organization GitHub login or id.Keyword arguments
'.[] | "\(.name)\t\(.id)\t\(.permission)"'
A jq filter to apply to the return data.List user repositories
Usage:
list_repos
list_repos user
Positional arguments
$1
Optional GitHub user login or id for which to list repos.Keyword arguments
'.[] | "\(.name)\t\(.html_url)"'
A jq filter to apply to the return data.Querystring arguments may also be passed as keyword arguments: per_page, type, sort, direction
Create a repository for a user or organization
Usage:
create_repo foo
create_repo bar description='Stuff and things' homepage='example.com'
create_repo baz organization=myorg
Positional arguments
$1
Name of the new repoKeyword arguments
'.[] | "\(.name)\t\(.html_url)"'
A jq filter to apply to the return data.POST data may also be passed as keyword arguments: description, homepage, private, has_issues, has_wiki, has_downloads, organization, team_id, auto_init, gitignore_template
Create a repository for a user or organization
Usage:
delete_repo owner repo
The currently authenticated user must have the delete_repo
scope. View
current scopes with the show_scopes()
function.
Positional arguments
$1
Name of the new repo$2
Name of the new repoList releases for a repository
Usage:
list_releases org repo '\(.assets[0].name)\t\(.name.id)'
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.Keyword arguments
'.[] | "\(.name)\t\(.id)\t\(.html_url)"'
A jq filter to apply to the return data.Get a release
Usage:
release user repo 1087855
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.$3
The unique ID of the release; see list_releases.Keyword arguments
'"\(.author.login)\t\(.published_at)"'
A jq filter to apply to the return data.Create a release
Usage:
create_release org repo v1.2.3
create_release user repo v3.2.1 draft=true
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.$3
Git tag from which to create release.Keyword arguments
'"\(.name)\t\(.id)\t\(.html_url)"'
A jq filter to apply to the return data.POST data may also be passed as keyword arguments: body, draft, name, prerelease, target_commitish
Delete a release
Usage:
delete_release org repo 1087855
Return: 0 for success; 1 for failure.
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.$3
The unique ID of the release; see list_releases.List release assets
Usage:
release_assets user repo 1087855
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.$3
The unique ID of the release; see list_releases.Keyword arguments
'.[] | "\(.id)\t\(.name)\t\(.updated_at)"'
A jq filter to apply to the return data.Upload a release asset
Note, this command requires jq
to find the release upload_url
.
Usage:
upload_asset username reponame 1087938 \
foo.tar application/x-tar < foo.tar
Positional arguments
$1
A GitHub user or organization.$2
A GitHub repository.$3
The unique ID of the release; see list_releases.$4
The file name of the asset.Keyword arguments
'"\(.state)\t\(.browser_download_url)"'
A jq filter to apply to the return data.List milestones for a repository
Usage:
list_milestones someuser/somerepo
list_milestones someuser/somerepo state=closed
Positional arguments
$1
A GitHub repository.Keyword arguments
_follow_next
Automatically look for a 'Links' header and follow any 'next' URLs._follow_next_limit
Maximum number of 'next' URLs to follow before stopping.'.[] | "\(.number)\t\(.open_issues)/\(.closed_issues)\t\(.title)"'
A jq filter to apply to the return data.GitHub querystring arguments may also be passed as keyword arguments: per_page, state, sort, direction
List issues for the authenticated user or repository
Usage:
list_issues
list_issues someuser/somerepo
list_issues someuser/somerepo state=closed labels=foo,bar
Positional arguments
$1
A GitHub repository.Keyword arguments
_follow_next
Automatically look for a 'Links' header and follow any 'next' URLs._follow_next_limit
Maximum number of 'next' URLs to follow before stopping.'.[] | "\(.number)\t\(.title)"'
A jq filter to apply to the return data.GitHub querystring arguments may also be passed as keyword arguments: per_page, milestone, state, assignee, creator, mentioned, labels, sort, direction, since
List all issues across owned and member repositories for the authenticated user
Usage:
user_issues
user_issues since=2015-60-11T00:09:00Z
Positional arguments
$1
A GitHub repository.Keyword arguments
_follow_next
Automatically look for a 'Links' header and follow any 'next' URLs._follow_next_limit
Maximum number of 'next' URLs to follow before stopping.'.[] | "\(.number)\t\(.title)"'
A jq filter to apply to the return data.GitHub querystring arguments may also be passed as keyword arguments: per_page, filter, state, labels, sort, direction, since
List all issues for a given organization for the authenticated user
Usage:
org_issues someorg
Positional arguments
$1
Organization GitHub login or id.Keyword arguments
_follow_next
Automatically look for a 'Links' header and follow any 'next' URLs._follow_next_limit
Maximum number of 'next' URLs to follow before stopping.'.[] | "\(.number)\t\(.title)"'
A jq filter to apply to the return data.GitHub querystring arguments may also be passed as keyword arguments: per_page, filter, state, labels, sort, direction, since