npm-install
This command installs a package and any packages that it depends on. If the package has a package-lock, or an npm shrinkwrap file, or a yarn lock file, the installation of dependencies will be driven by that, respecting the following order of precedence:
- npm-shrinkwrap.json
- package-lock.json
- yarn.lock
- a) a folder containing a program described by a package.json file
- b) a gzipped tarball containing (a)
- c) a url that resolves to (b)
- d) a <name>@<version> that is published on the registry (see registry ) with (c)
- e) a <name>@<tag> (see npm dist-tag ) that points to (d)
- f) a <name> that has a "latest" tag satisfying (e)
- g) a <git remote url> that resolves to (a)
Even if you never publish your package, you can still get a lot of benefits of using npm if you just want to write a node program (a), and perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b).
npm install (in a package directory, no arguments):
Install the dependencies to the local node_modules folder.
In global mode (ie, with -g or —global appended to the command), it installs the current package context (ie, the current working directory) as a global package.
By default, npm install will install all modules listed as dependencies in package.json .
With the —production flag (or when the NODE_ENV environment variable is set to production ), npm will not install modules listed in devDependencies . To install all modules listed in both dependencies and devDependencies when NODE_ENV environment variable is set to production , you can use —production=false .
NOTE: The —production flag has no particular meaning when adding a dependency to a project.
npm install <folder> :
If <folder> sits inside the root of your project, its dependencies will be installed and may be hoisted to the top-level node_modules as they would for other types of dependencies. If <folder> sits outside the root of your project, npm will not install the package dependencies in the directory <folder> , but it will create a symlink to <folder> .
NOTE: If you want to install the content of a directory like a package from the registry instead of creating a link, you would need to use the —install-links option.
npm install <tarball file> :
Install a package that is sitting on the filesystem. Note: if you just want to link a dev directory into your npm root, you can do this more easily by using npm link .
The filename must use .tar , .tar.gz , or .tgz as the extension.
The package contents should reside in a subfolder inside the tarball (usually it is called package/ ). npm strips one directory layer when installing the package (an equivalent of tar x —strip-components=1 is run).
The package must contain a package.json file with name and version properties.
npm install <tarball url> :
Fetch the tarball url, and then install it. In order to distinguish between this and other options, the argument must start with "http://" or "https://"
Do a <name>@<tag> install, where <tag> is the "tag" config. (See config . The config's default value is latest .)
In most cases, this will install the version of the modules tagged as latest on the npm registry.
npm install saves any specified packages into dependencies by default. Additionally, you can control where and how they get saved with some additional flags:
-P, —save-prod : Package will appear in your dependencies . This is the default unless -D or -O are present.
-D, —save-dev : Package will appear in your devDependencies .
-O, —save-optional : Package will appear in your optionalDependencies .
—no-save : Prevents saving to dependencies .
When using any of the above options to save dependencies to your package.json, there are two additional, optional flags:
-E, —save-exact : Saved dependencies will be configured with an exact version rather than using npm's default semver range operator.
-B, —save-bundle : Saved dependencies will also be added to your bundleDependencies list.
Further, if you have an npm-shrinkwrap.json or package-lock.json then it will be updated as well.
<scope> is optional. The package will be downloaded from the registry associated with the specified scope. If no registry is associated with the given scope the default registry is assumed. See scope .
Note: if you do not include the @-symbol on your scope name, npm will interpret this as a GitHub repository instead, see below. Scopes names must also be followed by a slash.
Note: If there is a file or folder named <name> in the current working directory, then it will try to install that, and only try to fetch the package by name if it is not valid.
npm install <alias>@npm:<name> :
Install a package under a custom alias. Allows multiple versions of a same-name package side-by-side, more convenient import names for packages with otherwise long ones, and using git forks replacements or forked npm packages as replacements. Aliasing works only on your project and does not rename packages in transitive dependencies. Aliases should follow the naming conventions stated in validate-npm-package-name .
Install the version of the package that is referenced by the specified tag. If the tag does not exist in the registry data for that package, then this will fail.
Install the specified version of the package. This will fail if the version has not been published to the registry.
npm install [<@scope>/]<name>@<version range> :
Install a version of the package matching the specified version range. This will follow the same rules for resolving dependencies described in package.json .
Note that most version ranges must be put in quotes so that your shell will treat it as a single argument.
npm install <git remote url> :
Installs the package from the hosted git provider, cloning it with git . For a full git remote url, only that URL will be attempted.
<protocol> is one of git , git+ssh , git+http , git+https , or git+file .
If #<commit-ish> is provided, it will be used to clone exactly that commit. If the commit-ish has the format #semver:<semver> , <semver> can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither #<commit-ish> or #semver:<semver> is specified, then the default branch of the repository is used.
If the repository makes use of submodules, those submodules will be cloned as well.
If the package being installed contains a prepare script, its dependencies and devDependencies will be installed, and the prepare script will be run, before the package is packaged and installed.
The following git environment variables are recognized by npm and will be added to the environment when running git:
See the git man page for details.
npm install <githubname>/<githubrepo>[#<commit-ish>] :
npm install github:<githubname>/<githubrepo>[#<commit-ish>] :
Install the package at https://github.com/githubname/githubrepo by attempting to clone it using git .
If #<commit-ish> is provided, it will be used to clone exactly that commit. If the commit-ish has the format #semver:<semver> , <semver> can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither #<commit-ish> or #semver:<semver> is specified, then the default branch is used.
As with regular git dependencies, dependencies and devDependencies will be installed if the package has a prepare script before the package is done installing.
npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>] :
Install the package at https://gist.github.com/gistID by attempting to clone it using git . The GitHub username associated with the gist is optional and will not be saved in package.json .
As with regular git dependencies, dependencies and devDependencies will be installed if the package has a prepare script before the package is done installing.
npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>] :
Install the package at https://bitbucket.org/bitbucketname/bitbucketrepo by attempting to clone it using git .
If #<commit-ish> is provided, it will be used to clone exactly that commit. If the commit-ish has the format #semver:<semver> , <semver> can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither #<commit-ish> or #semver:<semver> is specified, then master is used.
As with regular git dependencies, dependencies and devDependencies will be installed if the package has a prepare script before the package is done installing.
npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>] :
Install the package at https://gitlab.com/gitlabname/gitlabrepo by attempting to clone it using git .
If #<commit-ish> is provided, it will be used to clone exactly that commit. If the commit-ish has the format #semver:<semver> , <semver> can be any valid semver range or exact version, and npm will look for any tags or refs matching that range in the remote repository, much as it would for a registry dependency. If neither #<commit-ish> or #semver:<semver> is specified, then master is used.
As with regular git dependencies, dependencies and devDependencies will be installed if the package has a prepare script before the package is done installing.
You may combine multiple arguments and even multiple types of arguments. For example:
The —tag argument will apply to all of the specified install targets. If a tag with the given name exists, the tagged version is preferred over newer versions.
The —dry-run argument will report in the usual way what the install would have done without actually installing anything.
The —package-lock-only argument will only update the package-lock.json , instead of checking node_modules and downloading dependencies.
The -f or —force argument will force npm to fetch remote resources even if a local copy exists on disk.
See the config help doc. Many of the configuration params have some effect on installation, since that's most of what npm does.
These are some of the most common options related to installation.
- Default: true unless when using npm update where it defaults to false
- Type: Boolean
Save installed packages to a package.json file as dependencies.
When used with the npm rm command, removes the dependency from package.json .
Will also prevent writing to package-lock.json if set to false .
- Default: false
- Type: Boolean
Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.
- Default: false
- Type: Boolean
Operates in "global" mode, so that packages are installed into the prefix folder instead of the current working directory. See folders for more on the differences in behavior.
- packages are installed into the
/lib/node_modules folder, instead of the current working directory. - bin files are linked to
/bin - man pages are linked to
/share/man
- Default: "hoisted"
- Type: "hoisted", "nested", "shallow", or "linked"
Sets the strategy for installing packages in node_modules. hoisted (default): Install non-duplicated in top-level, and duplicated as necessary within directory structure. nested: (formerly —legacy-bundling) install in place, no hoisting. shallow (formerly —global-style) only install direct deps at top-level. linked: (experimental) install in node_modules/.store, link in place, unhoisted.
- Default: false
- Type: Boolean
- DEPRECATED: This option has been deprecated in favor of —install-strategy=nested
Instead of hoisting package installs in node_modules , install packages in the same manner that they are depended on. This may cause very deep directory structures and duplicate package installs as there is no de-duplicating. Sets —install-strategy=nested .
- Default: false
- Type: Boolean
- DEPRECATED: This option has been deprecated in favor of —install-strategy=shallow
Only install direct dependencies in the top level node_modules , but hoist on deeper dependencies. Sets —install-strategy=shallow .
- Default: 'dev' if the NODE_ENV environment variable is set to 'production', otherwise empty.
- Type: "dev", "optional", or "peer" (can be set multiple times)
Dependency types to omit from the installation tree on disk.
Note that these dependencies are still resolved and added to the package-lock.json or npm-shrinkwrap.json file. They are just not physically installed on disk.
If a package type appears in both the —include and —omit lists, then it will be included.
If the resulting omit list includes 'dev' , then the NODE_ENV environment variable will be set to 'production' for all lifecycle scripts.
- Default: false
- Type: Boolean
If set to true , and —legacy-peer-deps is not set, then any conflicting peerDependencies will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.
By default, conflicting peerDependencies deep in the dependency graph will be resolved using the nearest non-peer dependency specification, even if doing so will result in some packages receiving a peer dependency outside the range set in their package's peerDependencies object.
When such an override is performed, a warning is printed, explaining the conflict and the packages involved. If —strict-peer-deps is set, then this warning is treated as a failure.
- Default: true
- Type: Boolean
If set to false, then ignore package-lock.json files when installing. This will also prevent writing package-lock.json if save is true.
This configuration does not affect npm ci .
- Default: false
- Type: Boolean
Run all build scripts (ie, preinstall , install , and postinstall ) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
- Default: false
- Type: Boolean
If true, npm does not run scripts specified in package.json files.
Note that commands explicitly intended to run a particular script, such as npm start , npm stop , npm restart , npm test , and npm run-script will still run their intended script if ignore-scripts is set, but they will not run any pre- or post-scripts.
- Default: true
- Type: Boolean
When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for npm audit for details on what is submitted.
- Default: true
- Type: Boolean
Tells npm to create symlinks (or .cmd shims on Windows) for package executables.
Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.
- Default: true
- Type: Boolean
When "true" displays the message at the end of each npm install acknowledging the number of dependencies looking for funding. See npm fund for details.
- Default: false
- Type: Boolean
Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, install , update , dedupe , uninstall , as well as pack and publish .
Note: This is NOT honored by other network related commands, eg dist-tags , owner , etc.
- Default:
- Type: String (can be set multiple times)
Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
Valid values for the workspace config are either:
- Workspace names
- Path to a workspace directory
- Path to a parent workspace directory (will result in selecting all workspaces within that folder)
When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
This value is not exported to the environment for child processes.
- Default: null
- Type: null or Boolean
Set to true to run the command in the context of all configured workspaces.
Explicitly setting this to false will cause commands like install to ignore workspaces altogether. When not set explicitly:
- Commands that operate on the node_modules tree (install, update, etc.) will link workspaces into the node_modules folder. — Commands that do other things (test, exec, publish, etc.) will operate on the root project, unless one or more workspaces are specified in the workspace config.
This value is not exported to the environment for child processes.
- Default: false
- Type: Boolean
Include the workspace root when workspaces are enabled for a command.
When false, specifying individual workspaces via the workspace config, or all workspaces via the workspaces flag, will cause npm to operate only on the specified workspaces, and not on the root project.
This value is not exported to the environment for child processes.
- Default: false
- Type: Boolean
When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
Given a package
That is, the dependency from B to C is satisfied by the fact that A already caused C to be installed at a higher level. D is still installed at the top level because nothing conflicts with it.
For A
Because B's D@1 will be installed in the top-level, C now has to install D@2 privately for itself. This algorithm is deterministic, but different trees may be produced if two dependencies are requested for installation in a different order.
See folders for a more detailed description of the specific folder structures that npm creates.
Шпаргалка по пакетному менеджеру NPM
Есть несколько способов чтобы обновить npm. Я предпочитаю:
Поиск пакетов в npm
Подсказка: Можно также использовать search.npmjs.org
Вторая подсказка: Для поиска необходимо знать имя нужного пакета (всё прекрасно ищет по любому слову как в имени пакета, так и в его описании, может неправильно перевёл?)
Просмотр информации о пакете
Локальная установка пакетов
Для демонстрации возьмём пакет http-server.
http-server is a package we’ve written which provides an easy to use wrapper around node’s core http.Server class. This module makes for a good example, since it’s API provides both a CLI binary and a requirable node.js module.
http-server — пакет, который мы написали, предоставляет более простой интерфейс в использовании базового модуля http.Server из node.js. Этот модуль хороший пример использования API как для бинарного CLI, так и для подключаемого модуля node.js.
Так мы установим http-server в нашей рабочей директории.
Вы увидите новую папку в node_modules. Сейчас можете не обращать на это внимание.
Установка пакета в наше приложение
test.js
Обратите внимание, как мы делаем: require(‘http-server’)? Что это за магия? (автор молодец)
http-server не является базовым модулем node.js. Этот пакет мы только что установили из npm. Node.js и npm взаимодействуют и автоматически подключают наши локальные модули из node_modules директории.
Понимание разницы между глобальной и локальной установкой
test.js
теперь запустим наш скрипт
мы получим эту ошибку:
Это вполне логично, мы установили http-server локально в «/mynewapp/», а не в «/anotherapp/».
Есть два решения в этой ситуации:
а) Установить ещё раз пакет, но локально в наше новое приложение
б) Установить пакет глобально
Глобальная установка пакетов
Если вы хотите чтобы пакет был доступен всем приложениям, его нужно установить глобально:
Флаг -g означает, что http-server должен быть установлен глобально и быть доступными для всех приложений.
Теперь мы можем вызывать его require(‘http-server’) в любом нашем приложении.
Кроме того, поскольку http-server пакет имеет свой исполняемый файл, то этот файл также будет установлен как исполняемый http-server и доступен в командах.
Теперь вы можете просто запустить команду:
Удаление локально установленного пакета
Удаление глобально установленного пакета
Установка определённой версии пакета
Установка модуля с Github
Важно. В некоторых случаях будут патчи, форки или ветви, которые вы хотите использовать, но которые еще не были опубликованы в npm. К счастью исходные коды для большинства npm модулей также доступна на www.github.com
Теперь наша клонированная версия http-server связана локально.
Связи любых пакетов локально
Если у вас есть отдельный каталог содержащий пакет npm, то можно создать локальную связь для него. Это удобно в ситуациях, когда мы не хотим опубликовать наш пакет в хранилище npm.
На нашу локальную версию http-server создана «связана» для нашей локальной машины. (связь создаётся как «copy-paste», с начало нужно перейти в нужный катало и сделать «copy», потом перейти в нужный каталог и сделать «paste». Так вот сейчас мы изучили как делается «copy», а ниже будет про «paste» этого модуля)
Связи локальных пакетов для нескольких приложений
Как мы видели ранее npm устанавливает пакеты в локальный каталог по умолчанию. Так вот npm ссылка(связь) работает почти так же.
Мы указываем, что теперь создали связь из http-server в наше новое приложение newapp. Если бы мы не выполнили npm link http-server, то получили бы ошибку об отсутствующем модуле. (а вот наш и «paste» о чём я писал выше, теперь вам должна быть понятна логика создания связей)
Отмена связи между пакетами приложения
(здесь мы просто отменяем наш «paste» для этого приложения)
Отмена связи пакета в системе
(здесь мы отменяем наш «copy» для этого пакета)
Создание нового пакета
(от себя хочу лишь заметить, что создание пакета не такая простая задача в одну команду, подробнее можно почитать в другой статье)
Добавление нового пользователя
Публикация пакета в репозиторий npm
Удаление пакета из репозитория npm
Управление правами доступа к пакетам в репозитории npm
Вы можете задать права доступа других пользователей к опубликованному пакету:
How to install a previous exact version of a NPM package?
I used nvm to download node v0.4.10 and installed npm to work with that version of node.
I am trying to install express using
and I get an error that express requires node version >= 0.5.0.
Well, this is odd, since I am following the directions for a node+express+mongodb tutorial here that used node v0.4.10, so I am assuming express is/was available to node v0.4.10. If my assumption is correct, how do I tell npm to fetch a version that would work with my setup?
10 Answers 10
If you have to install an older version of a package, just specify it
For example: npm install express@3.0.0
You can also add the —save flag to that command to add it to your package.json dependencies, or —save —save-exact flags if you want that exact version specified in your package.json dependencies.
The install command is documented here: https://docs.npmjs.com/cli/install
If you’re not sure what versions of a package are available, you can use:
And npm view can be used for viewing other things about a package too. https://docs.npmjs.com/cli/view
It’s quite easy. Just write this, for example:
First remove old version, then run literally the following:
and for stable or recent
In my opinion that is easiest and fastest way:
$ npm install -g npm@latest-3
you can update your npm package by using this command:
npm install <package_name>@<version_number>
example: npm install yargs@12.0.2
You can use the following command to install a previous version of an npm package:
I have a general way to solve this type of problems, which could be helpful too, especially when cloning repositories to run them locally, but requires a little more analysis of the versions.
With the package npm-check-updates I verify the versions of the packages (according to the package.json file) that are not declared in their latest available versions, as shown in the figure (https://www.npmjs.com/package/npm-check-updates):
With this information we can verify the update status of the different packages and make decisions as to which packages to upgrade / degrade and which ones do not.
Assuming that we decided to update all the packages as they are listed, we can use the ncu -u command which only modifies your package.json file. Run npm install to update your installed packages and package-lock.json.
Then, depending on the requirements of the repository, we can refine what is needed, installing the specific versions with npm view <package> versions and npm install <package>@<version>
npm: полезные сокращения и трюки
В этой статье вы найдете несколько удобных команд для работы с npm — менеджером пакетов, входящим в состав Node.js. Из всего множества существующих мы выбрали те, которые могут быть наиболее полезны при ежедневном использовании.
Базовые сокращения
Сначала вспомним самые известные сокращения для установки:
- установить пакет: npm install pkg , сокращение: npm i pkg .
- установить пакет глобально: npm i —global pkg , сокращение: npm i -g pkg .
- установить пакет и сохранить как зависимость: npm i —save pkg , сокращение: npm i -S pkg .
- установить пакет только для использования в разработке (devDependency): npm i —save-dev pkg , сокращение: npm i -D pkg .
Другие сокращения можно посмотреть на официальном сайте.
Интересное
Инициализация нового пакета
Первое действие при создании нового пакета — npm init :
Если вопросы кажутся вам лишними и вы хотите их проскочить, используйте npm init -y или npm init -f :
Тестирование
Часто используемую команду npm test можно заменить на npm t , она делает то же самое:
Доступные скрипты
При работе над новым проектом вы, скорее всего, интересуетесь, что вообще можно запустить в его рамках. Можно открыть файл package.json и проверить секцию scripts :
Но список доступных скриптов можно получить и через npm run :
Еще вариант — установить интерактивное меню ntl ( npm i -g ntl ) и запустить в папке проекта:
Установленные пакеты
Для проверки зависимостей тоже можно было бы зайти в package.json , но есть вариант получше — npm ls —depth 0 :
Для проверки пакетов, установленных глобально, подходит та же команда с соответствующим флагом — npm ls -g —depth 0 :
Запуск локально установленных исполняемых модулей
Мы установили пакет, в нем есть исполняемый модуль, но он работает только при запуске через npm-скрипты. Почему это так, и как этого избежать?
Когда мы передаем команду терминалу, он ищет исполняемый модуль с таким же названием по всем путям, которые перечислены в переменной окружения PATH . Локально установленные пакеты регистрируют исполняемые файлы локально, поэтому они не перечислены в PATH и не могут быть обнаружены.
При запуске исполняемых модулей через npm-скрипты менеджер пакетов добавляет дополнительную папку к PATH , <директория проекта>/node_modules/.bin . Её можно найти, запустив npm run env | grep "$PATH" . С помощью npm run env можно увидеть все доступные переменные окружения.
В node_modules/.bin локально установленные пакеты размещают свои исполняемые модули. Запускаем ./node_modules/.bin/mocha в директории проекта:
Просто пишите ./node_modules/.bin/<команда> , когда хотите запустить локально установленный исполняемый модуль.
Найти пакет в Интернете
В файле package.json вы могли заметить запись repository . Для того, чтобы открыть соответствующий репозиторий в браузере, запустите команду npm repo . Команда npm home выполняет ту же функцию для записи homepage . Если вы хотите открыть пакет на официальном сайте, используйте команду npm docs .
Запуск скриптов до и после других скриптов
Вы скорее всего знакомы со скриптом pretest , он позволяет определить код, который следует запустить перед скриптом test . Оказывается, pre и post скрипты можно создавать для любых других скриптов, в том числе кастомных:
Обновить версию пакета
Допустим, вы используете semver для управления версиями и хотите обновить версию перед очередным релизом. Можно открыть package.json и сделать это вручную, но зачем?
Более простой способ — запустить команду npm version с major , minor или patch :
Еще несколько советов можно найти в специальном репозитории на GitHub, где кроме этого собраны разные полезные инструменты и ссылки на ресурсы, связанные с npm.