npm 加速

npm 镜像加速

把 npm 的 registry 指向本站,元数据与 tarball 都会通过本站代理下载。

● 兼容 npm / pnpm / yarn ● 支持 scoped 包 ● tarball 地址自动改写
加速入口

加速入口

点一下即可切换页面上的加速地址;延迟会按你的网络自动重测,带「推荐」的是对你最快的入口,页面示例默认就用它 查看详情 →

registry 地址

一行命令即可切换
registry(结尾的斜杠不要省略)
https://gh-proxy.cn/npm/

直接写入 ~/.npmrc(当前用户),不用下载脚本,一条命令完成切换:

切换镜像源
npm config set registry https://gh-proxy.cn/npm/

验证是否生效

查看当前 registry
npm config get registry

想换回官方源

还原
npm config delete registry

需要给所有用户设置时加 --global:npm config set registry https://gh-proxy.cn/npm/ --global; pnpm 读同一份配置,yarn 请见「手动配置」标签页。

脚本由官网统一保存,切换加速入口时会自动补上参数;脚本会写 ~/.npmrc,同时处理 yarn 的两种配置格式,并保留已有的 token 等配置:

默认:当前用户
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh" | sh

先预览会改什么

--dry-run
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh" | sh -s -- --dry-run

全局配置 / 还原 / 二进制镜像

常用参数
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh" | sudo sh -s -- --global   # 写入全局 npmrc
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh" | sh -s -- --restore         # 还原到执行前
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh" | sh -s -- --dist            # 同时指向 electron 等二进制镜像

写入 ~/.npmrc(pnpm 也读这个文件):

.npmrc
registry=https://gh-proxy.cn/npm/

或者用命令行写入

npm config
npm config set registry https://gh-proxy.cn/npm/
npm config get registry

yarn 2+ / yarn 1.x

yarn
# yarn 2+:写入 .yarnrc.yml
echo 'npmRegistryServer: "https://gh-proxy.cn/npm/"' >> ~/.yarnrc.yml
# yarn 1.x:写入 .yarnrc
yarn config set registry https://gh-proxy.cn/npm/

不改配置,只在本次安装时使用镜像:

单次安装
npm install --registry https://gh-proxy.cn/npm/ vue
pnpm add --registry https://gh-proxy.cn/npm/ vue

各加速服务器的换源脚本

共 2 条

脚本仍然从官网拉取,只是用 ?node= 把 registry 固定到某台服务器上; 新增服务器后这里会自动出现对应的命令。

官网 · https://gh-proxy.cn
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh?node=https://gh-proxy.cn" | sh
EdgeOne 加速 · https://eo.gh-proxy.cn
curl -fsSL "https://www.gh-proxy.cn/scripts/npm.sh?node=https://eo.gh-proxy.cn" | sh

接口对照

GET https://gh-proxy.cn/npm/<包名>
包元数据(版本、依赖)
GET https://gh-proxy.cn/npm/@scope%2f<包名>
scoped 包元数据
GET https://gh-proxy.cn/npm/<包名>/-/<文件>.tgz
tarball 下载
GET https://gh-proxy.cn/npm/-/v1/search
搜索接口

元数据里 dist.tarball 指向上游 registry 的地址会被改写成本站地址, 这样 npm ci、pnpm、yarn 的缓存都会走镜像。

自检

shell
curl -s https://gh-proxy.cn/npm/-/ping
npm config get registry
npm view vue version
npm pack vue --dry-run
← 返回软件源加速