├── .gitignore ├── .npmignore ├── example └── package.json ├── package.json ├── README.md ├── src └── index.js └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | node_modules 3 | bin 4 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .idea 2 | node_modules 3 | src 4 | -------------------------------------------------------------------------------- /example/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "app", 3 | "version": "0.0.1", 4 | "description": "Example App", 5 | "main": "index.js", 6 | "scripts": { 7 | "postinstall": "go-npm install", 8 | "preuninstall": "go-npm uninstall" 9 | }, 10 | "goBinary": { 11 | "name": "myBinaryName", 12 | "path": "./bin", 13 | "url": "https://github.com/user/myrepo/releases/download/v{{version}}/myBinaryName{{platform}}_{{arch}}.tar.gz" 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "go-npm", 3 | "version": "0.1.8", 4 | "description": "Distribute and install Go binaries via NPM", 5 | "main": "index.js", 6 | "bin": { 7 | "go-npm": "./bin/index.js" 8 | }, 9 | "scripts": { 10 | "test": "echo \"Error: no test specified\" && exit 1", 11 | "prepublish": "node_modules/babel-cli/bin/babel.js src --out-dir bin --presets es2015" 12 | }, 13 | "author": "Sanath Kumar Ramesh ", 14 | "license": "Apache-2.0", 15 | "dependencies": { 16 | "mkdirp": "^0.5.1", 17 | "request": "^2.81.0", 18 | "tar": "^2.2.1" 19 | }, 20 | "repository": { 21 | "type": "git", 22 | "url": "https://github.com/sanathkr/go-npm.git" 23 | }, 24 | "homepage": "https://github.com/sanathkr/go-npm", 25 | "devDependencies": { 26 | "babel-cli": "^6.24.1", 27 | "babel-core": "^6.25.0", 28 | "babel-preset-es2015": "^6.24.1" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Go NPM 2 | ### Distribute cross-platform Go binaries via NPM 3 | 4 | Applications written in Golang are portable - you can easily cross-compile binaries that work on Windows, Mac, and Linux. But how do you distribute the binaries to customers? When you publish new releases, how do they update the binary? 5 | 6 | **Use NPM to distribute cross-platform Go binaries** 7 | 8 | ## Kidding me! Why NPM? 9 | * **Cross-platform**: NPM is the only popular package manager that works cross-platform. 10 | * **Lower barier to entry**: Most developers have NPM installed already. 11 | * **Pain free publishing**: It just takes one command to publish - `npm publish` 12 | * **Dead simple install & update story**: `npm install/update -g your-awesome-app` 13 | * **Adds $PATH**: NPM will automatically add your binary location to $PATH and generate .cmd file for Windows. Your app just works after installation! 14 | 15 | ## Okay, tell me how? 16 | ### 1. Publish your binaries 17 | Setup your Go application to compile and publish binaries to a file server. This could be Github Releases or Amazon S3 or even Dropbox. All you need is a link. 18 | 19 | I like to use [GoReleaser](https://github.com/goreleaser/goreleaser) to setup by release process. You create a simple YAML configuration file like this and run `goreleaser` CLI to publish binaries for various platform/architecture combination to Github: 20 | 21 | ``` 22 | # .goreleaser.yml 23 | # Build customization 24 | builds: 25 | - binary: drum-roll 26 | goos: 27 | - windows 28 | - darwin 29 | - linux 30 | goarch: 31 | - amd64 32 | ``` 33 | 34 | `go-npm` will pull the appropriate binary for the platform & architecture where the package is being installed. 35 | 36 | ### 2. Create a package.json file for your NPM app 37 | To publish to NPM, you need to create a `package.json` file. You give your application a name, link to Readme, Github repository etc, and more importantly add `go-npm` as a dependency. You can create this file in an empty directory in your project or in a separate Git repository altogether. It is your choice. 38 | 39 | **Create package.json** 40 | 41 | `$ npm init` 42 | 43 | Answer the questions to create an initial package.json file 44 | 45 | **Add go-npm dependency** 46 | 47 | From the directory containing package.json file, do 48 | 49 | `$ npm install go-npm --save` 50 | 51 | This will install go-npm under to your package.json file. It will also create a `node_modules` directory where the `go-npm` package is downloaded. You don't need this directory since you are only going to publish the module and not consume it yourself. Let's go ahead and delete it. 52 | 53 | `$ rm -r node_modules` 54 | 55 | **Add postinstall and preuninstall scripts** 56 | Here is the magic: You ask to run `go-npm install` after it completes installing your package. This will pull down binaries from Github or Amazon S3 and install in NPM's `bin` directory. Binaries under bin directory are immediately available for use in your Terminal. 57 | 58 | Edit `package.json` file and add the following: 59 | ``` 60 | { 61 | "postinstall": "go-npm install", 62 | "preuninstall": "go-npm uninstall", 63 | } 64 | ``` 65 | 66 | `go-npm uninstall` simply deletes the binary from `bin` directory before NPM uninstalls your package. 67 | 68 | **Configure your binary path** 69 | 70 | You need to tell `go-npm` where to download the binaries from, and where to install them. Edit `package.json` file and add the following configuration. 71 | 72 | ``` 73 | "goBinary": { 74 | "name": "command-name", 75 | "path": "./bin", 76 | "url": "https://github.com/user/my-go-package/releases/download/v{{version}}/myGoPackage_{{version}}_{{platform}}_{{arch}}.tar.gz" 77 | ``` 78 | 79 | * *name*: Name of the command users will use to run your binary. 80 | * *path*: Temporary path where binaries will be downloaded to 81 | * *url*: HTTP Web server where binaries are hosted. 82 | 83 | Following variables are available to customize the URL: 84 | * `{{version}}`: Version number read from `package.json` file. When you publish your package to NPM, it will use this version number. Ex: 0.0.1 85 | * `{{platform}}`: `$GOOS` value for the platform 86 | * `{{arch}}`: `$GOARCH` value for the architecture 87 | 88 | If you use `goreleaser` to publish your modules, it will automatically set the right architecture & platform in your URL. 89 | 90 | **Publish to NPM** 91 | 92 | All that's left now is publish to NPM. As I promised before, just one command 93 | 94 | `$ npm publish` 95 | 96 | ### 3. Distribute to users 97 | 98 | To install: 99 | 100 | `npm install -g your-app-name` 101 | 102 | To Update: 103 | 104 | `npm update -g your-app-name` 105 | 106 | 107 | --- 108 | 109 | With ❤️ to the community by [Sanath Kumar Ramesh](http://twitter.com/sanathkr_) -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | "use strict" 4 | 5 | const request = require('request'), 6 | path = require('path'), 7 | tar = require('tar'), 8 | zlib = require('zlib'), 9 | mkdirp = require('mkdirp'), 10 | fs = require('fs'), 11 | exec = require('child_process').exec; 12 | 13 | // Mapping from Node's `process.arch` to Golang's `$GOARCH` 14 | const ARCH_MAPPING = { 15 | "ia32": "386", 16 | "x64": "amd64", 17 | "arm": "arm" 18 | }; 19 | 20 | // Mapping between Node's `process.platform` to Golang's 21 | const PLATFORM_MAPPING = { 22 | "darwin": "darwin", 23 | "linux": "linux", 24 | "win32": "windows", 25 | "freebsd": "freebsd" 26 | }; 27 | 28 | function getInstallationPath(callback) { 29 | 30 | // `npm bin` will output the path where binary files should be installed 31 | exec("npm bin", function(err, stdout, stderr) { 32 | 33 | let dir = null; 34 | if (err || stderr || !stdout || stdout.length === 0) { 35 | 36 | // We couldn't infer path from `npm bin`. Let's try to get it from 37 | // Environment variables set by NPM when it runs. 38 | // npm_config_prefix points to NPM's installation directory where `bin` folder is available 39 | // Ex: /Users/foo/.nvm/versions/node/v4.3.0 40 | let env = process.env; 41 | if (env && env.npm_config_prefix) { 42 | dir = path.join(env.npm_config_prefix, "bin"); 43 | } 44 | } else { 45 | dir = stdout.trim(); 46 | } 47 | 48 | mkdirp.sync(dir); 49 | 50 | callback(null, dir); 51 | }); 52 | 53 | } 54 | 55 | function verifyAndPlaceBinary(binName, binPath, callback) { 56 | if (!fs.existsSync(path.join(binPath, binName))) return callback(`Downloaded binary does not contain the binary specified in configuration - ${binName}`); 57 | 58 | getInstallationPath(function(err, installationPath) { 59 | if (err) return callback("Error getting binary installation path from `npm bin`"); 60 | 61 | // Move the binary file 62 | fs.renameSync(path.join(binPath, binName), path.join(installationPath, binName)); 63 | 64 | callback(null); 65 | }); 66 | } 67 | 68 | function validateConfiguration(packageJson) { 69 | 70 | if (!packageJson.version) { 71 | return "'version' property must be specified"; 72 | } 73 | 74 | if (!packageJson.goBinary || typeof(packageJson.goBinary) !== "object") { 75 | return "'goBinary' property must be defined and be an object"; 76 | } 77 | 78 | if (!packageJson.goBinary.name) { 79 | return "'name' property is necessary"; 80 | } 81 | 82 | if (!packageJson.goBinary.path) { 83 | return "'path' property is necessary"; 84 | } 85 | 86 | if (!packageJson.goBinary.url) { 87 | return "'url' property is required"; 88 | } 89 | 90 | // if (!packageJson.bin || typeof(packageJson.bin) !== "object") { 91 | // return "'bin' property of package.json must be defined and be an object"; 92 | // } 93 | } 94 | 95 | function parsePackageJson() { 96 | if (!(process.arch in ARCH_MAPPING)) { 97 | console.error("Installation is not supported for this architecture: " + process.arch); 98 | return; 99 | } 100 | 101 | if (!(process.platform in PLATFORM_MAPPING)) { 102 | console.error("Installation is not supported for this platform: " + process.platform); 103 | return 104 | } 105 | 106 | const packageJsonPath = path.join(".", "package.json"); 107 | if (!fs.existsSync(packageJsonPath)) { 108 | console.error("Unable to find package.json. " + 109 | "Please run this script at root of the package you want to be installed"); 110 | return 111 | } 112 | 113 | let packageJson = JSON.parse(fs.readFileSync(packageJsonPath)); 114 | let error = validateConfiguration(packageJson); 115 | if (error && error.length > 0) { 116 | console.error("Invalid package.json: " + error); 117 | return 118 | } 119 | 120 | // We have validated the config. It exists in all its glory 121 | let binName = packageJson.goBinary.name; 122 | let binPath = packageJson.goBinary.path; 123 | let url = packageJson.goBinary.url; 124 | let version = packageJson.version; 125 | if (version[0] === 'v') version = version.substr(1); // strip the 'v' if necessary v0.0.1 => 0.0.1 126 | 127 | // Binary name on Windows has .exe suffix 128 | if (process.platform === "win32") { 129 | binName += ".exe" 130 | } 131 | 132 | // Interpolate variables in URL, if necessary 133 | url = url.replace(/{{arch}}/g, ARCH_MAPPING[process.arch]); 134 | url = url.replace(/{{platform}}/g, PLATFORM_MAPPING[process.platform]); 135 | url = url.replace(/{{version}}/g, version); 136 | url = url.replace(/{{bin_name}}/g, binName); 137 | 138 | return { 139 | binName: binName, 140 | binPath: binPath, 141 | url: url, 142 | version: version 143 | } 144 | } 145 | 146 | /** 147 | * Reads the configuration from application's package.json, 148 | * validates properties, downloads the binary, untars, and stores at 149 | * ./bin in the package's root. NPM already has support to install binary files 150 | * specific locations when invoked with "npm install -g" 151 | * 152 | * See: https://docs.npmjs.com/files/package.json#bin 153 | */ 154 | const INVALID_INPUT = "Invalid inputs"; 155 | function install(callback) { 156 | 157 | let opts = parsePackageJson(); 158 | if (!opts) return callback(INVALID_INPUT); 159 | 160 | mkdirp.sync(opts.binPath); 161 | let ungz = zlib.createGunzip(); 162 | let untar = tar.Extract({path: opts.binPath}); 163 | 164 | ungz.on('error', callback); 165 | untar.on('error', callback); 166 | 167 | // First we will Un-GZip, then we will untar. So once untar is completed, 168 | // binary is downloaded into `binPath`. Verify the binary and call it good 169 | untar.on('end', verifyAndPlaceBinary.bind(null, opts.binName, opts.binPath, callback)); 170 | 171 | console.log("Downloading from URL: " + opts.url); 172 | let req = request({uri: opts.url}); 173 | req.on('error', callback.bind(null, "Error downloading from URL: " + opts.url)); 174 | req.on('response', function(res) { 175 | if (res.statusCode !== 200) return callback("Error downloading binary. HTTP Status Code: " + res.statusCode); 176 | 177 | req.pipe(ungz).pipe(untar); 178 | }); 179 | } 180 | 181 | function uninstall(callback) { 182 | 183 | let opts = parsePackageJson(); 184 | getInstallationPath(function(err, installationPath) { 185 | if (err) callback("Error finding binary installation directory"); 186 | 187 | try { 188 | fs.unlinkSync(path.join(installationPath, opts.binName)); 189 | } catch(ex) { 190 | // Ignore errors when deleting the file. 191 | } 192 | 193 | return callback(null); 194 | }); 195 | } 196 | 197 | 198 | // Parse command line arguments and call the right method 199 | let actions = { 200 | "install": install, 201 | "uninstall": uninstall 202 | }; 203 | 204 | let argv = process.argv; 205 | if (argv && argv.length > 2) { 206 | let cmd = process.argv[2]; 207 | if (!actions[cmd]) { 208 | console.log("Invalid command to go-npm. `install` and `uninstall` are the only supported commands"); 209 | process.exit(1); 210 | } 211 | 212 | actions[cmd](function(err) { 213 | if (err) { 214 | console.error(err); 215 | process.exit(1); 216 | } else { 217 | process.exit(0); 218 | } 219 | }); 220 | } 221 | 222 | 223 | 224 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------