"https://cdn.gruntwork.io/gruntwork-website/"

{"index":{"js":"https://cdn.gruntwork.io/gruntwork-website/index.bundle.c7884255553b53fbca3a.js","map":"https://cdn.gruntwork.io/gruntwork-website/index.bundle.1b14c1b7d19f1f5eb35d6e118e838255.map"},"styles":{"css":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.f22938926651ddec7c49.css","js":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.e782420e74a20dcb8691.js","map":"https://cdn.gruntwork.io/gruntwork-website/styles.bundle.d5e2af49807c6ca33f8367d621ece507.map"},"vendors":{"css":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.29f7d0366a0978763f96.css","js":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.fa8174a130797d75d12c.js","map":"https://cdn.gruntwork.io/gruntwork-website/vendors.bundle.57243d94deeeb29d5061288a338b4eb6.map"}}

{"treedata":{"name":"root","toggled":true,"children":[{"name":".circleci","children":[{"name":"config.yml","path":".circleci/config.yml","sha":"353c39cfb0770e7d27e95532c904c7824f281723"}]},{"name":".github","children":[{"name":"ISSUE_TEMPLATE","children":[{"name":"bug_report.md","path":".github/ISSUE_TEMPLATE/bug_report.md","sha":"d2e87e27c601e423865ed660ec697082470ca60f"},{"name":"feature_request.md","path":".github/ISSUE_TEMPLATE/feature_request.md","sha":"023a33099be2336476930c96e17ff1ba5dc55348"}]},{"name":"pull_request_template.md","path":".github/pull_request_template.md","sha":"1ed18daca8d8613b91574ddd1641f2d129204f50"}]},{"name":".gitignore","path":".gitignore","sha":"d28c001bdfd57eaea4c2928479a5b934736abef6"},{"name":"CODEOWNERS","path":"CODEOWNERS","sha":"1897265fd0774ccd44065caf09212e1277ab37e6"},{"name":"LICENSE.txt","path":"LICENSE.txt","sha":"cebdd0f48f1e348fcba3134eb4ec79e4386ab2b5"},{"name":"README.md","path":"README.md","sha":"1bd14a701547dc41c6fdf1cd23d910180f22a91e","toggled":true},{"name":"checksum.go","path":"checksum.go","sha":"b8daa9fbc059c21205243f57f808a04dfb5a5203"},{"name":"checksum_test.go","path":"checksum_test.go","sha":"2c3d346f56a2c0cf6950a974d61c04f69b656c12"},{"name":"fetch_error.go","path":"fetch_error.go","sha":"df292be11d5b4b129bd4ae12a280ccc11e6bbbfb"},{"name":"fetch_error_constants.go","path":"fetch_error_constants.go","sha":"927df126c8f7a346c9add2272f13ba1f579a66e4"},{"name":"fetch_error_test.go","path":"fetch_error_test.go","sha":"4d2ca9c49c8c565a667aa1e25524d6b4d6418456"},{"name":"file.go","path":"file.go","sha":"7ecc89c7874e42823b279e4e5d4d9e21681e6d58"},{"name":"file_test.go","path":"file_test.go","sha":"efa95554395508bff681d928ed9f46689fee6357"},{"name":"github.go","path":"github.go","sha":"211975baf1341cb80246966ad3e35cbe4977540f"},{"name":"github_test.go","path":"github_test.go","sha":"dd825ffaca7e25327305768a51846b731957e129"},{"name":"go.mod","path":"go.mod","sha":"886fac315992cea665f6eb1d9f10ac897787d33a"},{"name":"go.sum","path":"go.sum","sha":"67e549d0e06053589652ca238acabb067b6bb717"},{"name":"integration_test.go","path":"integration_test.go","sha":"a7db35ae37418a1efd9fab7d663b47de5de7340c"},{"name":"logger.go","path":"logger.go","sha":"62df67dcddecb491f20b37953602e5ec7f85e322"},{"name":"main.go","path":"main.go","sha":"6065ebc95ebe065e1262be6feb5affb22f105e12"},{"name":"main_test.go","path":"main_test.go","sha":"50b742f2fd213837d5ec30653cd490d0ab95c232"},{"name":"tag.go","path":"tag.go","sha":"dffb8475bcf0960a1a9bc5d1e7abd149106dd5ac"},{"name":"tag_test.go","path":"tag_test.go","sha":"0bc9a595ea0ad9f354a85d14fe404846569f6169"},{"name":"test-fixtures","children":[{"name":"fetch-test-public-0.0.1.zip","path":"test-fixtures/fetch-test-public-0.0.1.zip","sha":"94285e70aa1d0fb7d9147990fe96e07233a4c9c3"},{"name":"fetch-test-public-0.0.2.zip","path":"test-fixtures/fetch-test-public-0.0.2.zip","sha":"1cf1bee7e3c648433d0709940e218c4d960927cc"},{"name":"fetch-test-public-0.0.3.zip","path":"test-fixtures/fetch-test-public-0.0.3.zip","sha":"6271b81066994c736acea0d71971acba744aeec8"},{"name":"fetch-test-public-0.0.4.zip","path":"test-fixtures/fetch-test-public-0.0.4.zip","sha":"8c2e78ad8d3990ed6e6c8696572684b46720072b"}]},{"name":"util.go","path":"util.go","sha":"9a515edb4e500da4793afffebb02356aaab1b03f"}]},"detailsContent":"<p><a href=\"https://gruntwork.io/?ref=repo_fetch\" class=\"preview__body--description--blue\" target=\"_blank\"><img src=\"https://img.shields.io/badge/maintained%20by-gruntwork.io-%235849a6.svg\" alt=\"Maintained by Gruntwork.io\" class=\"preview__body--diagram\"></a></p>\n<h1 class=\"preview__body--title\" id=\"fetch\">fetch</h1><div class=\"preview__body--border\"></div><p>fetch makes it easy to download files, folders, or release assets from a specific commit, branch, or tag of\na public or private GitHub repo.</p>\n<h4 id=\"motivation\">Motivation</h4>\n<p><a href=\"http://gruntwork.io\" class=\"preview__body--description--blue\" target=\"_blank\">Gruntwork</a> helps software teams get up and running on AWS with DevOps best practices and\nworld-class infrastructure in about a day. Sometimes we publish scripts and binaries that clients use in their\ninfrastructure, and we want an easy way to install a specific version of one of those scripts and binaries. While this\nis fairly straightforward to do with public GitHub repos, as you can usually <code>curl</code> or <code>wget</code> a public URL, it's much\ntrickier to do with private GitHub repos, as you have to make multiple API calls, parse JSON responses, and handle\nauthentication. Fetch makes it possible to handle all of these cases with a one-liner.</p>\n<h4 id=\"features\">Features</h4>\n<ul>\n<li>Download from any git reference, such as a specific git tag, branch, or commit SHA.</li>\n<li>Download a single file, a subset of files, or all files from the repo.</li>\n<li>Download one or more binary assets from a specific release that match a regular expression.</li>\n<li>Verify the SHA256 or SHA512 checksum of a binary asset.</li>\n<li>Download from public repos, or from private repos by specifying a <a href=\"https://help.github.com/articles/creating-an-access-token-for-command-line-use/\" class=\"preview__body--description--blue\" target=\"_blank\">GitHub Personal Access Token</a>.</li>\n<li>Download from GitHub Enterprise.</li>\n<li>When specifying a git tag, you can can specify either exactly the tag you want, or a <a href=\"#tag-constraint-expressions\" class=\"preview__body--description--blue\">Tag Constraint Expression</a> to do things like &quot;get the latest non-breaking version&quot; of this repo. Note that fetch assumes git tags are specified according to <a href=\"http://semver.org/\" class=\"preview__body--description--blue\" target=\"_blank\">Semantic Versioning</a> principles.</li>\n</ul>\n<h4 id=\"quick-examples\">Quick examples</h4>\n<p>Download folder <code>/baz</code> from tag <code>0.1.3</code> of a GitHub repo and save it to <code>/tmp/baz</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--tag=</span><span class=\"hljs-string\">\"0.1.3\"</span> <span class=\"hljs-params\">--source-path=</span><span class=\"hljs-string\">\"/baz\"</span> <span class=\"hljs-string\">/tmp/baz</span>\n</pre>\n<p>Download a release asset matching named <code>foo.exe</code> from release <code>0.1.5</code> and save them to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--tag=</span><span class=\"hljs-string\">\"0.1.5\"</span> <span class=\"hljs-params\">--release-asset=</span><span class=\"hljs-string\">\"foo.exe\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<p>Download all release assets matching the regular expression, <code>foo_linux-.*</code> from release <code>0.1.5</code> and save them to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--tag=</span><span class=\"hljs-string\">\"0.1.5\"</span> <span class=\"hljs-params\">--release-asset=</span><span class=\"hljs-string\">\"foo_linux-.*\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<p>See more examples in the <a href=\"#examples\" class=\"preview__body--description--blue\">Examples section</a>.</p>\n<h2 class=\"preview__body--subtitle\" id=\"installation\">Installation</h2>\n<h3 class=\"preview__body--subtitle\" id=\"download-from-releases-page\">Download from releases page</h3>\n<p>Download the fetch binary from the <a href=\"#open_modal\" class=\"preview__body--description--blue\">GitHub Releases</a> tab.</p>\n<h3 class=\"preview__body--subtitle\" id=\"install-via-package-manager\">Install via package manager</h3>\n<p>Note that package managers are third party. The third party fetch packages may not be updated with the latest version, but are often close. Please check your version against the latest available on the <a href=\"#open_modal\" class=\"preview__body--description--blue\">releases page</a>. If you want the latest version, the recommended installation option is to <a href=\"#open_modal\" class=\"preview__body--description--blue\">download from the releases page</a>.</p>\n<ul>\n<li>\n<p><strong>macOS:</strong> You can install fetch using <a href=\"https://brew.sh/\" class=\"preview__body--description--blue\" target=\"_blank\">Homebrew</a>: <code>brew install fetch</code>.</p>\n</li>\n<li>\n<p><strong>Linux:</strong> Most Linux users can use <a href=\"https://docs.brew.sh/Homebrew-on-Linux\" class=\"preview__body--description--blue\" target=\"_blank\">Homebrew</a>: <code>brew install fetch</code>.</p>\n</li>\n</ul>\n<h2 class=\"preview__body--subtitle\" id=\"usage\">Usage</h2>\n<h4 id=\"assumptions\">Assumptions</h4>\n<p>fetch assumes that a repo's tags are in the format <code>vX.Y.Z</code> or <code>X.Y.Z</code> to support Semantic Versioning parsing. This allows you to specify a <a href=\"#tag-constraint-expressions\" class=\"preview__body--description--blue\">Tag Constraint Expression</a> to do things like &quot;get the latest non-breaking version&quot; of this repo. Note that fetch also allows downloading a specific tag not in SemVer format.</p>\n<h4 id=\"general-usage\">General Usage</h4>\n<pre><span class=\"hljs-keyword\">fetch</span> [<span class=\"hljs-keyword\">OPTIONS</span>] &lt;<span class=\"hljs-keyword\">local</span>-download-<span class=\"hljs-type\">path</span>&gt;\n</pre>\n<p>The supported options are:</p>\n<ul>\n<li><code>--repo</code> (<strong>Required</strong>): The fully qualified URL of the GitHub repo to download from (e.g. https://github.com/foo/bar).</li>\n<li><code>--ref</code> (<strong>Optional</strong>): The git reference to download. If specified, will override <code>--commit</code>, <code>--branch</code>, and <code>--tag</code>.</li>\n<li><code>--tag</code> (<strong>Optional</strong>): The git tag to download. Can be a specific tag or a <a href=\"#tag-constraint-expressions\" class=\"preview__body--description--blue\">Tag Constraint\nExpression</a>.</li>\n<li><code>--branch</code> (<strong>Optional</strong>): The git branch from which to download; the latest commit in the branch will be used. If\nspecified, will override <code>--tag</code>.</li>\n<li><code>--commit</code> (<strong>Optional</strong>): The SHA of a git commit to download. If specified, will override <code>--branch</code> and <code>--tag</code>.</li>\n<li><code>--source-path</code> (<strong>Optional</strong>): The source path to download from the repo (e.g. <code>--source-path=/folder</code> will download\nthe <code>/folder</code> path and all files below it). By default, all files are downloaded from the repo unless <code>--source-path</code>\nor <code>--release-asset</code> is specified. This option can be specified more than once.</li>\n<li><code>--release-asset</code> (<strong>Optional</strong>): A regular expression matching release assets--these are binary files uploaded to a <a href=\"https://help.github.com/articles/creating-releases/\" class=\"preview__body--description--blue\" target=\"_blank\">GitHub\nRelease</a>--to download. It only works with the <code>--tag</code> option.</li>\n<li><code>--release-asset-checksum</code> (<strong>Optional</strong>): The checksum that a release asset should have. Fetch will fail if this value\nis non-empty and does not match the checksum computed by Fetch, or if more than 1 assets are matched by the release-asset\nregular expression.</li>\n<li><code>--release-asset-checksum-algo</code> (<strong>Optional</strong>): The algorithm fetch will use to compute a checksum of the release asset.\nSupported values are <code>sha256</code> and <code>sha512</code>.</li>\n<li><code>--github-oauth-token</code> (<strong>Optional</strong>): A <a href=\"https://help.github.com/articles/creating-an-access-token-for-command-line-use/\" class=\"preview__body--description--blue\" target=\"_blank\">GitHub Personal Access\nToken</a>. Required if you're\ndownloading from private GitHub repos. <strong>NOTE:</strong> fetch will also look for this token using the <code>GITHUB_OAUTH_TOKEN</code>\nenvironment variable, which we recommend using instead of the command line option to ensure the token doesn't get\nsaved in bash history.</li>\n<li><code>--github-api-version</code> (<strong>Optional</strong>): Used when fetching an artifact from a GitHub Enterprise instance.\nDefaults to <code>v3</code>. This is ignored when fetching from GitHub.com.</li>\n<li><code>--progress</code> (<strong>Optional</strong>): Used when fetching a big file and want to see progress on the fetch.</li>\n</ul>\n<p>The supported arguments are:</p>\n<ul>\n<li><code>&lt;local-download-path&gt;</code> (<strong>Required</strong>): The local path where all files should be downloaded (e.g. <code>/tmp</code>).</li>\n</ul>\n<p>Run <code>fetch --help</code> to see more information about the flags.</p>\n<h4 id=\"tag-constraint-expressions\">Tag Constraint Expressions</h4>\n<p>The value of <code>--tag</code> can be expressed using any operators defined in <a href=\"https://github.com/hashicorp/go-version\" class=\"preview__body--description--blue\" target=\"_blank\">hashicorp/go-version</a>.</p>\n<p>Specifically, this includes:</p>\n<table>\n<thead>\n<tr>\n<th>Tag Constraint Pattern</th>\n<th>Meaning</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>1.0.7</code></td>\n<td>Exactly version <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>=1.0.7</code></td>\n<td>Exactly version <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>!=1.0.7</code></td>\n<td>The latest version as long as that version is not <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>&gt;1.0.7</code></td>\n<td>The latest version greater than <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>&lt;1.0.7</code></td>\n<td>The latest version that's less than <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>&gt;=1.0.7</code></td>\n<td>The latest version greater than or equal to <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>&lt;=1.0.7</code></td>\n<td>The latest version that's less than or equal to <code>1.0.7</code></td>\n</tr>\n<tr>\n<td><code>~&gt;1.0.7</code></td>\n<td>The latest version that is greater than <code>1.0.7</code> and less than <code>1.1.0</code></td>\n</tr>\n<tr>\n<td><code>~&gt;1.0</code></td>\n<td>The latest version that is greater than <code>1.0</code> and less than <code>2.0</code></td>\n</tr>\n</tbody>\n</table>\n<h2 class=\"preview__body--subtitle\" id=\"examples\">Examples</h2>\n<h4 id=\"usage-example-1\">Usage Example 1</h4>\n<p>Download <code>/modules/foo/bar.sh</code> from a GitHub release where the tag is the latest version of <code>0.1.x</code> but at least <code>0.1.5</code>, and save it to <code>/tmp/bar</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--tag=</span><span class=\"hljs-string\">\"~&gt;0.1.5\"</span> <span class=\"hljs-params\">--source-path=</span><span class=\"hljs-string\">\"/modules/foo/bar.sh\"</span> <span class=\"hljs-string\">/tmp/bar</span>\n</pre>\n<h4 id=\"usage-example-2\">Usage Example 2</h4>\n<p>Download all files in <code>/modules/foo</code> from a GitHub release where the tag is exactly <code>0.1.5</code>, and save them to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--ref=</span><span class=\"hljs-string\">\"0.1.5\"</span> <span class=\"hljs-params\">--source-path=</span><span class=\"hljs-string\">\"/modules/foo\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<h4 id=\"usage-example-3\">Usage Example 3</h4>\n<p>Download all files from a private GitHub repo using the GitHUb oAuth Token <code>123</code>. Get the release whose tag is exactly <code>0.1.5</code>, and save the files to <code>/tmp</code>:</p>\n<pre><span class=\"hljs-attribute\">GITHUB_OAUTH_TOKEN</span>=123\n\nfetch <span class=\"hljs-attribute\">--repo</span>=<span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-attribute\">--ref</span>=<span class=\"hljs-string\">\"0.1.5\"</span> /tmp\n</pre>\n<h4 id=\"usage-example-4\">Usage Example 4</h4>\n<p>Download all files from the latest commit on the <code>sample-branch</code> branch, and save them to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--ref=</span><span class=\"hljs-string\">\"sample-branch\"</span> <span class=\"hljs-string\">/tmp/josh1</span>\n</pre>\n<h4 id=\"usage-example-5\">Usage Example 5</h4>\n<p>Download all files from the git commit <code>f32a08313e30f116a1f5617b8b68c11f1c1dbb61</code>, and save them to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--ref=</span><span class=\"hljs-string\">\"f32a08313e30f116a1f5617b8b68c11f1c1dbb61\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<h4 id=\"usage-example-6\">Usage Example 6</h4>\n<p>Download the release asset <code>foo.exe</code> from a GitHub release where the tag is exactly <code>0.1.5</code>, and save it to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://github.com/foo/bar\"</span> <span class=\"hljs-params\">--ref=</span><span class=\"hljs-string\">\"0.1.5\"</span> <span class=\"hljs-params\">--release-asset=</span><span class=\"hljs-string\">\"foo.exe\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<h4 id=\"usage-example-7\">Usage Example 7</h4>\n<p>Download the release asset <code>foo.exe</code> from a GitHub release hosted on a GitHub Enterprise instance running at <code>ghe.mycompany.com</code> where the tag is exactly <code>0.1.5</code>, and save it to <code>/tmp</code>:</p>\n<pre>fetch <span class=\"hljs-params\">--repo=</span><span class=\"hljs-string\">\"https://ghe.mycompany.com/foo/bar\"</span> <span class=\"hljs-params\">--ref=</span><span class=\"hljs-string\">\"0.1.5\"</span> <span class=\"hljs-params\">--release-asset=</span><span class=\"hljs-string\">\"foo.exe\"</span> <span class=\"hljs-string\">/tmp</span>\n</pre>\n<h5 id=\"release-instructions\">Release Instructions</h5>\n<p>To release a new version of <code>fetch</code>, go to the <a href=\"#open_modal\" class=\"preview__body--description--blue\">Releases page</a> and &quot;Draft a new release&quot;.\nOn the following page, bump the &quot;Tag version&quot; appropriately, and set the &quot;Release title&quot; to be the same.\nIn the &quot;Describe this release&quot; section, log the changes of this release, linking back to issues that were addressed.\nClick the &quot;Publish release&quot; button. CircleCI will pick this up, generate the assets, and attach them to the release.</p>\n<h2 class=\"preview__body--subtitle\" id=\"license\">License</h2>\n<p>This code is released under the MIT License. See <a href=\"/repos/v0.4.4/fetch/LICENSE.txt\" class=\"preview__body--description--blue\">LICENSE.txt</a>.</p>\n<h2 class=\"preview__body--subtitle\" id=\"todo\">TODO</h2>\n<ul>\n<li>Introduce code verification using something like GPG signatures or published checksums</li>\n<li>Explicitly test for exotic repo and org names</li>\n<li>Apply stricter parsing for repo-filter command-line arg</li>\n</ul>\n","repoName":"fetch","repoRef":"v0.4.6","serviceDescriptor":{"serviceName":"fetch","serviceRepoName":"fetch","serviceRepoOrg":"gruntwork-io","cloudProviders":["aws","gcp","azure"],"description":"","imageUrl":"grunt.png","licenseType":"unimplemented","technologies":[],"compliance":[],"tags":[""],"noDisplayInUI":true},"serviceCategoryName":"Terraform CI/CD","fileName":"README.md","filePath":"","title":"Repo Browser: fetch","description":"Browse the repos in the Gruntwork Infrastructure as Code Library."}