npm 命令行篇

access

设置发布软件包的级别

• 命令

  npm access public  [<package>]
  npm access restricted [<package>]
  
  npm access grant <read-only|read-write> <scope:team> [<package>]
  npm access revoke <scope:team> [<package>]
  
  npm access 2fa-required [<package>]
  npm access 2fa-not-required [<package>]
  
  npm access ls-packages [<user>|<scope>|<scope:team>]
  npm access ls-collaborators [<package>[<user>]]
  npm access edit [<package>]
  

• 详情
  • puplic/restricted:将程序包设置为可公开访问或受限
  • grant/revoke：添加或删除用户和团队对程序包具有只读或读写权限的功能
  • 2fa-required/2fa-not-required：配置程序包是否要求发布该程序包的任何人都对其帐号启动双重身份验证
  • ls-packages：显示用户或团队可以访问的所有软件包以及访问级别，只读公共软件包除外
  • ls-collaborators：显示软件包的所有访问权限。仅显示至少具有读取权限的软件包的权限。如果user 传入，列表过滤出只属于用户的
  • edit：使用一次设置软件包的 访问权限
• 细节
  • 只用 --registry=<registry url> 配置始终在当前注册表上运行

adduser

• 概要
  • npm adduser [–registry=url] [–scope=@orgname] [–always-auth] [–auth-type=legacy]
• 详情
  • 创建或验证<username>在指定注册表中命名的用户，然后将凭据保存到.npmrc文件中。未指定注册表使用默认
• 配置
  • registry：默认值https：//registry.npmjs.org/，npm注册表的基本URL
  • scope：默认值无，如果指定，指定的用户和登陆凭据将于指定的scope关联
  • always-auth:默认值false。如果指定，保存配置，该配置对给定注册表的所有请求都应包括授权信息
  • auth-type: 默认：legacy。类型：legacy、sso、saml、oauth。使用哪种身份验证login

aduit

• 概要

npm aduit [--json|--parseable]
npm aduit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]

• 例子
  • 扫描项目中的漏洞，并自动安装任何兼容更新到易受攻击的依赖项

  npm aduit fix
  

  • 运行时audit无需修改node_module,但仍会更新pkglock

  npm aduit fix --package-lock-only
  

  • 跳过更新devDependdencies

  npm aduit fix --only=prod
  

  • 已经安装了semver-major更新到顶级依赖项，而不仅仅是与semver兼容的依赖项

  npm aduit fix --force
  

  • 做一个aduit fix将要做什么的预演。输出json格式信息

  npm aduit fix --dry-run --json
  

  • 扫描项目中的漏洞，仅显示详细信息，而无需修复任何问题

  npm aduit 
  

  • 获取JSON格式的详细审核报告

  npm aduit fix --json
  

  • 以纯文本获取审计报告的详细结果，以制表符分割，以便将来在脚本或命令中后续处理中重用

  npm aduit fix --parseable
  

  • 要解析列，可以使用例如awk

  npm aduit fix --parseable | awk -F $'\t' '{print $1,$4}'
  

  • 描述
    • 对项目中配置的依赖项的描述提交给默认注册表，并要求提供已知漏洞的报告

bin

npm bin [-g|--global] 

列出npm安装可执行文件的文件夹

bugs

• 概要

  npm bugs [\<pkgName>]
  

• 详情
  • 尝试去猜测一个包的跟踪URL的错误的可能位置
• 配置
  • browser：默认值OSX:“open”,windows:“start”,其他:“xdg-open”,命令浏览器打开网站
  • registry：注册表的URL地址

build

• 概要

  npm build [\<package-floder>]
  

• 详情
  • 由 npm link 和 npm install命令组成的管道命令。通常在安装过程中被调用，直接运行命令： npm run-script build
• 配置
  • <package-floder>:在其根目录中包含一个package.json文件的文件夹

cache

