npm-install
Install a package
Table of contents
Synopsis
Description
Configuration
save
save-exact
global
global-style
legacy-bundling
omit
strict-peer-deps
package-lock
foreground-scripts
ignore-scripts
audit
bin-links
fund
dry-run
workspace
workspaces
include-workspace-root
install-links
Algorithm
See Also
Synopsis
npm install [<package-spec> ...]
aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall
Description
이 명령은 패키지와 패키지가 의존하는 모든 패키지를 설치합니다. 패키지에 패키지 잠금, npm shrinkwrap 파일 또는 얀 잠금 파일이 있는 경우 다음 우선 순위에 따라 종속성 설치가 이에 의해 구동됩니다.
npm-shrinkwrap.json
package-lock.json
yarn.lock
See package-lock.json and npm shrinkwrap.
A package is:
a) package.json 파일에 설명된 프로그램이 포함된 폴더
b) (a)를 포함하는 gzip으로 압축된 tarball
c) (b)로 확인되는 URL
d) (c)와 함께 레지스트리(레지스트리 참조)에 게시된 <name>@<version>
e) (d)를 가리키는 <name>@<tag>(npm dist-tag 참조)
f) (e)를 만족하는 "최신" 태그가 있는 <name>
g) (a)로 해석되는 <git remote url>
패키지를 게시하지 않더라도 노드 프로그램(a)을 작성하고 패키지를 압축한 후 다른 곳에 쉽게 설치할 수 있기를 원한다면 여전히 npm을 사용하여 많은 이점을 얻을 수 있습니다. tarball (b)로.
npm install (in a package directory, no arguments):
Install the dependencies to the local node_modules folder.
전역 모드(즉, 명령에 추가된 -g 또는 --global 사용)에서는 현재 패키지 컨텍스트(즉, 현재 작업 디렉터리)를 전역 패키지로 설치합니다.
기본적으로 npm install은 package.json에 종속 항목으로 나열된 모든 모듈을 설치합니다.
--production 플래그를 사용하면(또는 NODE_ENV 환경 변수가 프로덕션으로 설정된 경우) npm은 devDependencies에 나열된 모듈을 설치하지 않습니다. NODE_ENV 환경 변수가 프로덕션으로 설정된 경우 종속성과 devDependencies 모두에 나열된 모든 모듈을 설치하려면 --production=false를 사용할 수 있습니다.
참고: --production 플래그는 프로젝트에 종속성을 추가할 때 특별한 의미가 없습니다.
npm install <folder>:
<folder>가 프로젝트의 루트 내부에 있는 경우 해당 종속성이 설치되고 다른 유형의 종속성과 마찬가지로 최상위 node_modules로 호이스팅될 수 있습니다. <folder>가 프로젝트의 루트 외부에 있는 경우 npm은 <folder> 디렉토리에 패키지 종속성을 설치하지 않지만 <folder>에 대한 심볼릭 링크를 생성합니다.
참고: 링크를 만드는 대신 레지스트리에서 패키지와 같은 디렉토리의 내용을 설치하려면 --install-links 옵션을 사용해야 합니다.
Example:
npm install ../../other-package --install-links
npm install ./sub-package
npm install <tarball file>:
파일 시스템에 있는 패키지를 설치합니다. 참고: 개발 디렉터리를 npm 루트에 연결하려는 경우 npm 링크를 사용하여 더 쉽게 이 작업을 수행할 수 있습니다.
Tarball requirements:
파일 이름은 .tar, .tar.gz 또는 .tgz를 확장자로 사용해야 합니다.
패키지 내용은 tarball 내부의 하위 폴더에 있어야 합니다(보통 package/라고 함). npm은 패키지를 설치할 때 하나의 디렉토리 계층을 제거합니다(tar x --strip-components=1에 해당하는 항목이 실행됨).
패키지에는 이름 및 버전 속성이 있는 package.json 파일이 포함되어야 합니다.
Example:
npm install ./package.tgz
npm install <tarball url>:
tarball URL을 가져온 다음 설치합니다. 이 옵션과 다른 옵션을 구별하려면 인수가 "http://" 또는 "https://"로 시작해야 합니다.
Example:
npm install https://github.com/indexzero/forever/tarball/v0.5.6
npm install [<@scope>/]<name>:
<name>@<tag> 설치를 수행하십시오. 여기서 <tag>는 "태그" 구성입니다. (구성을 참조하십시오. 구성의 기본값은 최신입니다.)
대부분의 경우 npm 레지스트리에서 최신으로 태그가 지정된 모듈 버전을 설치합니다.
Example:
npm install sax
npm install은 기본적으로 지정된 패키지를 종속성에 저장합니다. 또한 몇 가지 추가 플래그를 사용하여 저장 위치와 방법을 제어할 수 있습니다.
-P, --save-prod: 패키지가 종속성에 나타납니다. -D 또는 -O가 없는 경우 기본값입니다.
-D, --save-dev: 패키지가 devDependencies에 나타납니다.
-O, --save-optional: 패키지가 optionalDependencies에 나타납니다.
--no-save: 의존성에 대한 저장을 방지합니다.
위의 옵션 중 하나를 사용하여 package.json에 종속성을 저장할 때 두 가지 추가 선택적 플래그가 있습니다.
-E, --save-exact: 저장된 종속성은 npm의 기본 semver 범위 연산자를 사용하지 않고 정확한 버전으로 구성됩니다.
-B, --save-bundle: 저장된 종속 항목도 bundleDependencies 목록에 추가됩니다.
또한 npm-shrinkwrap.json 또는 package-lock.json이 있는 경우에도 업데이트됩니다.
<범위>는 선택 사항입니다. 패키지는 지정된 범위와 연결된 레지스트리에서 다운로드됩니다. 지정된 범위와 연결된 레지스트리가 없으면 기본 레지스트리가 사용됩니다. 범위를 참조하십시오.
참고: 범위 이름에 @ 기호를 포함하지 않으면 npm은 이를 대신 GitHub 리포지토리로 해석합니다(아래 참조). 범위 이름 뒤에도 슬래시가 와야 합니다.
Examples:
npm install sax
npm install githubname/reponame
npm install @myorg/privatepackage
npm install node-tap --save-dev
npm install dtrace-provider --save-optional
npm install readable-stream --save-exact
npm install ansi-regex --save-bundle
참고: 현재 작업 디렉토리에 이름이 <name>인 파일이나 폴더가 있으면 설치를 시도하고 패키지가 유효하지 않은 경우에만 이름으로 패키지 가져오기를 시도합니다.
npm install <alias>@npm:<name>:
사용자 지정 별칭으로 패키지를 설치합니다. 이름이 같은 패키지의 여러 버전을 나란히 허용하고, 긴 패키지가 있는 패키지에 대해 더 편리한 가져오기 이름을 허용하고, git forks 교체 또는 교체로 포크된 npm 패키지를 사용합니다. 별칭은 프로젝트에서만 작동하며 전이적 종속성에서 패키지 이름을 바꾸지 않습니다. 별칭은 validate-npm-package-name에 명시된 명명 규칙을 따라야 합니다.
Examples:
npm install my-react@npm:react
npm install jquery2@npm:jquery@2
npm install jquery3@npm:jquery@3
npm install npa@npm:npm-package-arg
npm install [<@scope>/]<name>@<tag>:
지정된 태그에서 참조하는 패키지 버전을 설치합니다. 해당 패키지의 레지스트리 데이터에 태그가 없으면 실패합니다.
Example:
npm install sax@latest
npm install @myorg/mypackage@latest
npm install [<@scope>/]<name>@<version>:
패키지의 지정된 버전을 설치합니다. 버전이 레지스트리에 게시되지 않은 경우 실패합니다.
Example:
npm install sax@0.1.1
npm install @myorg/privatepackage@1.5.0
npm install [<@scope>/]<name>@<version range>:
지정된 버전 범위와 일치하는 패키지 버전을 설치합니다. 이는 package.json에 설명된 종속성을 해결하기 위한 동일한 규칙을 따릅니다.
대부분의 버전 범위는 따옴표로 묶어야 셸에서 단일 인수로 처리할 수 있습니다.
Example:
npm install sax@">=0.1.0 <0.2.0"
npm install @myorg/privatepackage@"16 - 17"
npm install <git remote url>:
호스팅된 git 공급자에서 패키지를 설치하고 git로 복제합니다. 전체 git 원격 URL의 경우 해당 URL만 시도됩니다.
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
<protocol> is one of git, git+ssh, git+http, git+https, or git+file.
#<commit-ish>가 제공되면 정확히 해당 커밋을 복제하는 데 사용됩니다. commit-ish가 #semver:<semver> 형식이면 <semver>는 유효한 semver 범위 또는 정확한 버전이 될 수 있으며 npm은 원격 저장소에서 해당 범위와 일치하는 태그 또는 참조를 찾을 것입니다. 레지스트리 종속성. #<commit-ish> 또는 #semver:<semver>를 지정하지 않으면 저장소의 기본 분기가 사용됩니다.
저장소가 하위 모듈을 사용하는 경우 해당 하위 모듈도 복제됩니다.
설치 중인 패키지에 준비 스크립트가 포함되어 있으면 해당 종속성 및 devDependencies가 설치되고 패키지가 패키지 및 설치되기 전에 준비 스크립트가 실행됩니다.
다음 git 환경 변수는 npm에서 인식되며 git을 실행할 때 환경에 추가됩니다.
GIT_ASKPASS
GIT_EXEC_PATH
GIT_PROXY_COMMAND
GIT_SSH
GIT_SSH_COMMAND
GIT_SSL_CAINFO
GIT_SSL_NO_VERIFY
See the git man page for details.
Examples:
npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
npm install git+ssh://git@github.com:npm/cli#pull/273
npm install git+ssh://git@github.com:npm/cli#semver:^5.0
npm install git+https://isaacs@github.com/npm/cli.git
npm install git://github.com/npm/cli.git#v1.0.27
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
npm install <githubname>/<githubrepo>[#<commit-ish>]:
npm install github:<githubname>/<githubrepo>[#<commit-ish>]:
git을 사용하여 복제를 시도하여 https://github.com/githubname/githubrepo에서 패키지를 설치합니다
#<commit-ish>가 제공되면 정확히 해당 커밋을 복제하는 데 사용됩니다. commit-ish가 #semver:<semver> 형식이면 <semver>는 유효한 semver 범위 또는 정확한 버전이 될 수 있으며 npm은 원격 저장소에서 해당 범위와 일치하는 태그 또는 참조를 찾을 것입니다. 레지스트리 종속성. #<commit-ish> 또는 #semver:<semver>를 지정하지 않으면 마스터가 사용됩니다.
일반 git 종속성과 마찬가지로 종속성 및 devDependencies는 패키지 설치가 완료되기 전에 패키지에 준비 스크립트가 있는 경우 설치됩니다.
Examples:
npm install mygithubuser/myproject
npm install github:mygithubuser/myproject
npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]:
git을 사용하여 복제를 시도하여 https://gist.github.com/gistID에 패키지를 설치합니다. 요점과 연결된 GitHub 사용자 이름은 선택 사항이며 package.json에 저장되지 않습니다.
일반 git 종속성과 마찬가지로 종속성 및 devDependencies는 패키지 설치가 완료되기 전에 패키지에 준비 스크립트가 있는 경우 설치됩니다.
Example:
npm install gist:101a11beef
npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]:
Install the package at https://bitbucket.org/bitbucketname/bitbucketrepo by attempting to clone it using git.
#<commit-ish>가 제공되면 정확히 해당 커밋을 복제하는 데 사용됩니다. commit-ish가 #semver:<semver> 형식이면 <semver>는 유효한 semver 범위 또는 정확한 버전이 될 수 있으며 npm은 원격 저장소에서 해당 범위와 일치하는 태그 또는 참조를 찾을 것입니다. 레지스트리 종속성. #<commit-ish> 또는 #semver:<semver>를 지정하지 않으면 마스터가 사용됩니다.
일반 git 종속성과 마찬가지로 종속성 및 devDependencies는 패키지 설치가 완료되기 전에 패키지에 준비 스크립트가 있는 경우 설치됩니다.
Example:
npm install bitbucket:mybitbucketuser/myproject
npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]:
Install the package at https://gitlab.com/gitlabname/gitlabrepo by attempting to clone it using git.
#<commit-ish>가 제공되면 정확히 해당 커밋을 복제하는 데 사용됩니다. commit-ish가 #semver:<semver> 형식이면 <semver>는 유효한 semver 범위 또는 정확한 버전이 될 수 있으며 npm은 원격 저장소에서 해당 범위와 일치하는 태그 또는 참조를 찾을 것입니다. 레지스트리 종속성. #<commit-ish> 또는 #semver:<semver>를 지정하지 않으면 마스터가 사용됩니다.
일반 git 종속성과 마찬가지로 종속성 및 devDependencies는 패키지 설치가 완료되기 전에 패키지에 준비 스크립트가 있는 경우 설치됩니다.
Example:
npm install gitlab:mygitlabuser/myproject
npm install gitlab:myusr/myproj#semver:^5.0
여러 인수와 여러 유형의 인수를 결합할 수 있습니다.
For example:
npm install sax@">=0.1.0 <0.2.0" bench supervisor
--tag 인수는 지정된 모든 설치 대상에 적용됩니다. 지정된 이름의 태그가 있는 경우 태그가 지정된 버전이 새 버전보다 우선합니다.
--dry-run 인수는 실제로 아무것도 설치하지 않고 설치가 수행했을 일반적인 방식으로 보고합니다.
--package-lock-only 인수는 node_modules를 확인하고 종속성을 다운로드하는 대신 package-lock.json만 업데이트합니다.
-f 또는 --force 인수는 디스크에 로컬 복사본이 있더라도 npm이 원격 리소스를 가져오도록 합니다.
npm install sax --force
Configuration
구성 도움말 문서를 참조하십시오. 대부분의 구성 매개변수는 npm이 수행하는 작업이므로 설치에 어느 정도 영향을 미칩니다.
다음은 설치와 관련된 가장 일반적인 옵션 중 일부입니다.
save
Default: true unless when using npm update where it defaults to false
Type: Boolean
설치된 패키지를 package.json 파일에 종속 항목으로 저장합니다.
npm rm 명령과 함께 사용하면 package.json에서 종속성을 제거합니다.
또한 false로 설정하면 package-lock.json에 쓰기를 방지합니다.
save-exact
Default: false
Type: Boolean
package.json에 저장된 종속성은 npm의 기본 semver 범위 연산자를 사용하지 않고 정확한 버전으로 구성됩니다.
global
Default: false
Type: Boolean
패키지가 현재 작업 디렉터리 대신 접두사 폴더에 설치되도록 "전역" 모드에서 작동합니다. 동작의 차이점에 대한 자세한 내용은 폴더를 참조하십시오.
패키지는 현재 작업 디렉터리 대신 {prefix}/lib/node_modules 폴더에 설치됩니다.
bin 파일은 {prefix}/bin에 연결됩니다.
매뉴얼 페이지는 {prefix}/share/man에 링크되어 있습니다.
global-style
Default: false
Type: Boolean
npm이 전역 node_modules 폴더와 함께 사용하는 것과 동일한 레이아웃으로 로컬 node_modules 폴더에 패키지를 설치하도록 합니다. 직접 종속성만 node_modules에 표시되고 의존하는 모든 항목은 node_modules 폴더에서 평면화됩니다. 이것은 분명히 일부 중복 제거를 제거합니다. 레거시 번들링과 함께 사용하는 경우 레거시 번들링이 선호됩니다.
legacy-bundling
Default: false
Type: Boolean
노드 0.8에 포함된 것과 같은 1.4 이전의 npm 버전이 패키지를 설치할 수 있도록 npm이 패키지를 설치하도록 합니다. 이렇게 하면 모든 자동 중복 제거가 제거됩니다. 전역 스타일과 함께 사용하는 경우 이 옵션이 선호됩니다.
omit
Default: 'dev' if the NODE_ENV environment variable is set to 'production', otherwise empty.
Type: "dev", "optional", or "peer" (can be set multiple times)
디스크의 설치 트리에서 생략할 종속성 유형입니다.
이러한 종속성은 여전히 해결되어 package-lock.json 또는 npm-shrinkwrap.json 파일에 추가됩니다. 물리적으로 디스크에 설치되지 않습니다.
패키지 유형이 --include 및 --omit 목록 모두에 나타나면 포함됩니다.
결과 생략 목록에 'dev'가 포함된 경우 NODE_ENV 환경 변수는 모든 수명 주기 스크립트에 대해 'production'으로 설정됩니다.
strict-peer-deps
Default: false
Type: Boolean
true로 설정되고 --legacy-peer-deps가 설정되지 않은 경우 npm이 비피어 종속성 관계를 기반으로 적절한 해결 방법을 합리적으로 추측할 수 있더라도 충돌하는 모든 peerDependencies는 설치 실패로 처리됩니다.
기본적으로 종속성 그래프에서 충돌하는 peerDependencies는 가장 가까운 비 피어 종속성 사양을 사용하여 해결됩니다. 그렇게 하면 일부 패키지가 패키지의 peerDependencies 개체에 설정된 범위를 벗어난 피어 종속성을 수신하게 되더라도 마찬가지입니다.
이러한 재정의가 수행되면 충돌 및 관련된 패키지를 설명하는 경고가 인쇄됩니다. --strict-peer-deps가 설정된 경우 이 경고는 실패로 처리됩니다.
package-lock
Default: true
Type: Boolean
false로 설정하면 설치할 때 package-lock.json 파일을 무시합니다. 이렇게 하면 save가 true인 경우 package-lock.json 쓰기도 방지됩니다.
이 구성은 npm ci에 영향을 주지 않습니다.
foreground-scripts
Default: false
Type: Boolean
포그라운드 프로세스에서 설치된 패키지에 대한 모든 빌드 스크립트(즉, 사전 설치, 설치 및 사후 설치) 스크립트를 실행하고 기본 npm 프로세스와 표준 입력, 출력 및 오류를 공유합니다.
이렇게 하면 일반적으로 설치 실행 속도가 느려지고 소음이 훨씬 더 커지지만 디버깅에는 유용할 수 있습니다.
ignore-scripts
Default: false
Type: Boolean
true인 경우 npm은 package.json 파일에 지정된 스크립트를 실행하지 않습니다.
npm start, npm stop, npm restart, npm test 및 npm run-script와 같은 특정 스크립트를 실행하도록 명시적으로 의도된 명령은 ignore-scripts가 설정된 경우 의도한 스크립트를 계속 실행하지만 사전에 실행하지는 않습니다. - 또는 사후 스크립트.
audit
Default: true
Type: Boolean
"true"인 경우 현재 npm 명령과 함께 감사 보고서를 기본 레지스트리 및 범위에 대해 구성된 모든 레지스트리에 제출합니다. 제출된 항목에 대한 자세한 내용은 npm 감사 문서를 참조하세요.
bin-links
Default: true
Type: Boolean
패키지 실행 파일에 대한 심볼릭 링크(또는 Windows의 경우 .cmd shim)를 생성하도록 npm에 지시합니다.
이 작업을 수행하지 않으려면 false로 설정합니다. 이는 일부 파일 시스템이 표면상 Unix 시스템에서도 심볼릭 링크를 지원하지 않는다는 사실을 해결하는 데 사용할 수 있습니다.
fund
Default: true
Type: Boolean
"true"인 경우 각 npm 설치가 끝날 때 자금을 찾고 있는 종속성 수를 확인하는 메시지가 표시됩니다. 자세한 내용은 npm 펀드를 참조하세요.
dry-run
Default: false
Type: Boolean
npm이 변경하는 것을 원하지 않으며 수행했을 내용만 보고해야 함을 나타냅니다. 이는 로컬 설치를 수정하는 명령(예: 설치, 업데이트, 중복 제거, 제거, 압축 및 게시)에 전달될 수 있습니다.
참고: 이것은 다른 네트워크 관련 명령(예: dist-tags, 소유자 등)에서는 적용되지 않습니다.
workspace
Default:
Type: String (can be set multiple times)
이 구성 옵션으로 정의된 작업 공간만 실행하여 필터링하면서 현재 프로젝트의 구성된 작업 공간 컨텍스트에서 명령 실행을 활성화합니다.
작업 공간 구성의 유효한 값은 다음 중 하나입니다.
작업 공간 이름
작업공간 디렉토리 경로
상위 작업 공간 디렉토리의 경로(해당 폴더 내의 모든 작업 공간이 선택됨)
npm init 명령에 대해 설정할 때 아직 존재하지 않는 작업 공간의 폴더로 설정하여 폴더를 생성하고 프로젝트 내에서 완전히 새로운 작업 공간으로 설정할 수 있습니다.
이 값은 하위 프로세스의 환경으로 내보내지지 않습니다.
workspaces
Default: null
Type: null or Boolean
구성된 모든 작업 공간의 컨텍스트에서 명령을 실행하려면 true로 설정하십시오.
이를 명시적으로 false로 설정하면 설치와 같은 명령이 작업 공간을 모두 무시합니다. 명시적으로 설정하지 않은 경우:
node_modules 트리에서 작동하는 명령(설치, 업데이트 등)은 작업 공간을 node_modules 폴더에 연결합니다. - 다른 작업(테스트, 실행, 게시 등)을 수행하는 명령은 작업 영역 구성에 하나 이상의 작업 영역이 지정되지 않는 한 루트 프로젝트에서 작동합니다.
이 값은 하위 프로세스의 환경으로 내보내지지 않습니다.
include-workspace-root
Default: false
Type: Boolean
명령에 대해 작업공간이 활성화된 경우 작업공간 루트를 포함합니다.
false인 경우 작업 공간 구성을 통해 개별 작업 공간을 지정하거나 작업 공간 플래그를 통해 모든 작업 공간을 지정하면 npm이 루트 프로젝트가 아닌 지정된 작업 공간에서만 작동합니다.
이 값은 하위 프로세스의 환경으로 내보내지지 않습니다.
install-links
Default: false
Type: Boolean
파일 설정 시: 프로젝트 루트 외부에 존재하는 프로토콜 종속성은 심볼릭 링크를 생성하는 대신 일반 종속성으로 압축 및 설치됩니다. 이 옵션은 작업 공간에 영향을 주지 않습니다.
Algorithm
Given a package{dep} structure: A{B,C}, B{C}, C{D}, the npm install algorithm produces:
A
+-- B
+-- C
+-- D
즉, B에서 C로의 종속성은 A가 이미 C를 더 높은 수준에 설치하게 했다는 사실에 의해 충족됩니다. D는 아무 것도 충돌하지 않기 때문에 여전히 최상위 레벨에 설치됩니다.
A{B,C}, B{C,D@1}, C{D@2}에 대해 이 알고리즘은 다음을 생성합니다.
A
+-- B
+-- C
`-- D@2
+-- D@1
B의 D@1이 최상위 레벨에 설치되기 때문에 이제 C는 D@2를 개인적으로 설치해야 합니다. 이 알고리즘은 결정적이지만 다른 순서로 설치를 위해 두 개의 종속성이 요청된 경우 다른 트리가 생성될 수 있습니다.
npm이 생성하는 특정 폴더 구조에 대한 자세한 설명은 폴더를 참조하세요.