Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

98 lines
2.0 KiB

  1. .TH "NPM\-HOOK" "1" "August 2018" "" ""
  2. .SH "NAME"
  3. \fBnpm-hook\fR \- Manage registry hooks
  4. .SH SYNOPSIS
  5. .P
  6. .RS 2
  7. .nf
  8. npm hook ls [pkg]
  9. npm hook add <entity> <url> <secret>
  10. npm hook update <id> <url> [secret]
  11. npm hook rm <id>
  12. .fi
  13. .RE
  14. .SH EXAMPLE
  15. .P
  16. Add a hook to watch a package for changes:
  17. .P
  18. .RS 2
  19. .nf
  20. $ npm hook add lodash https://example\.com/ my\-shared\-secret
  21. .fi
  22. .RE
  23. .P
  24. Add a hook to watch packages belonging to the user \fBsubstack\fP:
  25. .P
  26. .RS 2
  27. .nf
  28. $ npm hook add ~substack https://example\.com/ my\-shared\-secret
  29. .fi
  30. .RE
  31. .P
  32. Add a hook to watch packages in the scope \fB@npm\fP
  33. .P
  34. .RS 2
  35. .nf
  36. $ npm hook add @npm https://example\.com/ my\-shared\-secret
  37. .fi
  38. .RE
  39. .P
  40. List all your active hooks:
  41. .P
  42. .RS 2
  43. .nf
  44. $ npm hook ls
  45. .fi
  46. .RE
  47. .P
  48. List your active hooks for the \fBlodash\fP package:
  49. .P
  50. .RS 2
  51. .nf
  52. $ npm hook ls lodash
  53. .fi
  54. .RE
  55. .P
  56. Update an existing hook's url:
  57. .P
  58. .RS 2
  59. .nf
  60. $ npm hook update id\-deadbeef https://my\-new\-website\.here/
  61. .fi
  62. .RE
  63. .P
  64. Remove a hook:
  65. .P
  66. .RS 2
  67. .nf
  68. $ npm hook rm id\-deadbeef
  69. .fi
  70. .RE
  71. .SH DESCRIPTION
  72. .P
  73. Allows you to manage npm
  74. hooks \fIhttps://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR,
  75. including adding, removing, listing, and updating\.
  76. .P
  77. Hooks allow you to configure URL endpoints that will be notified whenever a
  78. change happens to any of the supported entity types\. Three different types of
  79. entities can be watched by hooks: packages, owners, and scopes\.
  80. .P
  81. To create a package hook, simply reference the package name\.
  82. .P
  83. To create an owner hook, prefix the owner name with \fB~\fP (as in, \fB~youruser\fP)\.
  84. .P
  85. To create a scope hook, prefix the scope name with \fB@\fP (as in, \fB@yourscope\fP)\.
  86. .P
  87. The hook \fBid\fP used by \fBupdate\fP and \fBrm\fP are the IDs listed in \fBnpm hook ls\fP for
  88. that particular hook\.
  89. .P
  90. The shared secret will be sent along to the URL endpoint so you can verify the
  91. request came from your own configured hook\.
  92. .SH SEE ALSO
  93. .RS 0
  94. .IP \(bu 2
  95. "Introducing Hooks" blog post \fIhttps://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR
  96. .RE