• 概要

  npm cache add <tarball file>
  npm cache add <folder>
  npm cache add <tarball url>
  npm cache add <name>@<version>
  
  npm cache clean [<path>]
  aliases: npm cache clear,npm cache rm
  
  npm cache verify
  

• 详情
  • 用于添加、列出或清理缓存文件夹
  • 将缓存数据存储在已配置的cache名为_cacache的不透明目录中
• 配置
  • add:将指定文件夹添加到本地缓存中
  • clean：从缓存文件夹中删除所有数据
  • verify：验证缓存文件夹的内容，对所有不需要的数据进行垃圾回收，并验证缓存索引和所有缓存数据的完整性

ci

• 概要

  npm ci
  

• 描述
  • 该命令与npm install相似，它用于自动化环境(例如测试平台、持续集成和部署)或者在任何情况下都要确保干净安装依赖项
• 与 npm install区别
  • 项目必须有package-lock.json或npm-shrinkwrap.json
  • 如果程序包锁中的依赖项与package.json不匹配，npm ci则将退出并显示错误，而不是更新程序包锁
  • npm ci 一次只能安装整个项目：不能使用此命令添加单个依赖项
  • 如果node_modules已经存在,npm ci安装之前会自动删除
  • 永远不会写入package.json或执行任何软件包锁：安装实际上是冻结的

completion

• 概要

  source <(npm completion)
  

• 描述
  • 在所有npm命令中启用制表符补全

config

• 概要

  npm config set <key> <value> [-g|--global]
  npm config get <key>
  npm config -delete <key>
  npm config list [-l] [--json]
  npm config edit
  npm get <key>
  npm set <key> <value> [-g|--global]
  
  aliases:c
  

• 描述
  • 从命令行、环境变量、npmrc文件以及某些情况下(packaeg.json)获取其配置
  • 更新编辑用户和全局npmrc文件的内容
• 子命令
  • set：设置配置
  • get:得到配置信息
  • list:显示所有配置
  • delete：从所有配置中删除密钥
  • edit：在编辑器中打开配置文件

dedupe

• 概要

  npm dedupe
  npm ddp
  
  aliases:find-depes,ddp
  

• 描述
  • 搜索本地软件包树，并尝试通过将依赖关系进一步移到树上来简化整体结构，在此树中，多个依赖软件包可以更有效地共享它们。
  • 注意：转换依赖关系树，并不会安装新模块

deprecate

• 概要

  npm deprecate <pck>[@<version>] <message>
  

• 描述
  • 提示版本作废信息
  • 必须是包的所有者，取消作废，message设为“”

dist-tag

• 概要

  npm dist-tag add <pkg>@<version> [<tag>]
  npm dist-tag rm <pkg> <tag>
  npm dist-tag ls [<pkg>]
  
  aliases:dist-tags
  

• 描述
  • 添加、删除和枚举包装上的分发标签
  • 设置别名而不是版本号
• 配置
  • add:添加标记tag
  • rm：移除标记tag
  • ls：显示所有dist标签

docs

• 概要

  npm docs [<pkgname>[<pkgname>...]]
  npm docs .
  npm home [<pkgname>[<pkgname>...]]
  npm hoem .
  

• 描述
  • 猜测软件包文档URL的可能位置，尝试使用–browser config参数将其打开
• 配置
  • browser：浏览器
  • registry：注册表

doctor

• 概要

  npm doctor
  

• 描述
  • 运行一组检查以确保您的npm安装具有管理javascript软件包所需的内容
• npm 基本要求
  • Node.js和git必须由npm执行
  • 可以使用主要的npm注册表registry.npmjs.com或使用注册表API的其他服务
  • npm 使用的目录node_modules都存在，并且可以由当前用户写入
  • npm缓存存在，并且其中的程序包tarball没有损坏

edit

• 概要

  npm edit <pkg>[<subpkg>...]
  

• 描述
  • 在默认编辑器中打开任何文件

explore

• 概要

  npm explore <pkg>[-- <command>]
  

