{"id":20148373,"url":"https://github.com/nwutils/nwjs-packager","last_synced_at":"2025-09-07T01:36:38.005Z","repository":{"id":35043884,"uuid":"199841901","full_name":"nwutils/nwjs-packager","owner":"nwutils","description":"Build your NW.js app and generate archives, packages, setup files and more!","archived":false,"fork":false,"pushed_at":"2024-12-14T04:29:45.000Z","size":406,"stargazers_count":26,"open_issues_count":12,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-06T14:11:33.838Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/nwjs-packager","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nwutils.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-07-31T11:22:15.000Z","updated_at":"2025-07-12T11:53:17.000Z","dependencies_parsed_at":"2024-03-30T08:32:31.114Z","dependency_job_id":"988443bb-0c88-4a82-970e-d50e72527233","html_url":"https://github.com/nwutils/nwjs-packager","commit_stats":null,"previous_names":["charlielee/nwjs-packager"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/nwutils/nwjs-packager","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwutils%2Fnwjs-packager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwutils%2Fnwjs-packager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwutils%2Fnwjs-packager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwutils%2Fnwjs-packager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nwutils","download_url":"https://codeload.github.com/nwutils/nwjs-packager/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwutils%2Fnwjs-packager/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273986611,"owners_count":25202704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T22:37:24.825Z","updated_at":"2025-09-07T01:36:37.978Z","avatar_url":"https://github.com/nwutils.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e This repository is in maintainance mode. Bug fixes will be provided on a best effort basis. If you use this project, please consider contributing back.\n\n# nwjs-packager\n\nBuild your NW.js app and generate archives, packages, setup files and more! nwjs-packager focuses on making building NW.js \"just work\".\n\n## Key Features\n\n* Moves your app's files to a temporary directory and runs `npm install --production`\n* Option to quickly run your app without building for testing\n* Downloads NW.js binaries and combines them with your app's files\n* Generates `zip` or `tar.gz` archives and Windows installer executable files\n\n### macOS Features\n\n* Customises app icons\n* Properly customises Info.plist / InfoPlist.strings with your app's name\n* Adds correct product_string to package.json to allow binaries to be renamed\n\n### Windows Features\n\n* Customises executable icons and file properties\n* Generates an installer (using Inno Setup)\n\n### Linux Features\n\n* Generates a .desktop file for your app\n\n## Installation\n\n`npm install nwjs-packager --save-dev`\n\n## Usage\n\nAdd an `nwjs-packager` block to your app's package.json file.\n\n### Example package.json extract\n\n```jsonc\n  ...\n  \"nwjs-packager\": {\n    \"nwVersion\": \"0.45.4\",\n    \"appFriendlyName\": \"Demo App\",\n    \"appMacIcon\": \"bin/icon.icns\",\n    \"appWinIcon\": \"bin/icon.ico\",\n    \"files\": [\"bin/**\"],\n    \"builds\": {\n      \"linux\": {\"tar.gz\": true},\n      \"osx\": {\"zip\": true},\n      \"win\": {\"zip\": true}\n    }\n  }\n  ...\n```\n\n### Build mode\n\nTo build your app for the current platform and architecture simply run from a terminal window:\n\n```bash\nnwp\n```\n\n### Run mode\n\nTo quickly run your app in NW.js without building it (ie during development) run:\n\n```bash\nnwp -r\n```\n\n## Options\n\nAll options should added in your app's package.json file. Possible options with their default values are:\n\n```jsonc\n  ...\n  \"nwjs-packager\": {\n    // An array of files to include in the output packages. Globs are accepted.\n    \"files\": [],\n    // Location to store downloaded NW.js binaries\n    \"cacheDir\": \"(os.homedir)/.nwjs-packager/cache\",\n    // Location to store app files ready for packaging\n    \"tempDir\": \"(os.homedir)/.nwjs-packager/temp\",\n    // Location to output packages to\n    \"outputDir\": \"(your app's directory)/build\",\n\n    // The version of NW.js to use (note versions should be in format without the letter \"v\", eg: \"0.44.5\")\n    // The strings \"stable\", \"latest\" or \"lts\" are also permitted\n    \"nwVersion\": \"stable\",\n    // The \"flavor\" of NW.js to use (possible values \"normal\" or \"sdk\")\n    \"nwFlavor\": \"normal\",\n\n    // Whether to run `npm install production` after copying app files\n    \"runNpmInstallProduction\": true,\n\n    // The nerd name for the app to use in file names (ie there should be no spaces)\n    \"appPackageName\": \"(the 'name' value in your package.json)\",\n    // The version of the app\n    \"appVersion\": \"(the 'version' value in your package.json)\",\n    // The file name format of output packages. Can use the special symbols %a%, %v% %p%\n    // which are replaced with the appPackageName appName, appVersion and NW.js platform (eg osx-x64) respectively\n    \"appOutputName\": \"%a%-%v%-%p%\",\n    // The nice name of the app to display to the user (ie there can be spaces)\n    \"appFriendlyName\": \"(the 'name' value in your package.json, made titlecase and with '_' and '-' characters replaced with spaces)\",\n    // A path to a .icns file to use for generating the macOS icon\n    \"appMacIcon\": null,\n    // Unique, case sensitive bundle identifier in reverse-DNS format. Should be changed to prevent ID collisions\n    \"appMacBundleIdentifier\": \"io.nwjs.nwjs\",\n    // A path to an .ico file to use for generating the Windows icon\n    \"appWinIcon\": null,\n    // A short description of the app. Used in the macOS Info.plist and Windows fileVersion.\n    \"appDescription\": \"(the 'description' value in your package.json)\",\n    // The copyright detail of the app. Used in the macOS Info.plist and Windows fileVersion.\n    \"appCopyright\": \"(a string in the format '© {current_year} {package json 'author' value}')\",\n\n    // The platforms and outputs to build for\n    // Possibles values are \"deb\", \"rpm\", \"tar.gz\", \"zip\", \"pkg\", \"innoSetup\" depending on the platform\n    \"builds\": {\n      \"linux\": {\n        \"tar.gz\": true,\n        \"rpm\": true, // TODO coming soon!\n        \"deb\": true // TODO coming soon!\n      },\n      \"osx\": {\n        \"zip\": true,\n        \"pkg\": true // TODO coming soon!\n      },\n      \"win\": {\n        \"zip\": true,\n        \"innoSetup\": false // A path to a .iss file should be specified here\n      },\n    },\n\n    // macOS InfoPlist.strings files can be specified to use for different languages here\n    // Object keys should be in format \"locale_id\": \"/path/to/InfoPlist.strings/file\"\n    // Possible locale ids are listed here: https://gist.github.com/jacobbubu/1836273\n    \"infoPlistStrings\": {\n      // If locale file isn't specified, the strings in the file for the object key \"default\" will be used\n      // If a \"default\" file isn't specified, then nwjs-packager will automatically generate one\n      \"default\": null\n    }\n  }\n  ...\n```\n\n## Limitations\n\n* Installable packages have not been implemented for macOS or Linux yet\n* Currently you can only package a build for your current OS and architecture. (See #8)\n* Auto generation of Inno Setup .iss files has not been implemented yet\n* DO NOT add a `product_string` key to your package.json file. This will break nwjs-packager's \"run mode\" on macOS. nwjs-packager handles adding the a `product_string` during \"build mode\" only.\n\n## Example usage\n\n**[nwjs-packager-demo](https://github.com/charlielee/nwjs-packager-demo)** - a demo NW.js application used for testing.\n\n## License\n\n[MIT License](https://en.wikipedia.org/wiki/MIT_License). © 2020 Charlie Lee.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwutils%2Fnwjs-packager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnwutils%2Fnwjs-packager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwutils%2Fnwjs-packager/lists"}