npm-fund.1 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. .TH "NPM\-FUND" "1" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-fund\fR \- Retrieve funding information
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm fund [<pkg>]
  9. .fi
  10. .RE
  11. .SS Description
  12. .P
  13. This command retrieves information on how to fund the dependencies of
  14. a given project\. If no package name is provided, it will list all
  15. dependencies that are looking for funding in a tree\-structure in which
  16. are listed the type of funding and the url to visit\. If a package name
  17. is provided then it tries to open its funding url using the \fB\-\-browser\fP
  18. config param; if there are multiple funding sources for the package, the
  19. user will be instructed to pass the \fB\-\-which\fP command to disambiguate\.
  20. .P
  21. The list will avoid duplicated entries and will stack all packages
  22. that share the same type/url as a single entry\. Given this nature the
  23. list is not going to have the same shape of the output from \fBnpm ls\fP\|\.
  24. .SS Configuration
  25. .SS browser
  26. .RS 0
  27. .IP \(bu 2
  28. Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
  29. .IP \(bu 2
  30. Type: String
  31. .RE
  32. .P
  33. The browser that is called by the \fBnpm fund\fP command to open websites\.
  34. .SS json
  35. .RS 0
  36. .IP \(bu 2
  37. Type: Boolean
  38. .IP \(bu 2
  39. Default: false
  40. .RE
  41. .P
  42. Show information in JSON format\.
  43. .SS unicode
  44. .RS 0
  45. .IP \(bu 2
  46. Type: Boolean
  47. .IP \(bu 2
  48. Default: true
  49. .RE
  50. .P
  51. Whether to represent the tree structure using unicode characters\.
  52. Set it to \fBfalse\fP in order to use all\-ansi output\.
  53. .SS which
  54. .RS 0
  55. .IP \(bu 2
  56. Type: Number
  57. .IP \(bu 2
  58. Default: undefined
  59. .RE
  60. .P
  61. If there are multiple funding sources, which 1\-indexed source URL to open\.
  62. .SH See Also
  63. .RS 0
  64. .IP \(bu 2
  65. npm help docs
  66. .IP \(bu 2
  67. npm help config
  68. .IP \(bu 2
  69. npm help install
  70. .IP \(bu 2
  71. npm help ls
  72. .RE