• 描述
  • 在指定的已安装软件包的目录中生成一个子shell，指定命令，在子shell中执行，然后子shell立即终止
• 配置
  • shell:默认值：shell环境变量

help

• 概要

  npm help <term>[<terms..>]
  

• 描述
  • 提供了主题，显示相应的文档页面

help-search

• 概要

  npm help-search <text>
  

• 描述
  • 在npm markdown文档文件中搜索提供的术语，然后列出结果，并按相关性排序
• 配置
  • long:默认值false，true输出术语周围的上下文

hook

• 概要

  npm hook ls [pkg]
  npm hook add <entity> <url> <secret>
  npm hook update <id> <url> [secret]
  npm hook rm <id>
  

• 描述
  • 管理npm 挂钩，包括添加、删除、列出和更新

init

• 概要

  npm init [--force|-f|--yes|-y|--scope]
  npm init <@scope>(same as 'npx <@scope>/create')
  npm init [<@scope>]<name> (same as 'npx [<@scope>]create-<name>')
  

• 描述
  • 设置新的或现有得npm软件包
  • -y|-yes 跳过问卷直接创建

install

• 概要

  npm install (with no args,in package dir)
  npm install [<@scope>]<name>
  npm install [<@scope>]<name>@<tag>
  npm install [<@scope>]<name>@<version>
  npm install [<@scope>]<name>@<version range>
  npm install <git-host>:<git-user>/<repo-name>
  npm install <git repo url>
  npm install <tarball file>
  npm install <tarball url>
  npm install <folder>
  
  alias:npm i
  common options:[-P|--save-prod|-D|--save-dev|-O|--save-option1] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]
  

• 描述
  • 安装软件包及其依赖得任何软件包

配置

- npm install 没有参数
    - 将依赖项安装在本地node_modules文件夹中
    - -g|--global：安装为全局程序包
    - --production：不会安装devDependencies里面得依赖包
- npm install <floder>
    - 将软件包作为当前项目中得符号链接安装在目录中。
- npm install <tarball file>
    - 安装位于文件系统上得软件包
- npm install <tarball url>
    - 提取tarball，安装
- npm install [<@scope>]<name>
    - 通过<name>@<tag>安装
    - -P|--save-prod:默认配置，除非—D|-O存在，出现在dependencies
    - -D|--save-dev:出现在devDenpendencies
    - -O|--save-optional：出现在optionalDependencies
    - --no-save：防止保存在dependencies
    - -E|--save-exact：使用确切得版本配置，而不是使用默认得semver range运算符
    - -B|--save-bundle:保存在bundleDependencies
- npm install [<@scope>]<name>@<tag>
   - 安装标签应用得指定版本程序包
- npm install [<@scope>]<name>@<version>
    - 安装指定版本软件包
- npm install [<@scope>/]<name>@<version range>
    - 安装与指定版本范围匹配得软件包版本
- npm install <git remote url>
    - 从托管得git提供程序安装软件包，并克隆该软件包
    - git有环境变量可别npm识别
- npm install <githubname>/<githubrepo>[#<commit-ish>]
- npm install github:<githubname>/<githubrepo>[#<commit-ish>]
- npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>] 
- npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]
- npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]
    - --tag:指定标签，安装对应版本
    - --dry-run:以通常得方式报告在没有实际安装任何内容得情况下安装将要完成得操作
    - --package-lock-only:只会更新package-lock.json
    - -f|--force：强制获取远程资源
    - -g|--global:全局安装包
    - --ingnore-scripts:不执行package.json中定义得任何脚本
    - --legacy-bundling：消除所有自动重复数据删除
    - --link：将全局安装链接到本地空间
    - --no-bin-links:阻止npm为软件包可能包含得任何二进制文件创建符号链接
    - --no-optional：防止安装可选依赖项
    - --no-shrinkwarp:忽略可用的程序包锁定或收缩包安装文件，改用package.json
    - --no-package-lock：阻止npm创建package-lock.json。
    - --node-dir=/path/to/node/source:允许npm查找节点源代码
    - --only=[prod[ution]|dev[elopment]]:仅安装devDenpendencies或仅非devDependencies安装NODE_DEV
    - --no-aduit:禁用将审核报告发送到已配置得注册表

