commit f99067fe59db4da005a41c592527650daa1fb25c Author: Seth House Date: Sun Apr 5 00:18:38 2015 -0600 Create gh-pages branch via GitHub diff --git a/images/bkg.png b/images/bkg.png new file mode 100644 index 0000000..d10e5ca Binary files /dev/null and b/images/bkg.png differ diff --git a/images/blacktocat.png b/images/blacktocat.png new file mode 100644 index 0000000..9759d77 Binary files /dev/null and b/images/blacktocat.png differ diff --git a/index.html b/index.html new file mode 100644 index 0000000..7279090 --- /dev/null +++ b/index.html @@ -0,0 +1,155 @@ + + + + + + + + + + + Octokit.sh by whiteinge + + + + +
+
+

Octokit.sh

+

A GitHub API client library focused on interfacing with shell scripts

+ +
+ Download as .zip + Download as .tar.gz + View on GitHub +
+
+
+ +
+
+

+A GitHub API client library written in POSIX sh

+ +

+Requirements

+ +
    +
  • A POSIX environment (tested against Busybox v1.19.4)
    • +
  • curl (tested against 7.32.0)
    • +
+ +

+Optional requirements

+ +
    +
  • jq http://stedolan.github.io/jq/ (tested against 1.3) +If jq is not installed commands will output raw JSON; if jq is installed +commands can be pretty-printed for use with other shell tools.
    • +
+ +

+Setup

+ +

Authentication credentials are read from a ~/.netrc file with the following +format. 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>
+
+ +

+Configuration

+ +

The following environment variables may be set to customize octokit.sh.

+ +
    +
  • OCTOKIT_SH_URL=https://api.github.com +Base URL for GitHub or GitHub Enterprise.
    • +
  • OCTOKIT_SH_ACCEPT=application/vnd.github.v3+json +The 'Accept' header to send with each request.
    • +
  • OCTOKIT_SH_JQ_BIN=jq +The name of the jq binary, if installed.
    • +
  • OCTOKIT_SH_VERBOSE=0 +The debug logging verbosity level. Same as the verbose flag.
    • +
  • OCTOKIT_SH_RATE_LIMIT=0 +Output current GitHub rate limit information to stderr.
    • +
  • OCTOKIT_SH_DESTRUCTIVE=0 +Allow destructive operations without prompting for confirmation.
    • +
+ +

+Usage

+ +

Usage: octokit.sh [<options>] (command [<name=value>...])

+ +

Full help output: octokit.sh help +Command-specific help: octokit.sh help command

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagDescription
-VShow version.
-hShow this screen.
-jOutput raw JSON; don't process with jq.
-qQuiet; don't print to stdout.
-rPrint current GitHub API rate limit to stderr.
-vLogging output; specify multiple times: info, debug, trace.
-xEnable xtrace debug logging.
-yAnswer 'yes' to any prompts.
+ +

+Available commands

+ +

help, show_scopes, org_repos, org_teams, list_repos, create_repo, delete_repo, +list_releases, release, create_release, delete_release, release_assets, +upload_asset

