1<!DOCTYPE html><html><head>
2<meta charset="utf-8">
3<title>npm-hook</title>
4<style>
5body {
6    background-color: #ffffff;
7    color: #24292e;
8
9    margin: 0;
10
11    line-height: 1.5;
12
13    font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
14}
15#rainbar {
16    height: 10px;
17    background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
18}
19
20a {
21    text-decoration: none;
22    color: #0366d6;
23}
24a:hover {
25    text-decoration: underline;
26}
27
28pre {
29    margin: 1em 0px;
30    padding: 1em;
31    border: solid 1px #e1e4e8;
32    border-radius: 6px;
33
34    display: block;
35    overflow: auto;
36
37    white-space: pre;
38
39    background-color: #f6f8fa;
40    color: #393a34;
41}
42code {
43    font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
44    font-size: 85%;
45    padding: 0.2em 0.4em;
46    background-color: #f6f8fa;
47    color: #393a34;
48}
49pre > code {
50    padding: 0;
51    background-color: inherit;
52    color: inherit;
53}
54h1, h2, h3 {
55    font-weight: 600;
56}
57
58#logobar {
59    background-color: #333333;
60    margin: 0 auto;
61    padding: 1em 4em;
62}
63#logobar .logo {
64    float: left;
65}
66#logobar .title {
67    font-weight: 600;
68    color: #dddddd;
69    float: left;
70    margin: 5px 0 0 1em;
71}
72#logobar:after {
73    content: "";
74    display: block;
75    clear: both;
76}
77
78#content {
79    margin: 0 auto;
80    padding: 0 4em;
81}
82
83#table_of_contents > h2 {
84    font-size: 1.17em;
85}
86#table_of_contents ul:first-child {
87    border: solid 1px #e1e4e8;
88    border-radius: 6px;
89    padding: 1em;
90    background-color: #f6f8fa;
91    color: #393a34;
92}
93#table_of_contents ul {
94    list-style-type: none;
95    padding-left: 1.5em;
96}
97#table_of_contents li {
98    font-size: 0.9em;
99}
100#table_of_contents li a {
101    color: #000000;
102}
103
104header.title {
105    border-bottom: solid 1px #e1e4e8;
106}
107header.title > h1 {
108    margin-bottom: 0.25em;
109}
110header.title > .description {
111    display: block;
112    margin-bottom: 0.5em;
113    line-height: 1;
114}
115
116footer#edit {
117    border-top: solid 1px #e1e4e8;
118    margin: 3em 0 4em 0;
119    padding-top: 2em;
120}
121</style>
122</head>
123<body>
124<div id="banner">
125<div id="rainbar"></div>
126<div id="logobar">
127<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
128<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
129<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
130</svg>
131<div class="title">
132npm command-line interface
133</div>
134</div>
135</div>
136
137<section id="content">
138<header class="title">
139<h1 id="npm-hook">npm-hook</h1>
140<span class="description">Manage registry hooks</span>
141</header>
142
143<section id="table_of_contents">
144<h2 id="table-of-contents">Table of contents</h2>
145<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#example">Example</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#registry"><code>registry</code></a></li><li><a href="#otp"><code>otp</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
146</section>
147
148<div id="_content"><h3 id="synopsis">Synopsis</h3>
149<pre><code class="language-bash">npm hook add &lt;pkg&gt; &lt;url&gt; &lt;secret&gt; [--type=&lt;type&gt;]
150npm hook ls [pkg]
151npm hook rm &lt;id&gt;
152npm hook update &lt;id&gt; &lt;url&gt; &lt;secret&gt;
153</code></pre>
154<p>Note: This command is unaware of workspaces.</p>
155<h3 id="description">Description</h3>
156<p>Allows you to manage <a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">npm
157hooks</a>,
158including adding, removing, listing, and updating.</p>
159<p>Hooks allow you to configure URL endpoints that will be notified whenever a
160change happens to any of the supported entity types. Three different types
161of entities can be watched by hooks: packages, owners, and scopes.</p>
162<p>To create a package hook, simply reference the package name.</p>
163<p>To create an owner hook, prefix the owner name with <code>~</code> (as in,
164<code>~youruser</code>).</p>
165<p>To create a scope hook, prefix the scope name with <code>@</code> (as in,
166<code>@yourscope</code>).</p>
167<p>The hook <code>id</code> used by <code>update</code> and <code>rm</code> are the IDs listed in <code>npm hook ls</code>
168for that particular hook.</p>
169<p>The shared secret will be sent along to the URL endpoint so you can verify
170the request came from your own configured hook.</p>
171<h3 id="example">Example</h3>
172<p>Add a hook to watch a package for changes:</p>
173<pre><code class="language-bash">$ npm hook add lodash https://example.com/ my-shared-secret
174</code></pre>
175<p>Add a hook to watch packages belonging to the user <code>substack</code>:</p>
176<pre><code class="language-bash">$ npm hook add ~substack https://example.com/ my-shared-secret
177</code></pre>
178<p>Add a hook to watch packages in the scope <code>@npm</code></p>
179<pre><code class="language-bash">$ npm hook add @npm https://example.com/ my-shared-secret
180</code></pre>
181<p>List all your active hooks:</p>
182<pre><code class="language-bash">$ npm hook ls
183</code></pre>
184<p>List your active hooks for the <code>lodash</code> package:</p>
185<pre><code class="language-bash">$ npm hook ls lodash
186</code></pre>
187<p>Update an existing hook's url:</p>
188<pre><code class="language-bash">$ npm hook update id-deadbeef https://my-new-website.here/
189</code></pre>
190<p>Remove a hook:</p>
191<pre><code class="language-bash">$ npm hook rm id-deadbeef
192</code></pre>
193<h3 id="configuration">Configuration</h3>
194<h4 id="registry"><code>registry</code></h4>
195<ul>
196<li>Default: "<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>"</li>
197<li>Type: URL</li>
198</ul>
199<p>The base URL of the npm registry.</p>
200<h4 id="otp"><code>otp</code></h4>
201<ul>
202<li>Default: null</li>
203<li>Type: null or String</li>
204</ul>
205<p>This is a one-time password from a two-factor authenticator. It's needed
206when publishing or changing package permissions with <code>npm access</code>.</p>
207<p>If not set, and a registry response fails with a challenge for a one-time
208password, npm will prompt on the command line for one.</p>
209<h3 id="see-also">See Also</h3>
210<ul>
211<li><a href="https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm">"Introducing Hooks" blog post</a></li>
212</ul></div>
213
214<footer id="edit">
215<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-hook.md">
216<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
217<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
218</svg>
219Edit this page on GitHub
220</a>
221</footer>
222</section>
223
224
225
226</body></html>