install-cli-test

• 概要

     npm install-cli-test
   
     alias:npm cit
     ```
  

• 描述
  • 命令npm cli后面跟一个 npm test

install-test

• 概要

  npm install-test (with no args,in package dir)
  npm install-test [<@scope>]<name>           
  npm install-test [<@scope>/]<name>@<tag>
  npm install-test [<@scope>/]<name>@<version>
  npm install-test [<@scope>/]<name>@<version range>
  npm install-test <tarball file>
  npm install-test <tarball url>
  npm install-test <folder>
  
  alias:npm it
  

• 描述
  • 首先运行install命令，然后运行npm test命令，参数与install参数完全相同

link

• 概要

  npm link (in package dir)
   npm link [<@scope>]<pkg>[@<version>]
  
  alias:npm ln
  

• 描述
  • 将全局文件夹链接到执行命令得包

logout

• 概要

  npm logout [--registry=<url>] [--scope=<@scope>]
  

• 描述
  • 结束令牌得会话，清除用户配置的凭据

ls

• 概要

  npm ls [[@scope]<pkg>...]
  aliases:list\la\ll
  

• 描述
  • 将已安装得软件包得所有版本及其依赖项打印到标准输出
• 配置
  • json：以json格式显示信息
  • long：显示扩展信息
  • parseable：显示可解析得输出而不是树状图
  • global：在全局安装中而不是在当前项目中列出软件包
  • depth：依赖关系树得最大显示深度
  • prd/production：仅显示dependencies中得关系依赖树
  • dev/development：仅显示devpendencies中得关系树
  • only：当dev或development，是dev得别名，当prod或production，是prod得别名
  • link：显示连接得依赖项

org

• 概要

  npm org set <orgname> <username> [developer | admin | owner]
  npm org rm <orgname> <username>
  npm org ls <orgname> [<username>]
  

• 描述
  • 管理和查看组织用户

outdated

• 概要

  npm outdated [[<@scope>/]<pkg> ...]
  

• 描述
  • 检查注册表以查看当前是否已安装任何（或特定的）已安装软件包

owner

• 概要

  npm owner add <user> [<@scope>/]<pkg>
  npm owner rm <user> [<@scope>/]<pkg>
  npm owner ls [<@scope>/]<pkg>
  
  aliases: author
  

• 描述
  • 管理已发布软件包的所有权。

pack

• 概要

  npm pack [[<@scope>/]<pkg>...] [--dry-run]
  

• 描述
  • 对于任何可安装的内容（即，程序包文件夹，tarball，tarball url，name @ tag，name @ version，名称或作用域名称），此命令会将其提取到缓存中，然后将tarball复制到当前的工作环境中目录为-.tgz，然后将文件名写出到stdout。

ping

• 概要

  npm ping [--registry <registry>]
  

• 描述
  • Ping 已配置的或给定的 npm 注册表地址并进行身份验证。

prefix

• 概要

  npm prefix [-g]
  

• 描述
  • 打印本地目录前缀。

profile

• 概要

  npm profile get [--json|--parseable] [<property>]
  npm profile set [--json|--parseable] <property> <value>
  npm profile set password
  npm profile enable-2fa [auth-and-writes|auth-only]
  npm profile disable-2fa
  

• 描述
  • 在注册表上更改您的配置文件信息

prune

• 概要

  npm prune [[<@scope>/]<pkg>...] [--production] [--dry-run] [--json]
  

• 描述
  • 此命令移除“无关”的包。如果提供了包名，那么只有名称匹配的那个包才会被移除。

publish

• 概要

  npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]
  
  Publishes '.' if no argument supplied
  Sets tag 'latest' if no --tag specified
  

• 描述
  • 将程序包发布到注册表，以便按名称安装

rebuild

• 概要

  npm rebuild [[<@scope>/<name>]...]
  
  alias: npm rb
  

• 描述
  • 使用新的二进制文件重新编译所有 C++ 插件

repo

• 概要

  npm repo [<pkg>]
  

• 描述
  • 尝试猜测指定包的源码仓库的 URL ，然后再使用 --browser 配置参数打开它

restart

• 概要

  npm restart [-- <args>]
  

• 描述
  • 重新启动程序包
  • 重新启动顺序： prestart>prestop>stop>poststop>restart>prestart>start>poststart>postrestart

root

• 概要

  npm root [-g]
  

• 描述
  • 在标准输出上将有效的 node_modules 文件夹打印出来。

run-script

• 概要

  npm run-script <command> [--silent] [-- <args>...]
  
  alias: npm run
  

• 描述
  • 这将从包的"scripts"对象运行任意命令。如果未 "command"提供，它将列出可用的脚本。

search

• 概要

  npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]
  
  aliases: s, se, find
  

• 描述
  • 在注册表中搜索与搜索词匹配的软件包。

shrinkwrap

• 概要

  npm shrinkwrap
  

• 描述
  • 根据 package-lock.json 文件创建一个新的或覆盖已有的 npm-shrinkwrap.json 文件。

star

• 概要

  npm star [<pkg>...]
  npm unstar [<pkg>...]
  

• 描述
  • 为一个包加星标（“Starring”）意味着你对这个包感兴趣。

stars

• 概要

  npm stars [<user>]
  

• 描述
  • strar 了很多不错的包，这个命令可以让你快速找到它们

satrt

• 概要

  npm start [-- <args>]
  

• 描述
  • 在 package.json 文件中定义的 “scripts” 对象中查找 “start” 属性， 如果此属性定义了任何命令则执行之如果 “scripts” 对象中没有定义 “start” 属性， 默认执行 node server.js 命令。

stop

• 概要

  npm stop [-- <args>]
  

• 描述
  • 如果 package.json 文件中定义了 “stop” 脚本, 则执行。

team

• 概要

  npm team create <scope:team>
  npm team destroy <scope:team>
  
  npm team add <scope:team> <user>
  npm team rm <scope:team> <user>
  
  npm team ls <scope>|<scope:team>
  
  npm team edit <scope:team>
  

• 描述
  • 管理组织中的团队，并更改团队成员身份。

test

• 概要

  npm test [-- <args>]
  
  aliases: t, tst
  

• 描述
  • 如果 package.json 文件中定义了 “test” 脚本，则执行。

token

• 概要

  npm token list [--json|--parseable]
  npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16]
  npm token revoke <id|token>
  

• 描述
  • 列出，创建和撤销身份验证令牌

uninstall

• 概要

  npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional|--no-save]
  
  aliases: remove, rm, r, un, unlink
  

• 描述
  • 卸载软件包，从而完全删除代表该软件包安装的所有npm

unpublish

• 概要

  npm unpublish [<@scope>/]<pkg>[@<version>]
  

• 描述
  • 从注册表中删除软件包版本，删除其条目并删除压缩包。

update

• 概要

  npm update [-g] [<pkg>...]
  
  aliases: up, upgrade
  

• 描述
  • 该命令会将所有列出的软件包更新到最新版本（由tagconfig 指定），同时注意使用semver。

version

• 概要

  npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
  
  'npm [-v | --version]' to print npm version
  'npm view <pkg> version' to view a package's published version
  'npm ls' to inspect current package/dependency versions
  

• 描述
  • 显示版本号

view

• 概要

  npm view [<@scope>/]<name>[@<version>] [<field>[.<subfield>]...]
  
  aliases: info, show, v
  

• 描述
  • 显示有关程序包的数据，并将其打印到outfd配置引用的流中，默认情况下为stdout。

whoami

• 概要

  npm whoami [--registry <registry>]
  

• 描述
  • 标准输出上打印出 username 配置信息