{"id":13647351,"url":"https://github.com/mimecorg/launchui-packager","last_synced_at":"2025-04-12T15:30:59.307Z","repository":{"id":57289787,"uuid":"135565000","full_name":"mimecorg/launchui-packager","owner":"mimecorg","description":"Package applications using LaunchUI for Windows, Linux and OS X.","archived":false,"fork":false,"pushed_at":"2018-09-24T20:47:05.000Z","size":30,"stargazers_count":71,"open_issues_count":5,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-31T13:45:22.536Z","etag":null,"topics":["desktop","libui","node","packager"],"latest_commit_sha":null,"homepage":null,"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/mimecorg.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":null,"security":null,"support":null}},"created_at":"2018-05-31T09:50:31.000Z","updated_at":"2023-07-11T05:16:17.000Z","dependencies_parsed_at":"2022-09-20T07:50:33.244Z","dependency_job_id":null,"html_url":"https://github.com/mimecorg/launchui-packager","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimecorg%2Flaunchui-packager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimecorg%2Flaunchui-packager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimecorg%2Flaunchui-packager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mimecorg%2Flaunchui-packager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mimecorg","download_url":"https://codeload.github.com/mimecorg/launchui-packager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223527835,"owners_count":17160090,"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","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":["desktop","libui","node","packager"],"created_at":"2024-08-02T01:03:30.745Z","updated_at":"2024-11-07T14:01:45.283Z","avatar_url":"https://github.com/mimecorg.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Packaging"],"sub_categories":["Flexbox"],"readme":"# LaunchUI Packager\n\nPackage applications using [LaunchUI](https://github.com/mimecorg/launchui) for Windows, Linux and OS X.\n\n[![NPM module](https://img.shields.io/npm/v/launchui-packager.svg)](https://npmjs.org/package/launchui-packager)\n[![MIT License](https://img.shields.io/github/license/mimecorg/launchui-packager.svg)](https://github.com/mimecorg/launchui-packager/blob/master/LICENSE)\n\n## Introduction\n\nLaunchUI wraps Node.js with a small executable which automatically runs the application. No console window is opened and in case of a fatal error, it is reported using a message box.\n\nLaunchUI Packager provides a command line utility and an API for creating packages based on LaunchUI for Windows, Linux and OS X.\n\nYou can also use [LaunchUI Packager GUI](https://github.com/mimecorg/launchui-packager-gui), a desktop application which simplifies creating LaunchUI packages without using custom scripts.\n\n## Installation\n\nInstall LaunchUI Packager locally to use it in your build scripts:\n\n```bash\nnpm install --save-dev launchui-packager\n```\n\nInstall LaunchUI Packager globally to use it from command line:\n\n```bash\nnpm install --global launchui-packager\n```\n\n## Usage\n\nYou can run launchui-packager from the command line:\n\n```bash\nlaunchui-packager \u003cname\u003e \u003cversion\u003e \u003centry\u003e [options...]\n```\n\n### Arguments\n\nThe following arguments are required:\n\n#### `\u003cname\u003e`\n\nName of the application to package.\n\n#### `\u003cversion\u003e`\n\nVersion of the application to package.\n\n#### `\u003centry\u003e`\n\nPath of the entry script of the application. It will be copied to `app/main.js` inside the package.\n\n### Options\n\nIn addition, the following options can be specified:\n\n#### `--out \u003cpath\u003e`\n\nPath of the output directory where the package is created. The default value is the current directory.\n\n#### `--platform \u003cplatform\u003e`\n\nThe platform of the package. The default value is `process.platform`. The supported values are `win32`, `darwin` (OS X) and `linux`.\n\n#### `--arch \u003carch\u003e`\n\nThe architecture of the package. The default value is `process.arch`. The supported values are `x64` (on all platforms) and `ia32` (on win32/linux only).\n\n#### `--overwrite`\n\nWhen specified, the already existing package directory and/or ZIP file will be replaced. By default, existing files are not replaced.\n\n#### `--pack \u003cformat\u003e`\n\nWhen specified, the package directory is packed using the given format. Currently the only supported format is `zip`. By default, the package directory is not packed.\n\n#### `--launchui-version \u003cversion\u003e`\n\nVersion of the LaunchUI package to download. The default value is the currently installed version of the `launchui` NPM module.\n\n#### `--launchui-cache \u003cpath\u003e`\n\nPath of the LaunchUI cache location where packages are downloaded. The default location is `~/.launchui`.\n\n#### `--company \u003ccompany\u003e`\n\nThe company name. Maps to the `CompanyName` metadata property on Windows.\n\n#### `--copyright \u003ccopyright\u003e`\n\nThe copyright of the application. Maps to the `LegalCopyright` metadata property on Windows and `NSHumanReadableCopyright` on OS X.\n\n#### `--identifier \u003cidentifier\u003e`\n\nThe bundle identifier of the application. Maps to `CFBundleIdentifier` on OS X.\n\n#### `--category \u003ccategory\u003e`\n\nThe category type of the application. Maps to `LSApplicationCategoryType` on OS X.\n\n#### `--icon \u003cpath\u003e`\n\nPath of the application icon. It must be an `.ico` file on Windows and `.icns` on OS X.\n\n#### `--license \u003cpath\u003e`\n\nPath of the license file to include in the root directory of the package.\n\n#### `--dir \u003cpath\u003e`\n\nPath of the directory containing additional files to include in the `app` subdirectory of the package.\n\n#### `--files \u003cpattern,...\u003e`\n\nA pattern, or a comma separated list of patterns, which specifies the files to include, for example `*.js`. The default value is `**`, which means that the entire contents of `dir` is included in the package. Refer to the [Glob](https://github.com/isaacs/node-glob#glob) documentation for more information about supported patterns.\n\n### Output\n\nThe name of the package directory is `\u003cname\u003e-v\u003cversion\u003e-\u003cplatform\u003e-\u003carch\u003e`, for example `MyApp-v1.0.0-win32-ia32`. The name of the ZIP file is the same, with the `.zip` extension. The location of the generated packages can be changed using the `--out` option.\n\nThe LaunchUI executable is automatically renamed to the specified application name, for example `MyApp.exe` on Windows, `MyApp.app` on OS X and `MyApp` on Linux.\n\nOn Windows, the default resources embedded in the executable, including version information and icon, are replaced using [rcedit](https://github.com/electron/rcedit). On OS X, the package metadata stored in `Info.plist` are replaced.\n\n## API\n\nLaunchUI Packager provides a JavaScript API which can be used by custom build scripts.\n\n```js\nconst packager = require( 'launchui-packager' );\n\npackager( {\n  name: 'MyApp',\n  version: '1.0.0',\n  entry: './dist/main.js',\n  out: './packages'\n}, function ( err, outPath ) {\n  // outPath will be the path of the created package directory or file\n} );\n```\n\nThe `packager()` function supports the following options:\n\n### Required\n\n- `name`: name of the application\n- `version`: version of the application\n- `entry`: path of the entry script of the application\n\n### Optional\n\n- `out`: path of the output directory\n- `platform`: platform of the package\n- `arch`: architecture of the package\n- `overwrite`: if set to `true`, existing output will be replaced\n- `pack`: pack the output directory\n- `launchuiOpts`: additional options passed to `launchui.download()`, including `version` and `cache`\n- `company`: company name (win32)\n- `copyright`: copyright information (win32/darwin)\n- `identifier`: bundle identifier (darwin)\n- `category`: application category (darwin)\n- `icon`: path of the icon file (win32/darwin)\n- `license`: path of the license file\n- `dir`: path of the directory containing additional files\n- `files`: a pattern, or an array of patterns, which specify additional files to include in the package\n\nSee the command line usage above for more information.\n\n## License\n\nLaunchUI Packager is licensed under the MIT license\n\nCopyright (C) 2018 Michał Męciński\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmimecorg%2Flaunchui-packager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmimecorg%2Flaunchui-packager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmimecorg%2Flaunchui-packager/lists"}