NPM 中文文檔

關於本文檔

這是一套關於 NPM 命令行和使用的文檔介紹，屬於 API 文檔級別的；

這篇文章是整個 API 文章的目錄索引；下面表格內有對應的命令說明

比官方的文檔更加接地氣，不少命令，都在命令行裏敲一遍，截圖讓讀者直觀的看到；對於中文習慣的開發者來講，很是友好；

若是見到不合適的地方，歡迎告訴我；

這裏介紹 npm 的配置，文件內都是作什麼用的，以及全部的 CLI 命令；

相信您看完之後，會有一個更加深入的理解；

若是您想看 NPM 的教程，請參考本站的 NPM 教程；

杜絕純機器翻譯，本文檔內容都是逐行檢查過，而且命令都試驗過才寫出來的；

有不少地方官方文檔寫的比較簡潔，我根據實際使用的狀況有作添加和修改；

文檔的目錄

NPM 配置

項目	說明
./node_modules	npm 包存放的文件夾
.npmrc	npm 配置文件
package-lock.json	列表的展現
package-locks	npm 鎖定文件的說明
package.json	npm 的 package
shrinkwrap.json	可發佈的鎖定文件

CLI 命令

A

項目	說明
npm access	設置已發佈軟件包的訪問級別
npm adduser	添加註冊表用戶賬戶
npm audit	運行安全審覈

B

項目	說明
npm bin	顯示 npm bin 文件夾
npm bugs	網絡瀏覽器中程序包的錯誤
npm build	創建一個包
npm bundle	REMOVED

C

項目	說明
npm cache	處理軟件包緩存
npm ci	使用乾淨的面板安裝項目
npm completion	npm 的製表符完成
npm config	管理 npm 配置文件

D

項目	說明
npm dedupe	減小重複
npm deprecate	棄用軟件包的版本
npm dist-tag	修改包分發標籤
npm docs	在網絡瀏覽器中獲取軟件包的文檔
npm doctor	檢查您的環境

E

項目	說明
npm edit	編輯已安裝的軟件包
npm explore	瀏覽已安裝的軟件包

H

項目	說明
npm help-search	搜索 NPM 幫助文檔
npm help	在 npm 上獲取幫助
npm hook	管理註冊表掛鉤

I

項目	說明
npm init	建立一個 package.json 文件
npm install-ci-test	使用乾淨的面板安裝項目並運行測試
npm install-test	安裝軟件包並運行測試
npm install	安裝套件

L

項目	說明
npm link	符號連接包文件夾
npm logout	註銷註冊表
npm ls	列出已安裝的軟件包

N

項目	說明
npm	包管理器

O

項目	說明
npm org	管理組織
npm outdated	檢查過期的包
npm owner	管理軟件包全部者

P

項目	說明
npm pack	從包中建立一個 tarball
npm ping	Ping NPM 註冊表
npm prefix	顯示前綴
npm profile	更改註冊表配置文件中的設置
npm prune	刪除無關的軟件包
npm publish	發佈包

R

項目	說明
npm rebuild	重建套件
npm repo	在瀏覽器中打開軟件包存儲庫頁面
npm restart	從新啓動程序包
npm root	顯示 npm 根目錄
npm run-script	運行任意包腳本

S

項目	說明
npm search	搜索包
npm shrinkwrap	鎖定要發佈的依賴版本
npm star	標記您喜歡的包
npm stars	查看標記爲收藏的軟件包
npm start	開始打包
npm stop	中止包

T

項目	說明
npm team.html)	管理組織團隊和團隊成員
npm test	測試包
npm token	管理您的身份驗證令牌

U

項目	說明
npm uninstall	卸載包
npm unpublish	從註冊表中刪除軟件包
npm update	更新包

V

項目	說明
npm version	查看版本
npm view	查看註冊表信息

W

項目	說明
npm whoami	顯示 npm 用戶名

NPM 使用

項目	說明
coding-style	npm 推薦的編碼風格
config	NPM config 的詳細解讀
developers	NPM 包/模塊開發的注意事項
disputes	處理模塊名稱爭議
orgs	npm 團隊和組織管理的詳細
registry	JavaScript 包註冊表
scope	範圍包
scripts	npm 如何處理 "scripts " 字段
removal	Cleaning the Slate
semver	npm 的語義版本控制程序

關於 NPM

npm 是世界上最大的軟件註冊表。來自各大洲的開源開發人員使用 npm 共享和借用軟件包，許多組織也使用 npm 管理私人開發。

更新記錄

• 2019 年 9 月 23 日開始寫NPM中文API文檔

本文參考NPM中文文檔