{"id":16841635,"url":"https://github.com/kevinpollet/pika-plugin-pkg-node","last_synced_at":"2025-04-11T05:51:55.881Z","repository":{"id":48333007,"uuid":"190796506","full_name":"kevinpollet/pika-plugin-pkg-node","owner":"kevinpollet","description":"🐹 Pika plugin to package a Node.js app into an executable ","archived":false,"fork":false,"pushed_at":"2021-08-01T01:17:49.000Z","size":230,"stargazers_count":5,"open_issues_count":14,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-11T05:51:52.182Z","etag":null,"topics":["executable","native","nodejs","pika","pkg","plugin"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/kevinpollet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-07T19:14:14.000Z","updated_at":"2022-11-29T00:36:19.000Z","dependencies_parsed_at":"2022-09-18T23:03:07.133Z","dependency_job_id":null,"html_url":"https://github.com/kevinpollet/pika-plugin-pkg-node","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fpika-plugin-pkg-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fpika-plugin-pkg-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fpika-plugin-pkg-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinpollet%2Fpika-plugin-pkg-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinpollet","download_url":"https://codeload.github.com/kevinpollet/pika-plugin-pkg-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351410,"owners_count":21089271,"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":["executable","native","nodejs","pika","pkg","plugin"],"created_at":"2024-10-13T12:42:33.840Z","updated_at":"2025-04-11T05:51:55.861Z","avatar_url":"https://github.com/kevinpollet.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pika-plugin-pkg-node\n\n[![Build Status](https://github.com/kevinpollet/pika-plugin-pkg-node/workflows/build/badge.svg)](https://github.com/kevinpollet/pika-plugin-pkg-node/actions)\n[![GitHub](https://img.shields.io/github/license/kevinpollet/pika-plugin-pkg-node.svg?color=blue)](./LICENSE.md)\n\nA [@pika/pack](https://github.com/pikapkg/pack) build plugin. Package a Node.js app into an executable that can be run on devices without installing Node.js. This plugin use the awesome [@zeit/pkg](https://github.com/zeit/pkg) library under the hood.\n\n## Install\n\n```shell\nnpm install pika-plugin-pkg-node --save-dev  # npm\nyarn add pika-plugin-pkg-node --dev          # yarn\n```\n\n## Usage\n\n```js\n{\n  \"name\": \"example-package-json\",\n  \"version\": \"1.0.0\",\n  \"@pika/pack\": {\n    \"pipeline\": [\n      [\"@pika/plugin-standard-pkg\"],\n      [\"@pika/plugin-build-node\"],\n      [\"pika-plugin-pkg-node\", { /* options: see below */ } ]\n    ]\n  }\n}\n```\n\nFor more information about @pika/pack \u0026 help getting started, [check out the main project repo](https://github.com/pikapkg/pack).\n\n## Options\n\n### `assets`\n\n\u003e Default value: `[]`\n\nSpecify the assets packaged into the executable as raw content without modifications. The `assets` property is a list of globs, e.g. `[\"assets/**/*\"]`.\n\n### `debug`\n\n\u003e Defaults to `false`\n\nLog packaging process. Useful, if you have issues with some particular file not packaged into the executable.\n\n### `name`\n\n\u003e Defaults to the package name\n\nSpecify the name of the generated executable. For example, if the value of `name` property is `\"pika\"`, the following executables will be generated:\n\n- `pika-macos`\n- `pika-linux`\n- `pika-win.exe`\n\n### `outPath`\n\n\u003e Default value: `\"bin\"`\n\nSpecify the path, relative to the `pkg` folder, where the generated executables must be created.\n\n### `scripts`\n\n\u003e Default value: `[]`\n\nSpecify the scripts packaged into the executable without sources. Files specified as scripts will be compiled using `v8::ScriptCompiler`. The `scripts` property is a list of globs, e.g. `[\"scripts/**/*\"]`.\n\n### `targets`\n\n\u003e Default value: `[\"linux\",\"macos\",\"win\"]`\n\nA target consists of 3 elements, separated by dashes, for example `node6-macos-x64` or `node4-linux-armv6`:\n\n- `nodeRange`: node\\${n} or latest\n- `platform`: freebsd, linux, alpine, macos, win\n- `arch`: x64, x86, armv6, armv7\n\nYou may omit any element (and specify just node6 for example. The omitted elements will be taken from the current platform or system-wide Node.js installation (its version and arch). There is also an alias `host`, that means that all 3 elements are taken from the current platform/Node.js.\n\n## Examples\n\n- [hello-pika-cli](./examples/hello-pika-cli): Example of a CLI packaged as an executable\n\n## Contributing\n\nContributions are welcome!\n\nWant to file a bug, request a feature or contribute some code?\n\nCheck out the [contribution guidelines](./CONTRIBUTING.md).\n\n## License\n\n[MIT](./LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinpollet%2Fpika-plugin-pkg-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinpollet%2Fpika-plugin-pkg-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinpollet%2Fpika-plugin-pkg-node/lists"}