{"id":13990644,"url":"https://github.com/plaid/npmserve","last_synced_at":"2025-07-22T13:30:41.580Z","repository":{"id":66141729,"uuid":"55811194","full_name":"plaid/npmserve","owner":"plaid","description":"fast npm installs for slow clients","archived":true,"fork":false,"pushed_at":"2016-04-27T23:16:27.000Z","size":10,"stargazers_count":36,"open_issues_count":5,"forks_count":2,"subscribers_count":18,"default_branch":"master","last_synced_at":"2024-09-21T09:52:56.210Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/plaid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-04-08T21:36:23.000Z","updated_at":"2023-01-28T17:41:58.000Z","dependencies_parsed_at":"2023-02-24T08:30:19.767Z","dependency_job_id":null,"html_url":"https://github.com/plaid/npmserve","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/plaid%2Fnpmserve","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plaid%2Fnpmserve/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plaid%2Fnpmserve/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plaid%2Fnpmserve/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plaid","download_url":"https://codeload.github.com/plaid/npmserve/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227098917,"owners_count":17730669,"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":[],"created_at":"2024-08-09T13:03:03.064Z","updated_at":"2024-11-29T10:31:15.346Z","avatar_url":"https://github.com/plaid.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# npmserve\n\n[![npm](https://img.shields.io/npm/v/npmserve.svg?maxAge=2592000)]()\n\nA replacement for `npm`, which allows clients to execute `npm install` on a remote server.\nThis allows slow clients to offload the work of building `node_modules` and perform significantly faster installs.\n\n## server\n\nThe client provided in this repository communicates with an [npmserve-server](https://github.com/plaid/npmserve-server).\n\n## disclaimer\n\n`npmserve` and `npmserve-server` are experimental projects. These tools should not be used for deploying production dependencies. The client/server model does not yet have authentication or authorization in place. This project also does not guarantee the integrity or security of dependencies installed from npm or distributed to clients. Please consider your own requirements and constraints before incorporating `npmserve` into your workflow.\n\n## implementation\n\nThe client/server model works by uploading the module's `package.json` contents.\nThe server creates a build hash from the package.json, which is used to\nstore, delete, and retrieve builds.\n\n## limitations\n\nCurrently, the server must be run on a machine with the same architecture as the clients. If this is not the case, calls to `/npm/install` may return `node_modules` archives that contain extensions compiled for the wrong architecture.\n\n## installation\n\n```\nnpm install -g npmserve\n```\n\nFor convenience, you might want to configure the `NPMSERVE_ORIGIN`\nenvironment variable in your `.profile` or `.bashrc`:\n\n```\nexport NPMSERVE_ORIGIN=\u003cyour_server_url\u003e\n```\n\nThis will allow you to execute the commands as shown below, without having to\nspecify the `NPMSERVE_ORIGIN` on each command.\n\n## usage\n\nThe commands consist of a list of commands analogous to actions a user takes\nwhen running standard `npm`:\n\n`npm install` is replaced by:\n```\nnpmserve install\n```\n\n`rm -rf node_modules/*` is replaced by:\n```\nnpmserve remove\n```\n\n`npm cache clean` is replaced by:\n```\nnpmserve cache clean\n```\n\nWe also provide a command to print out the build hash and other information.\nThis is useful for looking up your build in the [npmserve-server](https://github.com/plaid/npmserve-server) web interface.\n```\nnpmserve info\n```\n\n## environment\n\nThis project relies on the following environment variables:\n\n| name | type | default | description |\n| ---- | ---- | ------- | ----------- |\n| `NPMSERVE_ORIGIN` | string | | endpoint for the `npmserve-server` |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaid%2Fnpmserve","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaid%2Fnpmserve","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaid%2Fnpmserve/lists"}