+
+
+ + + + + + \ No newline at end of file diff --git a/javascripts/main.js b/javascripts/main.js new file mode 100644 index 0000000..d8135d3 --- /dev/null +++ b/javascripts/main.js @@ -0,0 +1 @@ +console.log('This would be the main JS file.'); diff --git a/params.json b/params.json new file mode 100644 index 0000000..5acabc5 --- /dev/null +++ b/params.json @@ -0,0 +1 @@ +{"name":"Octokit.sh","tagline":"A GitHub API client library focused on interfacing with shell scripts","body":"# A GitHub API client library written in POSIX sh\r\n\r\n## Requirements\r\n\r\n* A POSIX environment (tested against Busybox v1.19.4)\r\n* curl (tested against 7.32.0)\r\n\r\n## Optional requirements\r\n\r\n* jq (tested against 1.3)\r\n If jq is not installed commands will output raw JSON; if jq is installed\r\n commands can be pretty-printed for use with other shell tools.\r\n\r\n## Setup\r\n\r\nAuthentication credentials are read from a ~/.netrc file with the following\r\nformat. Generate the token on GitHub under Account Settings -> Applications.\r\nRestrict permissions on that file with `chmod 600 ~/.netrc`!\r\n\r\n machine api.github.com\r\n login \r\n password \r\n\r\n## Configuration\r\n\r\nThe following environment variables may be set to customize octokit.sh.\r\n\r\n* OCTOKIT_SH_URL=https://api.github.com\r\n Base URL for GitHub or GitHub Enterprise.\r\n* OCTOKIT_SH_ACCEPT=application/vnd.github.v3+json\r\n The 'Accept' header to send with each request.\r\n* OCTOKIT_SH_JQ_BIN=jq\r\n The name of the jq binary, if installed.\r\n* OCTOKIT_SH_VERBOSE=0\r\n The debug logging verbosity level. Same as the verbose flag.\r\n* OCTOKIT_SH_RATE_LIMIT=0\r\n Output current GitHub rate limit information to stderr.\r\n* OCTOKIT_SH_DESTRUCTIVE=0\r\n Allow destructive operations without prompting for confirmation.\r\n\r\n## Usage\r\n\r\nUsage: `octokit.sh [] (command [...])`\r\n\r\nFull help output: `octokit.sh help`\r\nCommand-specific help: `octokit.sh help command`\r\n\r\nFlag | Description\r\n---- | -----------\r\n-V | Show version.\r\n-h | Show this screen.\r\n-j | Output raw JSON; don't process with jq.\r\n-q | Quiet; don't print to stdout.\r\n-r | Print current GitHub API rate limit to stderr.\r\n-v | Logging output; specify multiple times: info, debug, trace.\r\n-x | Enable xtrace debug logging.\r\n-y | Answer 'yes' to any prompts.\r\n\r\n## Available commands\r\n\r\nhelp, show_scopes, org_repos, org_teams, list_repos, create_repo, delete_repo, \r\nlist_releases, release, create_release, delete_release, release_assets, \r\nupload_asset","google":"UA-12716924-2","note":"Don't delete this file! It's used internally to help with page regeneration."} \ No newline at end of file diff --git a/stylesheets/pygment_trac.css b/stylesheets/pygment_trac.css new file mode 100644 index 0000000..d1df6a2 --- /dev/null +++ b/stylesheets/pygment_trac.css @@ -0,0 +1,68 @@ +.highlight .c { color: #999988; font-style: italic } /* Comment */ +.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ +.highlight .k { font-weight: bold } /* Keyword */ +.highlight .o { font-weight: bold } /* Operator */ +.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */ +.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ +.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #aa0000 } /* Generic.Error */ +.highlight .gh { color: #999999 } /* Generic.Heading */ +.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ +.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #555555 } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */ +.highlight .gt { color: #aa0000 } /* Generic.Traceback */ +.highlight .kc { font-weight: bold } /* Keyword.Constant */ +.highlight .kd { font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */ +.highlight .m { color: #009999 } /* Literal.Number */ +.highlight .s { color: #d14 } /* Literal.String */ +.highlight .na { color: #008080 } /* Name.Attribute */ +.highlight .nb { color: #0086B3 } /* Name.Builtin */ +.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */ +.highlight .no { color: #008080 } /* Name.Constant */ +.highlight .ni { color: #800080 } /* Name.Entity */ +.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */ +.highlight .nn { color: #555555 } /* Name.Namespace */ +.highlight .nt { color: #CBDFFF } /* Name.Tag */ +.highlight .nv { color: #008080 } /* Name.Variable */ +.highlight .ow { font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #009999 } /* Literal.Number.Float */ +.highlight .mh { color: #009999 } /* Literal.Number.Hex */ +.highlight .mi { color: #009999 } /* Literal.Number.Integer */ +.highlight .mo { color: #009999 } /* Literal.Number.Oct */ +.highlight .sb { color: #d14 } /* Literal.String.Backtick */ +.highlight .sc { color: #d14 } /* Literal.String.Char */ +.highlight .sd { color: #d14 } /* Literal.String.Doc */ +.highlight .s2 { color: #d14 } /* Literal.String.Double */ +.highlight .se { color: #d14 } /* Literal.String.Escape */ +.highlight .sh { color: #d14 } /* Literal.String.Heredoc */ +.highlight .si { color: #d14 } /* Literal.String.Interpol */ +.highlight .sx { color: #d14 } /* Literal.String.Other */ +.highlight .sr { color: #009926 } /* Literal.String.Regex */ +.highlight .s1 { color: #d14 } /* Literal.String.Single */ +.highlight .ss { color: #990073 } /* Literal.String.Symbol */ +.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #008080 } /* Name.Variable.Class */ +.highlight .vg { color: #008080 } /* Name.Variable.Global */ +.highlight .vi { color: #008080 } /* Name.Variable.Instance */ +.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */ + +.type-csharp .highlight .k { color: #0000FF } +.type-csharp .highlight .kt { color: #0000FF } +.type-csharp .highlight .nf { color: #000000; font-weight: normal } +.type-csharp .highlight .nc { color: #2B91AF } +.type-csharp .highlight .nn { color: #000000 } +.type-csharp .highlight .s { color: #A31515 } +.type-csharp .highlight .sc { color: #A31515 } diff --git a/stylesheets/stylesheet.css b/stylesheets/stylesheet.css new file mode 100644 index 0000000..a54a639 --- /dev/null +++ b/stylesheets/stylesheet.css @@ -0,0 +1,247 @@ +body { + margin: 0; + padding: 0; + background: #151515 url("../images/bkg.png") 0 0; + color: #eaeaea; + font: 16px; + line-height: 1.5; + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; +} + +/* General & 'Reset' Stuff */ + +.container { + width: 90%; + max-width: 600px; + margin: 0 auto; +} + +section { + display: block; + margin: 0 0 20px 0; +} + +h1, h2, h3, h4, h5, h6 { + margin: 0 0 20px; +} + +li { + line-height: 1.4 ; +} + +/* Header,
+ header - container + h1 - project name + h2 - project description +*/ + +header { + background: rgba(0, 0, 0, 0.1); + width: 100%; + border-bottom: 1px dashed #b5e853; + padding: 20px 0; + margin: 0 0 40px 0; +} + +header h1 { + font-size: 30px; + line-height: 1.5; + margin: 0 0 0 -40px; + font-weight: bold; + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; + color: #b5e853; + text-shadow: 0 1px 1px rgba(0, 0, 0, 0.1), + 0 0 5px rgba(181, 232, 83, 0.1), + 0 0 10px rgba(181, 232, 83, 0.1); + letter-spacing: -1px; + -webkit-font-smoothing: antialiased; +} + +header h1:before { + content: "./ "; + font-size: 24px; +} + +header h2 { + font-size: 18px; + font-weight: 300; + color: #666; +} + +#downloads .btn { + display: inline-block; + text-align: center; + margin: 0; +} + +/* Main Content +*/ + +#main_content { + width: 100%; + -webkit-font-smoothing: antialiased; +} +section img { + max-width: 100% +} + +h1, h2, h3, h4, h5, h6 { + font-weight: normal; + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; + color: #b5e853; + letter-spacing: -0.03em; + text-shadow: 0 1px 1px rgba(0, 0, 0, 0.1), + 0 0 5px rgba(181, 232, 83, 0.1), + 0 0 10px rgba(181, 232, 83, 0.1); +} + +#main_content h1 { + font-size: 30px; +} + +#main_content h2 { + font-size: 24px; +} + +#main_content h3 { + font-size: 18px; +} + +#main_content h4 { + font-size: 14px; +} + +#main_content h5 { + font-size: 12px; + text-transform: uppercase; + margin: 0 0 5px 0; +} + +#main_content h6 { + font-size: 12px; + text-transform: uppercase; + color: #999; + margin: 0 0 5px 0; +} + +dt { + font-style: italic; + font-weight: bold; +} + +ul li { + list-style: none; +} + +ul li:before { + content: ">>"; + font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal, monospace; + font-size: 13px; + color: #b5e853; + margin-left: -37px; + margin-right: 21px; + line-height: 16px; +} + +blockquote { + color: #aaa; + padding-left: 10px; + border-left: 1px dotted #666; +} + +pre { + background: rgba(0, 0, 0, 0.9); + border: 1px solid rgba(255, 255, 255, 0.15); + padding: 10px; + font-size: 14px; + color: #b5e853; + border-radius: 2px; + -moz-border-radius: 2px; + -webkit-border-radius: 2px; + text-wrap: normal; + overflow: auto; + overflow-y: hidden; +} + +table { + width: 100%; + margin: 0 0 20px 0; +} + +th { + text-align: left; + border-bottom: 1px dashed #b5e853; + padding: 5px 10px; +} + +td { + padding: 5px 10px; +} + +hr { + height: 0; + border: 0; + border-bottom: 1px dashed #b5e853; + color: #b5e853; +} + +/* Buttons +*/ + +.btn { + display: inline-block; + background: -webkit-linear-gradient(top, rgba(40, 40, 40, 0.3), rgba(35, 35, 35, 0.3) 50%, rgba(10, 10, 10, 0.3) 50%, rgba(0, 0, 0, 0.3)); + padding: 8px 18px; + border-radius: 50px; + border: 2px solid rgba(0, 0, 0, 0.7); + border-bottom: 2px solid rgba(0, 0, 0, 0.7); + border-top: 2px solid rgba(0, 0, 0, 1); + color: rgba(255, 255, 255, 0.8); + font-family: Helvetica, Arial, sans-serif; + font-weight: bold; + font-size: 13px; + text-decoration: none; + text-shadow: 0 -1px 0 rgba(0, 0, 0, 0.75); + box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.05); +} + +.btn:hover { + background: -webkit-linear-gradient(top, rgba(40, 40, 40, 0.6), rgba(35, 35, 35, 0.6) 50%, rgba(10, 10, 10, 0.8) 50%, rgba(0, 0, 0, 0.8)); +} + +.btn .icon { + display: inline-block; + width: 16px; + height: 16px; + margin: 1px 8px 0 0; + float: left; +} + +.btn-github .icon { + opacity: 0.6; + background: url("../images/blacktocat.png") 0 0 no-repeat; +} + +/* Links + a, a:hover, a:visited +*/ + +a { + color: #63c0f5; + text-shadow: 0 0 5px rgba(104, 182, 255, 0.5); +} + +/* Clearfix */ + +.cf:before, .cf:after { + content:""; + display:table; +} + +.cf:after { + clear:both; +} + +.cf { + zoom:1; +} \ No newline at end of file