@breautek/storm 9.7.3 → 9.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/docs/assets/hierarchy.js +1 -1
  3. package/docs/assets/highlight.css +5 -5
  4. package/docs/assets/main.js +1 -1
  5. package/docs/assets/style.css +18 -3
  6. package/docs/classes/Application.html +927 -254
  7. package/docs/classes/Command.html +1470 -147
  8. package/docs/classes/ConfigLoader.html +110 -4
  9. package/docs/classes/Database.html +220 -3
  10. package/docs/classes/DatabaseCastObject.html +104 -3
  11. package/docs/classes/DatabaseConnection.html +484 -50
  12. package/docs/classes/DatabaseQueryError.html +264 -13
  13. package/docs/classes/DeadLockError.html +265 -14
  14. package/docs/classes/DiskSpaceError.html +245 -11
  15. package/docs/classes/DropTemporaryTableQuery.html +199 -12
  16. package/docs/classes/DuplicateEntryError.html +247 -11
  17. package/docs/classes/EntityNotFoundError.html +245 -11
  18. package/docs/classes/ExpiredTokenError.html +245 -11
  19. package/docs/classes/ForbiddenError.html +241 -11
  20. package/docs/classes/GetMySQLVersion.html +203 -12
  21. package/docs/classes/Handler.html +283 -3
  22. package/docs/classes/IllegalStateError.html +250 -12
  23. package/docs/classes/InternalError.html +245 -11
  24. package/docs/classes/InvalidCredentialsError.html +245 -11
  25. package/docs/classes/InvalidValueError.html +247 -11
  26. package/docs/classes/LineString.html +112 -3
  27. package/docs/classes/LockWaitTimeoutError.html +265 -14
  28. package/docs/classes/ManagedDatabaseConnection.html +349 -6
  29. package/docs/classes/MetricStore.html +119 -2
  30. package/docs/classes/Middleware.html +122 -3
  31. package/docs/classes/MissingConfigError.html +245 -11
  32. package/docs/classes/MissingParameterError.html +245 -11
  33. package/docs/classes/MySQLConnection.html +509 -54
  34. package/docs/classes/MySQLDatabase.html +235 -3
  35. package/docs/classes/NotImplementedError.html +245 -11
  36. package/docs/classes/Point.html +113 -3
  37. package/docs/classes/Polygon.html +112 -3
  38. package/docs/classes/Query.html +220 -12
  39. package/docs/classes/RawError.html +249 -12
  40. package/docs/classes/RawQuery.html +212 -12
  41. package/docs/classes/Request.html +345 -8
  42. package/docs/classes/Response.html +204 -3
  43. package/docs/classes/ResponseData.html +162 -5
  44. package/docs/classes/ServiceProvider.html +243 -3
  45. package/docs/classes/ServiceResponse.html +108 -3
  46. package/docs/classes/SetSessionVariableQuery.html +199 -12
  47. package/docs/classes/StormError.html +261 -11
  48. package/docs/classes/TemporaryTableQuery.html +203 -12
  49. package/docs/classes/TimeoutError.html +246 -12
  50. package/docs/classes/Token.html +80 -3
  51. package/docs/classes/TokenManager.html +137 -5
  52. package/docs/classes/Transaction.html +163 -4
  53. package/docs/classes/UnauthorizedAccessError.html +245 -11
  54. package/docs/enums/ErrorCode.html +94 -2
  55. package/docs/enums/ExitCode.html +59 -2
  56. package/docs/enums/HTTPMethod.html +69 -2
  57. package/docs/enums/IsolationLevel.html +69 -2
  58. package/docs/enums/JWTError.html +59 -2
  59. package/docs/enums/StatusCode.html +289 -2
  60. package/docs/enums/TransactionAccessLevel.html +64 -3
  61. package/docs/functions/getInstance.html +42 -2
  62. package/docs/hierarchy.html +83 -1
  63. package/docs/index.html +59 -1
  64. package/docs/interfaces/IAdditionalErrorDetails.html +37 -1
  65. package/docs/interfaces/IAuthTokenData.html +65 -2
  66. package/docs/interfaces/ICloudwatchConfig.html +65 -2
  67. package/docs/interfaces/ICloudwatchCredentials.html +60 -2
  68. package/docs/interfaces/ICloudwatchStreamConfig.html +60 -2
  69. package/docs/interfaces/IConfig.html +114 -3
  70. package/docs/interfaces/IDatabaseConfig.html +84 -2
  71. package/docs/interfaces/IDatabaseConnection.html +270 -5
  72. package/docs/interfaces/IDatabasePosition.html +65 -3
  73. package/docs/interfaces/IErrorResponse.html +75 -2
  74. package/docs/interfaces/IFormData.html +60 -2
  75. package/docs/interfaces/IGetMySQLVersionResult.html +70 -2
  76. package/docs/interfaces/IGetMySQLVersionRow.html +55 -2
  77. package/docs/interfaces/IHistogramConfig.html +79 -2
  78. package/docs/interfaces/IInsertQueryResult.html +65 -2
  79. package/docs/interfaces/IJWTVerifyOptions.html +55 -2
  80. package/docs/interfaces/IMetricConfig.html +71 -2
  81. package/docs/interfaces/IMetricCounter.html +74 -2
  82. package/docs/interfaces/IMetricGauge.html +122 -2
  83. package/docs/interfaces/IMetricHistogram.html +87 -2
  84. package/docs/interfaces/IOKPacket.html +95 -3
  85. package/docs/interfaces/IParameterMap.html +37 -1
  86. package/docs/interfaces/IQueryable.html +134 -2
  87. package/docs/interfaces/IRequestResponse.html +65 -2
  88. package/docs/interfaces/ISetSessionVariableQueryInput.html +60 -2
  89. package/docs/interfaces/IStormCLIArgs.html +85 -2
  90. package/docs/interfaces/ITemporaryTableQueryInput.html +60 -2
  91. package/docs/interfaces/IUpdateQueryResult.html +60 -2
  92. package/docs/interfaces/formidable.EmitData.html +71 -2
  93. package/docs/interfaces/formidable.EventData.html +86 -2
  94. package/docs/interfaces/formidable.File.html +138 -12
  95. package/docs/interfaces/formidable.FileJSON.html +120 -9
  96. package/docs/interfaces/formidable.Options.html +226 -32
  97. package/docs/interfaces/formidable.Part.html +534 -64
  98. package/docs/modules/formidable.html +41 -1
  99. package/docs/types/IDeleteQueryResult.html +33 -1
  100. package/docs/types/IStoredProcedureResult.html +44 -3
  101. package/docs/types/TCoordinate.html +33 -1
  102. package/docs/types/TExpiresIn.html +33 -1
  103. package/docs/types/TSerializableResponse.html +41 -4
  104. package/docs/types/TSupportedResponsePrimitives.html +33 -1
  105. package/docs/types/TSupportedResponseTypes.html +33 -1
  106. package/docs/types/formidable.BufferEncoding.html +34 -1
  107. package/docs/types/formidable.DefaultOptions.html +34 -1
  108. package/docs/types/formidable.EnabledPlugins.html +34 -1
  109. package/docs/types/formidable.EventNames.html +64 -8
  110. package/docs/types/formidable.Fields.html +38 -1
  111. package/docs/types/formidable.Files.html +38 -1
  112. package/docs/types/formidable.FormidableError.html +34 -1
  113. package/docs/types/formidable.MappedParsers.html +34 -1
  114. package/docs/types/formidable.Plugin.html +34 -1
  115. package/docs/types/formidable.PluginFunction.html +47 -1
  116. package/docs/types/formidable.Plugins.html +34 -1
  117. package/docs/variables/formidable.html +81 -1
  118. package/lib/Application.js +1 -0
  119. package/lib/Application.js.map +1 -1
  120. package/lib/MySQLConnection.js +2 -2
  121. package/package.json +11 -11
  122. package/pnpm-workspace.yaml +3 -1
  123. package/src/Application.ts +1 -0
  124. package/src/MySQLConnection.ts +2 -2
package/docs/classes/Command.html CHANGED
@@ -1,11 +1,38 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Command | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@breautek/storm</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">Command</a></li></ul><h1>Class Command</h1></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:376</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
2
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#args" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>args</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Command | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@breautek/storm</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">Command</a></li></ul>
12
+ <h1>Class Command</h1></div><aside class="tsd-sources">
13
+ <ul>
14
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:376</li></ul></aside>
15
+ <section class="tsd-panel-group tsd-index-group">
16
+ <section class="tsd-panel tsd-index-panel">
17
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
18
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
19
+ <div class="tsd-accordion-details">
20
+ <section class="tsd-index-section">
21
+ <h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
22
+ <div class="tsd-index-list"><a href="#constructor" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
23
+ </div></section>
24
+ <section class="tsd-index-section">
25
+ <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
26
+ <div class="tsd-index-list"><a href="#args" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>args</span></a>
3
27
  <a href="#commands" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commands</span></a>
4
28
  <a href="#options" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
5
29
  <a href="#parent" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a>
6
30
  <a href="#processedargs" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>processed<wbr/>Args</span></a>
7
31
  <a href="#registeredarguments" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>registered<wbr/>Arguments</span></a>
8
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#action" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action</span></a>
32
+ </div></section>
33
+ <section class="tsd-index-section">
34
+ <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
35
+ <div class="tsd-index-list"><a href="#action" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action</span></a>
9
36
  <a href="#addargument" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Argument</span></a>
10
37
  <a href="#addcommand" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Command</span></a>
11
38
  <a href="#addhelpcommand" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Command</span></a>
@@ -65,192 +92,1170 @@
65
92
  <a href="#summary" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>summary</span></a>
66
93
  <a href="#usage" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>usage</span></a>
67
94
  <a href="#version" class="tsd-index-link tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>version</span></a>
68
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="constructorcommand"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#constructorcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:384</li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="args"><span>args</span><a href="#args" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:377</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="commands"><code class="tsd-tag">Readonly</code><span>commands</span><a href="#commands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">commands</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:379</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="options"><code class="tsd-tag">Readonly</code><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:380</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="parent"><span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:382</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="processedargs"><span>processed<wbr/>Args</span><a href="#processedargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">processedArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:378</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="registeredarguments"><code class="tsd-tag">Readonly</code><span>registered<wbr/>Arguments</span><a href="#registeredarguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">registeredArguments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Argument</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:381</li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="action"><span>action</span><a href="#action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="action-1"><span class="tsd-kind-call-signature">action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#action-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register callback <code>fn</code> for the command.</p>
69
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
70
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;serve&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">description</span><span class="hl-3">(</span><span class="hl-1">&#39;start service&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">action</span><span class="hl-3">(</span><span class="hl-0">function</span><span class="hl-3">() {</span><br/><span class="hl-3"> </span><span class="hl-8">// do work here</span><br/><span class="hl-3"> });</span>
95
+ </div></section></div></details></section></section>
96
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
97
+ <h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
98
+ <section>
99
+ <section class="tsd-panel tsd-member tsd-is-external">
100
+ <h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
101
+ <ul class="tsd-signatures tsd-is-external">
102
+ <li class="tsd-is-external">
103
+ <div class="tsd-signature tsd-anchor-link" id="constructorcommand"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#constructorcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
104
+ <div class="tsd-description">
105
+ <div class="tsd-parameters">
106
+ <h4 class="tsd-parameters-title">Parameters</h4>
107
+ <ul class="tsd-parameter-list">
108
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
109
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources">
110
+ <ul>
111
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:384</li></ul></aside></div></li></ul></section></section></details>
112
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
113
+ <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
114
+ <section>
115
+ <section class="tsd-panel tsd-member tsd-is-external">
116
+ <h3 class="tsd-anchor-link" id="args"><span>args</span><a href="#args" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
117
+ <div class="tsd-signature"><span class="tsd-kind-property">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:377</li></ul></aside></section>
120
+ <section class="tsd-panel tsd-member tsd-is-external">
121
+ <h3 class="tsd-anchor-link" id="commands"><code class="tsd-tag">Readonly</code><span>commands</span><a href="#commands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
122
+ <div class="tsd-signature"><span class="tsd-kind-property">commands</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
123
+ <ul>
124
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:379</li></ul></aside></section>
125
+ <section class="tsd-panel tsd-member tsd-is-external">
126
+ <h3 class="tsd-anchor-link" id="options"><code class="tsd-tag">Readonly</code><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
127
+ <div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
128
+ <ul>
129
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:380</li></ul></aside></section>
130
+ <section class="tsd-panel tsd-member tsd-is-external">
131
+ <h3 class="tsd-anchor-link" id="parent"><span>parent</span><a href="#parent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
132
+ <div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a></div><aside class="tsd-sources">
133
+ <ul>
134
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:382</li></ul></aside></section>
135
+ <section class="tsd-panel tsd-member tsd-is-external">
136
+ <h3 class="tsd-anchor-link" id="processedargs"><span>processed<wbr/>Args</span><a href="#processedargs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
137
+ <div class="tsd-signature"><span class="tsd-kind-property">processedArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
138
+ <ul>
139
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:378</li></ul></aside></section>
140
+ <section class="tsd-panel tsd-member tsd-is-external">
141
+ <h3 class="tsd-anchor-link" id="registeredarguments"><code class="tsd-tag">Readonly</code><span>registered<wbr/>Arguments</span><a href="#registeredarguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
142
+ <div class="tsd-signature"><span class="tsd-kind-property">registeredArguments</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">Argument</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
143
+ <ul>
144
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:381</li></ul></aside></section></section></details>
145
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
146
+ <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
147
+ <section>
148
+ <section class="tsd-panel tsd-member tsd-is-external">
149
+ <h3 class="tsd-anchor-link" id="action"><span>action</span><a href="#action" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
150
+ <ul class="tsd-signatures tsd-is-external">
151
+ <li class="tsd-is-external">
152
+ <div class="tsd-signature tsd-anchor-link" id="action-1"><span class="tsd-kind-call-signature">action</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#action-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
153
+ <div class="tsd-description">
154
+ <div class="tsd-comment tsd-typography"><p>Register callback <code>fn</code> for the command.</p>
155
+ </div>
156
+ <div class="tsd-parameters">
157
+ <h4 class="tsd-parameters-title">Parameters</h4>
158
+ <ul class="tsd-parameter-list">
159
+ <li><span><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">this</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div>
160
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
161
+
162
+ <div class="tsd-comment tsd-typography">
163
+ <div class="tsd-tag-example">
164
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;serve&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">description</span><span class="hl-3">(</span><span class="hl-1">&#39;start service&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">action</span><span class="hl-3">(</span><span class="hl-0">function</span><span class="hl-3">() {</span><br/><span class="hl-3"> </span><span class="hl-8">// do work here</span><br/><span class="hl-3"> });</span>
71
165
  </code><button>Copy</button></pre>
72
166
 
73
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:626</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addargument"><span>add<wbr/>Argument</span><a href="#addargument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addargument-1"><span class="tsd-kind-call-signature">addArgument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Argument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addargument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define argument syntax for command, adding a prepared argument.</p>
74
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">arg</span>: <span class="tsd-signature-type">Argument</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
75
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:500</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addcommand"><span>add<wbr/>Command</span><a href="#addcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addcommand-1"><span class="tsd-kind-call-signature">addCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cmd</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommandOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a prepared subcommand.</p>
167
+ </div></div><aside class="tsd-sources">
168
+ <ul>
169
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:626</li></ul></aside></div></li></ul></section>
170
+ <section class="tsd-panel tsd-member tsd-is-external">
171
+ <h3 class="tsd-anchor-link" id="addargument"><span>add<wbr/>Argument</span><a href="#addargument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
172
+ <ul class="tsd-signatures tsd-is-external">
173
+ <li class="tsd-is-external">
174
+ <div class="tsd-signature tsd-anchor-link" id="addargument-1"><span class="tsd-kind-call-signature">addArgument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">arg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Argument</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addargument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
175
+ <div class="tsd-description">
176
+ <div class="tsd-comment tsd-typography"><p>Define argument syntax for command, adding a prepared argument.</p>
177
+ </div>
178
+ <div class="tsd-parameters">
179
+ <h4 class="tsd-parameters-title">Parameters</h4>
180
+ <ul class="tsd-parameter-list">
181
+ <li><span><span class="tsd-kind-parameter">arg</span>: <span class="tsd-signature-type">Argument</span></span></li></ul></div>
182
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
183
+ <aside class="tsd-sources">
184
+ <ul>
185
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:500</li></ul></aside></div></li></ul></section>
186
+ <section class="tsd-panel tsd-member tsd-is-external">
187
+ <h3 class="tsd-anchor-link" id="addcommand"><span>add<wbr/>Command</span><a href="#addcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
188
+ <ul class="tsd-signatures tsd-is-external">
189
+ <li class="tsd-is-external">
190
+ <div class="tsd-signature tsd-anchor-link" id="addcommand-1"><span class="tsd-kind-call-signature">addCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cmd</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommandOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
191
+ <div class="tsd-description">
192
+ <div class="tsd-comment tsd-typography"><p>Add a prepared subcommand.</p>
76
193
  <p>See .command() for creating an attached subcommand which inherits settings from its parent.</p>
77
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cmd</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">CommandOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
78
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:463</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addhelpcommand"><span>add<wbr/>Help<wbr/>Command</span><a href="#addhelpcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelpcommand-1"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cmd</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add prepared custom help command.</p>
79
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cmd</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:533</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelpcommand-2"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v12, instead use helpCommand</p>
80
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:535</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelpcommand-3"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v12, instead use helpCommand</p>
81
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:537</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addhelpoption"><span>add<wbr/>Help<wbr/>Option</span><a href="#addhelpoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelpoption-1"><span class="tsd-kind-call-signature">addHelpOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Supply your own option to use for the built-in help option.
194
+ </div>
195
+ <div class="tsd-parameters">
196
+ <h4 class="tsd-parameters-title">Parameters</h4>
197
+ <ul class="tsd-parameter-list">
198
+ <li><span><span class="tsd-kind-parameter">cmd</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li>
199
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">CommandOptions</span></span></li></ul></div>
200
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
201
+ <aside class="tsd-sources">
202
+ <ul>
203
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:463</li></ul></aside></div></li></ul></section>
204
+ <section class="tsd-panel tsd-member tsd-is-external">
205
+ <h3 class="tsd-anchor-link" id="addhelpcommand"><span>add<wbr/>Help<wbr/>Command</span><a href="#addhelpcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
206
+ <ul class="tsd-signatures tsd-is-external">
207
+ <li class="tsd-is-external">
208
+ <div class="tsd-signature tsd-anchor-link" id="addhelpcommand-1"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cmd</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
209
+ <div class="tsd-description">
210
+ <div class="tsd-comment tsd-typography"><p>Add prepared custom help command.</p>
211
+ </div>
212
+ <div class="tsd-parameters">
213
+ <h4 class="tsd-parameters-title">Parameters</h4>
214
+ <ul class="tsd-parameter-list">
215
+ <li><span><span class="tsd-kind-parameter">cmd</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div>
216
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
217
+ <ul>
218
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:533</li></ul></aside></div></li>
219
+ <li class="tsd-is-external">
220
+ <div class="tsd-signature tsd-anchor-link" id="addhelpcommand-2"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
221
+ <div class="tsd-description">
222
+ <div class="tsd-parameters">
223
+ <h4 class="tsd-parameters-title">Parameters</h4>
224
+ <ul class="tsd-parameter-list">
225
+ <li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span></li>
226
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
227
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
228
+ <div class="tsd-comment tsd-typography">
229
+ <div class="tsd-tag-deprecated">
230
+ <h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v12, instead use helpCommand</p>
231
+ </div></div><aside class="tsd-sources">
232
+ <ul>
233
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:535</li></ul></aside></div></li>
234
+ <li class="tsd-is-external">
235
+ <div class="tsd-signature tsd-anchor-link" id="addhelpcommand-3"><span class="tsd-kind-call-signature">addHelpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpcommand-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
236
+ <div class="tsd-description">
237
+ <div class="tsd-parameters">
238
+ <h4 class="tsd-parameters-title">Parameters</h4>
239
+ <ul class="tsd-parameter-list">
240
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
241
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
242
+ <div class="tsd-comment tsd-typography">
243
+ <div class="tsd-tag-deprecated">
244
+ <h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v12, instead use helpCommand</p>
245
+ </div></div><aside class="tsd-sources">
246
+ <ul>
247
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:537</li></ul></aside></div></li></ul></section>
248
+ <section class="tsd-panel tsd-member tsd-is-external">
249
+ <h3 class="tsd-anchor-link" id="addhelpoption"><span>add<wbr/>Help<wbr/>Option</span><a href="#addhelpoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
250
+ <ul class="tsd-signatures tsd-is-external">
251
+ <li class="tsd-is-external">
252
+ <div class="tsd-signature tsd-anchor-link" id="addhelpoption-1"><span class="tsd-kind-call-signature">addHelpOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelpoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
253
+ <div class="tsd-description">
254
+ <div class="tsd-comment tsd-typography"><p>Supply your own option to use for the built-in help option.
82
255
  This is an alternative to using helpOption() to customise the flags and description etc.</p>
83
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">option</span>: <span class="tsd-signature-type">Option</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1065</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addhelptext"><span>add<wbr/>Help<wbr/>Text</span><a href="#addhelptext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelptext-1"><span class="tsd-kind-call-signature">addHelpText</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextPosition</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelptext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add additional text to be displayed with the built-in help.</p>
256
+ </div>
257
+ <div class="tsd-parameters">
258
+ <h4 class="tsd-parameters-title">Parameters</h4>
259
+ <ul class="tsd-parameter-list">
260
+ <li><span><span class="tsd-kind-parameter">option</span>: <span class="tsd-signature-type">Option</span></span></li></ul></div>
261
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
262
+ <ul>
263
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1065</li></ul></aside></div></li></ul></section>
264
+ <section class="tsd-panel tsd-member tsd-is-external">
265
+ <h3 class="tsd-anchor-link" id="addhelptext"><span>add<wbr/>Help<wbr/>Text</span><a href="#addhelptext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
266
+ <ul class="tsd-signatures tsd-is-external">
267
+ <li class="tsd-is-external">
268
+ <div class="tsd-signature tsd-anchor-link" id="addhelptext-1"><span class="tsd-kind-call-signature">addHelpText</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextPosition</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelptext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
269
+ <div class="tsd-description">
270
+ <div class="tsd-comment tsd-typography"><p>Add additional text to be displayed with the built-in help.</p>
84
271
  <p>Position is 'before' or 'after' to affect just this command,
85
272
  and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.</p>
86
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">position</span>: <span class="tsd-signature-type">AddHelpTextPosition</span></span></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1082</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addhelptext-2"><span class="tsd-kind-call-signature">addHelpText</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextPosition</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextContext</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelptext-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add additional text to be displayed with the built-in help.</p>
273
+ </div>
274
+ <div class="tsd-parameters">
275
+ <h4 class="tsd-parameters-title">Parameters</h4>
276
+ <ul class="tsd-parameter-list">
277
+ <li><span><span class="tsd-kind-parameter">position</span>: <span class="tsd-signature-type">AddHelpTextPosition</span></span></li>
278
+ <li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
279
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
280
+ <ul>
281
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1082</li></ul></aside></div></li>
282
+ <li class="tsd-is-external">
283
+ <div class="tsd-signature tsd-anchor-link" id="addhelptext-2"><span class="tsd-kind-call-signature">addHelpText</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextPosition</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextContext</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addhelptext-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
284
+ <div class="tsd-description">
285
+ <div class="tsd-comment tsd-typography"><p>Add additional text to be displayed with the built-in help.</p>
87
286
  <p>Position is 'before' or 'after' to affect just this command,
88
287
  and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.</p>
89
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">position</span>: <span class="tsd-signature-type">AddHelpTextPosition</span></span></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextContext</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1083</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="addoption"><span>add<wbr/>Option</span><a href="#addoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addoption-1"><span class="tsd-kind-call-signature">addOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a prepared Option.</p>
288
+ </div>
289
+ <div class="tsd-parameters">
290
+ <h4 class="tsd-parameters-title">Parameters</h4>
291
+ <ul class="tsd-parameter-list">
292
+ <li><span><span class="tsd-kind-parameter">position</span>: <span class="tsd-signature-type">AddHelpTextPosition</span></span></li>
293
+ <li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AddHelpTextContext</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div>
294
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
295
+ <ul>
296
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1083</li></ul></aside></div></li></ul></section>
297
+ <section class="tsd-panel tsd-member tsd-is-external">
298
+ <h3 class="tsd-anchor-link" id="addoption"><span>add<wbr/>Option</span><a href="#addoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
299
+ <ul class="tsd-signatures tsd-is-external">
300
+ <li class="tsd-is-external">
301
+ <div class="tsd-signature tsd-anchor-link" id="addoption-1"><span class="tsd-kind-call-signature">addOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">option</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#addoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
302
+ <div class="tsd-description">
303
+ <div class="tsd-comment tsd-typography"><p>Add a prepared Option.</p>
90
304
  <p>See .option() and .requiredOption() for creating and attaching an option in a single call.</p>
91
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">option</span>: <span class="tsd-signature-type">Option</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:706</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="alias"><span>alias</span><a href="#alias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="alias-1"><span class="tsd-kind-call-signature">alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">alias</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#alias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set an alias for the command.</p>
305
+ </div>
306
+ <div class="tsd-parameters">
307
+ <h4 class="tsd-parameters-title">Parameters</h4>
308
+ <ul class="tsd-parameter-list">
309
+ <li><span><span class="tsd-kind-parameter">option</span>: <span class="tsd-signature-type">Option</span></span></li></ul></div>
310
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
311
+ <ul>
312
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:706</li></ul></aside></div></li></ul></section>
313
+ <section class="tsd-panel tsd-member tsd-is-external">
314
+ <h3 class="tsd-anchor-link" id="alias"><span>alias</span><a href="#alias" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
315
+ <ul class="tsd-signatures tsd-is-external">
316
+ <li class="tsd-is-external">
317
+ <div class="tsd-signature tsd-anchor-link" id="alias-1"><span class="tsd-kind-call-signature">alias</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">alias</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#alias-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
318
+ <div class="tsd-description">
319
+ <div class="tsd-comment tsd-typography"><p>Set an alias for the command.</p>
92
320
  <p>You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help.</p>
93
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">alias</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
94
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:918</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="alias-2"><span class="tsd-kind-call-signature">alias</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#alias-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get alias for the command.</p>
95
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:922</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="aliases"><span>aliases</span><a href="#aliases" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="aliases-1"><span class="tsd-kind-call-signature">aliases</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#aliases-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set aliases for the command.</p>
321
+ </div>
322
+ <div class="tsd-parameters">
323
+ <h4 class="tsd-parameters-title">Parameters</h4>
324
+ <ul class="tsd-parameter-list">
325
+ <li><span><span class="tsd-kind-parameter">alias</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
326
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
327
+ <aside class="tsd-sources">
328
+ <ul>
329
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:918</li></ul></aside></div></li>
330
+ <li class="tsd-is-external">
331
+ <div class="tsd-signature tsd-anchor-link" id="alias-2"><span class="tsd-kind-call-signature">alias</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#alias-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
332
+ <div class="tsd-description">
333
+ <div class="tsd-comment tsd-typography"><p>Get alias for the command.</p>
334
+ </div>
335
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
336
+ <ul>
337
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:922</li></ul></aside></div></li></ul></section>
338
+ <section class="tsd-panel tsd-member tsd-is-external">
339
+ <h3 class="tsd-anchor-link" id="aliases"><span>aliases</span><a href="#aliases" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
340
+ <ul class="tsd-signatures tsd-is-external">
341
+ <li class="tsd-is-external">
342
+ <div class="tsd-signature tsd-anchor-link" id="aliases-1"><span class="tsd-kind-call-signature">aliases</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">aliases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#aliases-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
343
+ <div class="tsd-description">
344
+ <div class="tsd-comment tsd-typography"><p>Set aliases for the command.</p>
96
345
  <p>Only the first alias is shown in the auto-generated help.</p>
97
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">aliases</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
98
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:931</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="aliases-2"><span class="tsd-kind-call-signature">aliases</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#aliases-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get aliases for the command.</p>
99
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:935</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="allowexcessarguments"><span>allow<wbr/>Excess<wbr/>Arguments</span><a href="#allowexcessarguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="allowexcessarguments-1"><span class="tsd-kind-call-signature">allowExcessArguments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowExcess</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#allowexcessarguments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allow excess command-arguments on the command line. Pass false to make excess arguments an error.</p>
100
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allowExcess</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
101
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:775</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="allowunknownoption"><span>allow<wbr/>Unknown<wbr/>Option</span><a href="#allowunknownoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="allowunknownoption-1"><span class="tsd-kind-call-signature">allowUnknownOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowUnknown</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#allowunknownoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allow unknown options on the command line.</p>
102
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allowUnknown</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
103
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:768</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="argument"><span>argument</span><a href="#argument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="argument-1"><span class="tsd-kind-call-signature">argument</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#argument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define argument syntax for command.</p>
346
+ </div>
347
+ <div class="tsd-parameters">
348
+ <h4 class="tsd-parameters-title">Parameters</h4>
349
+ <ul class="tsd-parameter-list">
350
+ <li><span><span class="tsd-kind-parameter">aliases</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
351
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
352
+ <aside class="tsd-sources">
353
+ <ul>
354
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:931</li></ul></aside></div></li>
355
+ <li class="tsd-is-external">
356
+ <div class="tsd-signature tsd-anchor-link" id="aliases-2"><span class="tsd-kind-call-signature">aliases</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#aliases-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
357
+ <div class="tsd-description">
358
+ <div class="tsd-comment tsd-typography"><p>Get aliases for the command.</p>
359
+ </div>
360
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
361
+ <ul>
362
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:935</li></ul></aside></div></li></ul></section>
363
+ <section class="tsd-panel tsd-member tsd-is-external">
364
+ <h3 class="tsd-anchor-link" id="allowexcessarguments"><span>allow<wbr/>Excess<wbr/>Arguments</span><a href="#allowexcessarguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
365
+ <ul class="tsd-signatures tsd-is-external">
366
+ <li class="tsd-is-external">
367
+ <div class="tsd-signature tsd-anchor-link" id="allowexcessarguments-1"><span class="tsd-kind-call-signature">allowExcessArguments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowExcess</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#allowexcessarguments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
368
+ <div class="tsd-description">
369
+ <div class="tsd-comment tsd-typography"><p>Allow excess command-arguments on the command line. Pass false to make excess arguments an error.</p>
370
+ </div>
371
+ <div class="tsd-parameters">
372
+ <h4 class="tsd-parameters-title">Parameters</h4>
373
+ <ul class="tsd-parameter-list">
374
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allowExcess</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
375
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
376
+ <aside class="tsd-sources">
377
+ <ul>
378
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:775</li></ul></aside></div></li></ul></section>
379
+ <section class="tsd-panel tsd-member tsd-is-external">
380
+ <h3 class="tsd-anchor-link" id="allowunknownoption"><span>allow<wbr/>Unknown<wbr/>Option</span><a href="#allowunknownoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
381
+ <ul class="tsd-signatures tsd-is-external">
382
+ <li class="tsd-is-external">
383
+ <div class="tsd-signature tsd-anchor-link" id="allowunknownoption-1"><span class="tsd-kind-call-signature">allowUnknownOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowUnknown</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#allowunknownoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
384
+ <div class="tsd-description">
385
+ <div class="tsd-comment tsd-typography"><p>Allow unknown options on the command line.</p>
386
+ </div>
387
+ <div class="tsd-parameters">
388
+ <h4 class="tsd-parameters-title">Parameters</h4>
389
+ <ul class="tsd-parameter-list">
390
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allowUnknown</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
391
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
392
+ <aside class="tsd-sources">
393
+ <ul>
394
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:768</li></ul></aside></div></li></ul></section>
395
+ <section class="tsd-panel tsd-member tsd-is-external">
396
+ <h3 class="tsd-anchor-link" id="argument"><span>argument</span><a href="#argument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
397
+ <ul class="tsd-signatures tsd-is-external">
398
+ <li class="tsd-is-external">
399
+ <div class="tsd-signature tsd-anchor-link" id="argument-1"><span class="tsd-kind-call-signature">argument</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#argument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
400
+ <div class="tsd-description">
401
+ <div class="tsd-comment tsd-typography"><p>Define argument syntax for command.</p>
104
402
  <p>The default is that the argument is required, and you can explicitly
105
403
  indicate this with &lt;&gt; around the name. Put [] around the name for an optional argument.</p>
106
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="argumentt"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
107
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;input-file&gt;&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;[output-file]&#39;</span><span class="hl-3">);</span>
404
+ </div>
405
+ <section class="tsd-panel">
406
+ <h4>Type Parameters</h4>
407
+ <ul class="tsd-type-parameter-list">
408
+ <li><span id="argumentt"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section>
409
+ <div class="tsd-parameters">
410
+ <h4 class="tsd-parameters-title">Parameters</h4>
411
+ <ul class="tsd-parameter-list">
412
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
413
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
414
+ <li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a></span></li>
415
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#argumentt">T</a></span></li></ul></div>
416
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
417
+
418
+ <div class="tsd-comment tsd-typography">
419
+ <div class="tsd-tag-example">
420
+ <h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;input-file&gt;&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;[output-file]&#39;</span><span class="hl-3">);</span>
108
421
  </code><button>Copy</button></pre>
109
422
 
110
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:487</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="argument-2"><span class="tsd-kind-call-signature">argument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#argument-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define argument syntax for command.</p>
423
+ </div></div><aside class="tsd-sources">
424
+ <ul>
425
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:487</li></ul></aside></div></li>
426
+ <li class="tsd-is-external">
427
+ <div class="tsd-signature tsd-anchor-link" id="argument-2"><span class="tsd-kind-call-signature">argument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#argument-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
428
+ <div class="tsd-description">
429
+ <div class="tsd-comment tsd-typography"><p>Define argument syntax for command.</p>
111
430
  <p>The default is that the argument is required, and you can explicitly
112
431
  indicate this with &lt;&gt; around the name. Put [] around the name for an optional argument.</p>
113
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
114
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;input-file&gt;&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;[output-file]&#39;</span><span class="hl-3">);</span>
432
+ </div>
433
+ <div class="tsd-parameters">
434
+ <h4 class="tsd-parameters-title">Parameters</h4>
435
+ <ul class="tsd-parameter-list">
436
+ <li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li>
437
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
438
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div>
439
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
440
+
441
+ <div class="tsd-comment tsd-typography">
442
+ <div class="tsd-tag-example">
443
+ <h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;input-file&gt;&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">argument</span><span class="hl-3">(</span><span class="hl-1">&#39;[output-file]&#39;</span><span class="hl-3">);</span>
115
444
  </code><button>Copy</button></pre>
116
445
 
117
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:493</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="arguments"><span>arguments</span><a href="#arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="arguments-1"><span class="tsd-kind-call-signature">arguments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">names</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#arguments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define argument syntax for command, adding multiple at once (without descriptions).</p>
446
+ </div></div><aside class="tsd-sources">
447
+ <ul>
448
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:493</li></ul></aside></div></li></ul></section>
449
+ <section class="tsd-panel tsd-member tsd-is-external">
450
+ <h3 class="tsd-anchor-link" id="arguments"><span>arguments</span><a href="#arguments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
451
+ <ul class="tsd-signatures tsd-is-external">
452
+ <li class="tsd-is-external">
453
+ <div class="tsd-signature tsd-anchor-link" id="arguments-1"><span class="tsd-kind-call-signature">arguments</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">names</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#arguments-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
454
+ <div class="tsd-description">
455
+ <div class="tsd-comment tsd-typography"><p>Define argument syntax for command, adding multiple at once (without descriptions).</p>
118
456
  <p>See also .argument().</p>
119
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">names</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
120
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">arguments</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;cmd&gt; [env]&#39;</span><span class="hl-3">);</span>
457
+ </div>
458
+ <div class="tsd-parameters">
459
+ <h4 class="tsd-parameters-title">Parameters</h4>
460
+ <ul class="tsd-parameter-list">
461
+ <li><span><span class="tsd-kind-parameter">names</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
462
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
463
+
464
+ <div class="tsd-comment tsd-typography">
465
+ <div class="tsd-tag-example">
466
+ <h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">arguments</span><span class="hl-3">(</span><span class="hl-1">&#39;&lt;cmd&gt; [env]&#39;</span><span class="hl-3">);</span>
121
467
  </code><button>Copy</button></pre>
122
468
 
123
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:514</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="combineflagandoptionalvalue"><span>combine<wbr/>Flag<wbr/>And<wbr/>Optional<wbr/>Value</span><a href="#combineflagandoptionalvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="combineflagandoptionalvalue-1"><span class="tsd-kind-call-signature">combineFlagAndOptionalValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">combine</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#combineflagandoptionalvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Alter parsing of short flags with optional values.</p>
124
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">combine</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
125
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-8">// for `.option(&#39;-f,--flag [value]&#39;):</span><br/><span class="hl-3">.</span><span class="hl-5">combineFlagAndOptionalValue</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">) </span><span class="hl-8">// `-f80` is treated like `--flag=80`, this is the default behaviour</span><br/><span class="hl-3">.</span><span class="hl-5">combineFlagAndOptionalValue</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">) </span><span class="hl-8">// `-fb` is treated like `-f -b`</span>
469
+ </div></div><aside class="tsd-sources">
470
+ <ul>
471
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:514</li></ul></aside></div></li></ul></section>
472
+ <section class="tsd-panel tsd-member tsd-is-external">
473
+ <h3 class="tsd-anchor-link" id="combineflagandoptionalvalue"><span>combine<wbr/>Flag<wbr/>And<wbr/>Optional<wbr/>Value</span><a href="#combineflagandoptionalvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
474
+ <ul class="tsd-signatures tsd-is-external">
475
+ <li class="tsd-is-external">
476
+ <div class="tsd-signature tsd-anchor-link" id="combineflagandoptionalvalue-1"><span class="tsd-kind-call-signature">combineFlagAndOptionalValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">combine</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#combineflagandoptionalvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
477
+ <div class="tsd-description">
478
+ <div class="tsd-comment tsd-typography"><p>Alter parsing of short flags with optional values.</p>
479
+ </div>
480
+ <div class="tsd-parameters">
481
+ <h4 class="tsd-parameters-title">Parameters</h4>
482
+ <ul class="tsd-parameter-list">
483
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">combine</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
484
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
485
+
486
+ <div class="tsd-comment tsd-typography">
487
+ <div class="tsd-tag-example">
488
+ <h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-8">// for `.option(&#39;-f,--flag [value]&#39;):</span><br/><span class="hl-3">.</span><span class="hl-5">combineFlagAndOptionalValue</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">) </span><span class="hl-8">// `-f80` is treated like `--flag=80`, this is the default behaviour</span><br/><span class="hl-3">.</span><span class="hl-5">combineFlagAndOptionalValue</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">) </span><span class="hl-8">// `-fb` is treated like `-f -b`</span>
126
489
  </code><button>Copy</button></pre>
127
490
 
128
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:761</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="command"><span>command</span><a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="command-1"><span class="tsd-kind-call-signature">command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommandOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#command-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define a command, implemented using an action handler.</p>
129
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>command name and arguments, args are <code>&lt;required&gt;</code> or <code>[optional]</code> and last may also be <code>variadic...</code></p>
130
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">CommandOptions</span></span><div class="tsd-comment tsd-typography"><p>configuration options</p>
131
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><p>new command</p>
132
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The command description is supplied using <code>.description</code>, not as a parameter to <code>.command</code>.</p>
133
- </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;clone &lt;source&gt; [destination]&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">description</span><span class="hl-3">(</span><span class="hl-1">&#39;clone a repository into a newly created directory&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">action</span><span class="hl-3">((</span><span class="hl-4">source</span><span class="hl-3">, </span><span class="hl-4">destination</span><span class="hl-3">) </span><span class="hl-0">=&gt;</span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">&#39;clone command called&#39;</span><span class="hl-3">);</span><br/><span class="hl-3"> });</span>
491
+ </div></div><aside class="tsd-sources">
492
+ <ul>
493
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:761</li></ul></aside></div></li></ul></section>
494
+ <section class="tsd-panel tsd-member tsd-is-external">
495
+ <h3 class="tsd-anchor-link" id="command"><span>command</span><a href="#command" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
496
+ <ul class="tsd-signatures tsd-is-external">
497
+ <li class="tsd-is-external">
498
+ <div class="tsd-signature tsd-anchor-link" id="command-1"><span class="tsd-kind-call-signature">command</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CommandOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#command-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
499
+ <div class="tsd-description">
500
+ <div class="tsd-comment tsd-typography"><p>Define a command, implemented using an action handler.</p>
501
+ </div>
502
+ <div class="tsd-parameters">
503
+ <h4 class="tsd-parameters-title">Parameters</h4>
504
+ <ul class="tsd-parameter-list">
505
+ <li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span>
506
+ <div class="tsd-comment tsd-typography"><p>command name and arguments, args are <code>&lt;required&gt;</code> or <code>[optional]</code> and last may also be <code>variadic...</code></p>
507
+ </div></li>
508
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">CommandOptions</span></span>
509
+ <div class="tsd-comment tsd-typography"><p>configuration options</p>
510
+ </div></li></ul></div>
511
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><p>new command</p>
512
+
513
+ <div class="tsd-comment tsd-typography">
514
+ <div class="tsd-tag-remarks">
515
+ <h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The command description is supplied using <code>.description</code>, not as a parameter to <code>.command</code>.</p>
516
+ </div>
517
+ <div class="tsd-tag-example">
518
+ <h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;clone &lt;source&gt; [destination]&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">description</span><span class="hl-3">(</span><span class="hl-1">&#39;clone a repository into a newly created directory&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">action</span><span class="hl-3">((</span><span class="hl-4">source</span><span class="hl-3">, </span><span class="hl-4">destination</span><span class="hl-3">) </span><span class="hl-0">=&gt;</span><span class="hl-3"> {</span><br/><span class="hl-3"> </span><span class="hl-4">console</span><span class="hl-3">.</span><span class="hl-5">log</span><span class="hl-3">(</span><span class="hl-1">&#39;clone command called&#39;</span><span class="hl-3">);</span><br/><span class="hl-3"> });</span>
134
519
  </code><button type="button">Copy</button></pre>
135
520
 
136
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:420</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="command-2"><span class="tsd-kind-call-signature">command</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ExecutableCommandOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#command-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define a command, implemented in a separate executable file.</p>
137
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>command name and arguments, args are <code>&lt;required&gt;</code> or <code>[optional]</code> and last may also be <code>variadic...</code></p>
138
- </div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>description of executable command</p>
139
- </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">ExecutableCommandOptions</span></span><div class="tsd-comment tsd-typography"><p>configuration options</p>
140
- </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
141
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The command description is supplied as the second parameter to <code>.command</code>.</p>
142
- </div><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3"> </span><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;start &lt;service&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;start named service&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;stop [service]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;stop named service, or all if no name supplied&#39;</span><span class="hl-3">);</span>
521
+ </div></div><aside class="tsd-sources">
522
+ <ul>
523
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:420</li></ul></aside></div></li>
524
+ <li class="tsd-is-external">
525
+ <div class="tsd-signature tsd-anchor-link" id="command-2"><span class="tsd-kind-call-signature">command</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ExecutableCommandOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#command-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
526
+ <div class="tsd-description">
527
+ <div class="tsd-comment tsd-typography"><p>Define a command, implemented in a separate executable file.</p>
528
+ </div>
529
+ <div class="tsd-parameters">
530
+ <h4 class="tsd-parameters-title">Parameters</h4>
531
+ <ul class="tsd-parameter-list">
532
+ <li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span>
533
+ <div class="tsd-comment tsd-typography"><p>command name and arguments, args are <code>&lt;required&gt;</code> or <code>[optional]</code> and last may also be <code>variadic...</code></p>
534
+ </div></li>
535
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span>
536
+ <div class="tsd-comment tsd-typography"><p>description of executable command</p>
537
+ </div></li>
538
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">ExecutableCommandOptions</span></span>
539
+ <div class="tsd-comment tsd-typography"><p>configuration options</p>
540
+ </div></li></ul></div>
541
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
542
+
543
+ <div class="tsd-comment tsd-typography">
544
+ <div class="tsd-tag-remarks">
545
+ <h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The command description is supplied as the second parameter to <code>.command</code>.</p>
546
+ </div>
547
+ <div class="tsd-tag-example">
548
+ <h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3"> </span><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;start &lt;service&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;start named service&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;stop [service]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;stop named service, or all if no name supplied&#39;</span><span class="hl-3">);</span>
143
549
  </code><button type="button">Copy</button></pre>
144
550
 
145
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:442</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="commandsgroup"><span>commands<wbr/>Group</span><a href="#commandsgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="commandsgroup-1"><span class="tsd-kind-call-signature">commandsGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#commandsgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the default help group heading for subcommands added to this command.
551
+ </div></div><aside class="tsd-sources">
552
+ <ul>
553
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:442</li></ul></aside></div></li></ul></section>
554
+ <section class="tsd-panel tsd-member tsd-is-external">
555
+ <h3 class="tsd-anchor-link" id="commandsgroup"><span>commands<wbr/>Group</span><a href="#commandsgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
556
+ <ul class="tsd-signatures tsd-is-external">
557
+ <li class="tsd-is-external">
558
+ <div class="tsd-signature tsd-anchor-link" id="commandsgroup-1"><span class="tsd-kind-call-signature">commandsGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#commandsgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
559
+ <div class="tsd-description">
560
+ <div class="tsd-comment tsd-typography"><p>Set the default help group heading for subcommands added to this command.
146
561
  (This does not override a group set directly on the subcommand using .helpGroup().)</p>
147
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
148
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">commandsGroup</span><span class="hl-3">(</span><span class="hl-1">&#39;Development Commands:)</span><span class="hl-10">;</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;watch&#39;</span><span class="hl-3">)...</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;lint&#39;</span><span class="hl-3">)...</span><br/><span class="hl-3">...</span>
562
+ </div>
563
+ <div class="tsd-parameters">
564
+ <h4 class="tsd-parameters-title">Parameters</h4>
565
+ <ul class="tsd-parameter-list">
566
+ <li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
567
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
568
+
569
+ <div class="tsd-comment tsd-typography">
570
+ <div class="tsd-tag-example">
571
+ <h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">commandsGroup</span><span class="hl-3">(</span><span class="hl-1">&#39;Development Commands:)</span><span class="hl-10">;</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;watch&#39;</span><span class="hl-3">)...</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">command</span><span class="hl-3">(</span><span class="hl-1">&#39;lint&#39;</span><span class="hl-3">)...</span><br/><span class="hl-3">...</span>
149
572
  </code><button type="button">Copy</button></pre>
150
573
 
151
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1015</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="commandsgroup-2"><span class="tsd-kind-call-signature">commandsGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#commandsgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the default help group heading for subcommands added to this command.</p>
152
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1019</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="configurehelp"><span>configure<wbr/>Help</span><a href="#configurehelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="configurehelp-1"><span class="tsd-kind-call-signature">configureHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HelpConfiguration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#configurehelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>You can customise the help by overriding Help properties using configureHelp(),
574
+ </div></div><aside class="tsd-sources">
575
+ <ul>
576
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1015</li></ul></aside></div></li>
577
+ <li class="tsd-is-external">
578
+ <div class="tsd-signature tsd-anchor-link" id="commandsgroup-2"><span class="tsd-kind-call-signature">commandsGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#commandsgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
579
+ <div class="tsd-description">
580
+ <div class="tsd-comment tsd-typography"><p>Get the default help group heading for subcommands added to this command.</p>
581
+ </div>
582
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
583
+ <ul>
584
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1019</li></ul></aside></div></li></ul></section>
585
+ <section class="tsd-panel tsd-member tsd-is-external">
586
+ <h3 class="tsd-anchor-link" id="configurehelp"><span>configure<wbr/>Help</span><a href="#configurehelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
587
+ <ul class="tsd-signatures tsd-is-external">
588
+ <li class="tsd-is-external">
589
+ <div class="tsd-signature tsd-anchor-link" id="configurehelp-1"><span class="tsd-kind-call-signature">configureHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HelpConfiguration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#configurehelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
590
+ <div class="tsd-description">
591
+ <div class="tsd-comment tsd-typography"><p>You can customise the help by overriding Help properties using configureHelp(),
153
592
  or with a subclass of Help by overriding createHelp().</p>
154
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">configuration</span>: <span class="tsd-signature-type">HelpConfiguration</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:570</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="configurehelp-2"><span class="tsd-kind-call-signature">configureHelp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HelpConfiguration</span><a href="#configurehelp-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get configuration</p>
155
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HelpConfiguration</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:572</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="configureoutput"><span>configure<wbr/>Output</span><a href="#configureoutput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="configureoutput-1"><span class="tsd-kind-call-signature">configureOutput</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OutputConfiguration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#configureoutput-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The default output goes to stdout and stderr. You can customise this for special
593
+ </div>
594
+ <div class="tsd-parameters">
595
+ <h4 class="tsd-parameters-title">Parameters</h4>
596
+ <ul class="tsd-parameter-list">
597
+ <li><span><span class="tsd-kind-parameter">configuration</span>: <span class="tsd-signature-type">HelpConfiguration</span></span></li></ul></div>
598
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
599
+ <ul>
600
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:570</li></ul></aside></div></li>
601
+ <li class="tsd-is-external">
602
+ <div class="tsd-signature tsd-anchor-link" id="configurehelp-2"><span class="tsd-kind-call-signature">configureHelp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HelpConfiguration</span><a href="#configurehelp-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
603
+ <div class="tsd-description">
604
+ <div class="tsd-comment tsd-typography"><p>Get configuration</p>
605
+ </div>
606
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HelpConfiguration</span></h4><aside class="tsd-sources">
607
+ <ul>
608
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:572</li></ul></aside></div></li></ul></section>
609
+ <section class="tsd-panel tsd-member tsd-is-external">
610
+ <h3 class="tsd-anchor-link" id="configureoutput"><span>configure<wbr/>Output</span><a href="#configureoutput" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
611
+ <ul class="tsd-signatures tsd-is-external">
612
+ <li class="tsd-is-external">
613
+ <div class="tsd-signature tsd-anchor-link" id="configureoutput-1"><span class="tsd-kind-call-signature">configureOutput</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OutputConfiguration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#configureoutput-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
614
+ <div class="tsd-description">
615
+ <div class="tsd-comment tsd-typography"><p>The default output goes to stdout and stderr. You can customise this for special
156
616
  applications. You can also customise the display of errors by overriding outputError.</p>
157
617
  <p>The configuration properties are all functions:</p>
158
618
  <pre><code><span class="hl-8">// functions to change where being written, stdout and stderr</span><br/><span class="hl-5">writeOut</span><span class="hl-3">(</span><span class="hl-4">str</span><span class="hl-3">)</span><br/><span class="hl-5">writeErr</span><span class="hl-3">(</span><span class="hl-4">str</span><span class="hl-3">)</span><br/><span class="hl-8">// matching functions to specify width for wrapping help</span><br/><span class="hl-5">getOutHelpWidth</span><span class="hl-3">()</span><br/><span class="hl-5">getErrHelpWidth</span><span class="hl-3">()</span><br/><span class="hl-8">// functions based on what is being written out</span><br/><span class="hl-5">outputError</span><span class="hl-3">(</span><span class="hl-4">str</span><span class="hl-3">, </span><span class="hl-4">write</span><span class="hl-3">) </span><span class="hl-8">// used for displaying errors, and not used for displaying help</span>
159
619
  </code><button>Copy</button></pre>
160
620
 
161
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">configuration</span>: <span class="tsd-signature-type">OutputConfiguration</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:590</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="configureoutput-2"><span class="tsd-kind-call-signature">configureOutput</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OutputConfiguration</span><a href="#configureoutput-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get configuration</p>
162
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OutputConfiguration</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:592</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="copyinheritedsettings"><span>copy<wbr/>Inherited<wbr/>Settings</span><a href="#copyinheritedsettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="copyinheritedsettings-1"><span class="tsd-kind-call-signature">copyInheritedSettings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#copyinheritedsettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Copy settings that are useful to have in common across root command and subcommands.</p>
621
+ </div>
622
+ <div class="tsd-parameters">
623
+ <h4 class="tsd-parameters-title">Parameters</h4>
624
+ <ul class="tsd-parameter-list">
625
+ <li><span><span class="tsd-kind-parameter">configuration</span>: <span class="tsd-signature-type">OutputConfiguration</span></span></li></ul></div>
626
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
627
+ <ul>
628
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:590</li></ul></aside></div></li>
629
+ <li class="tsd-is-external">
630
+ <div class="tsd-signature tsd-anchor-link" id="configureoutput-2"><span class="tsd-kind-call-signature">configureOutput</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OutputConfiguration</span><a href="#configureoutput-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
631
+ <div class="tsd-description">
632
+ <div class="tsd-comment tsd-typography"><p>Get configuration</p>
633
+ </div>
634
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OutputConfiguration</span></h4><aside class="tsd-sources">
635
+ <ul>
636
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:592</li></ul></aside></div></li></ul></section>
637
+ <section class="tsd-panel tsd-member tsd-is-external">
638
+ <h3 class="tsd-anchor-link" id="copyinheritedsettings"><span>copy<wbr/>Inherited<wbr/>Settings</span><a href="#copyinheritedsettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
639
+ <ul class="tsd-signatures tsd-is-external">
640
+ <li class="tsd-is-external">
641
+ <div class="tsd-signature tsd-anchor-link" id="copyinheritedsettings-1"><span class="tsd-kind-call-signature">copyInheritedSettings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sourceCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#copyinheritedsettings-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
642
+ <div class="tsd-description">
643
+ <div class="tsd-comment tsd-typography"><p>Copy settings that are useful to have in common across root command and subcommands.</p>
163
644
  <p>(Used internally when adding a command using <code>.command()</code> so subcommands inherit parent settings.)</p>
164
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sourceCommand</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:599</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="createargument"><span>create<wbr/>Argument</span><a href="#createargument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="createargument-1"><span class="tsd-kind-call-signature">createArgument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Argument</span><a href="#createargument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached argument.</p>
645
+ </div>
646
+ <div class="tsd-parameters">
647
+ <h4 class="tsd-parameters-title">Parameters</h4>
648
+ <ul class="tsd-parameter-list">
649
+ <li><span><span class="tsd-kind-parameter">sourceCommand</span>: <a href="" class="tsd-signature-type tsd-kind-class">Command</a></span></li></ul></div>
650
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
651
+ <ul>
652
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:599</li></ul></aside></div></li></ul></section>
653
+ <section class="tsd-panel tsd-member tsd-is-external">
654
+ <h3 class="tsd-anchor-link" id="createargument"><span>create<wbr/>Argument</span><a href="#createargument" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
655
+ <ul class="tsd-signatures tsd-is-external">
656
+ <li class="tsd-is-external">
657
+ <div class="tsd-signature tsd-anchor-link" id="createargument-1"><span class="tsd-kind-call-signature">createArgument</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Argument</span><a href="#createargument-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
658
+ <div class="tsd-description">
659
+ <div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached argument.</p>
165
660
  <p>See .argument() for creating an attached argument, which uses this routine to
166
661
  create the argument. You can override createArgument to return a custom argument.</p>
167
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Argument</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:471</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="createcommand"><span>create<wbr/>Command</span><a href="#createcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="createcommand-1"><span class="tsd-kind-call-signature">createCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#createcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached command.</p>
662
+ </div>
663
+ <div class="tsd-parameters">
664
+ <h4 class="tsd-parameters-title">Parameters</h4>
665
+ <ul class="tsd-parameter-list">
666
+ <li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li>
667
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
668
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Argument</span></h4><aside class="tsd-sources">
669
+ <ul>
670
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:471</li></ul></aside></div></li></ul></section>
671
+ <section class="tsd-panel tsd-member tsd-is-external">
672
+ <h3 class="tsd-anchor-link" id="createcommand"><span>create<wbr/>Command</span><a href="#createcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
673
+ <ul class="tsd-signatures tsd-is-external">
674
+ <li class="tsd-is-external">
675
+ <div class="tsd-signature tsd-anchor-link" id="createcommand-1"><span class="tsd-kind-call-signature">createCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><a href="#createcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
676
+ <div class="tsd-description">
677
+ <div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached command.</p>
168
678
  <p>See .command() for creating an attached subcommand, which uses this routine to
169
679
  create the command. You can override createCommand to customise subcommands.</p>
170
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:454</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="createhelp"><span>create<wbr/>Help</span><a href="#createhelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="createhelp-1"><span class="tsd-kind-call-signature">createHelp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Help</span><a href="#createhelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>You can customise the help with a subclass of Help by overriding createHelp,
680
+ </div>
681
+ <div class="tsd-parameters">
682
+ <h4 class="tsd-parameters-title">Parameters</h4>
683
+ <ul class="tsd-parameter-list">
684
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
685
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a></h4><aside class="tsd-sources">
686
+ <ul>
687
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:454</li></ul></aside></div></li></ul></section>
688
+ <section class="tsd-panel tsd-member tsd-is-external">
689
+ <h3 class="tsd-anchor-link" id="createhelp"><span>create<wbr/>Help</span><a href="#createhelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
690
+ <ul class="tsd-signatures tsd-is-external">
691
+ <li class="tsd-is-external">
692
+ <div class="tsd-signature tsd-anchor-link" id="createhelp-1"><span class="tsd-kind-call-signature">createHelp</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Help</span><a href="#createhelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
693
+ <div class="tsd-description">
694
+ <div class="tsd-comment tsd-typography"><p>You can customise the help with a subclass of Help by overriding createHelp,
171
695
  or by overriding Help properties using configureHelp().</p>
172
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Help</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:564</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="createoption"><span>create<wbr/>Option</span><a href="#createoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="createoption-1"><span class="tsd-kind-call-signature">createOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><a href="#createoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached option.</p>
696
+ </div>
697
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Help</span></h4><aside class="tsd-sources">
698
+ <ul>
699
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:564</li></ul></aside></div></li></ul></section>
700
+ <section class="tsd-panel tsd-member tsd-is-external">
701
+ <h3 class="tsd-anchor-link" id="createoption"><span>create<wbr/>Option</span><a href="#createoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
702
+ <ul class="tsd-signatures tsd-is-external">
703
+ <li class="tsd-is-external">
704
+ <div class="tsd-signature tsd-anchor-link" id="createoption-1"><span class="tsd-kind-call-signature">createOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Option</span><a href="#createoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
705
+ <div class="tsd-description">
706
+ <div class="tsd-comment tsd-typography"><p>Factory routine to create a new unattached option.</p>
173
707
  <p>See .option() for creating an attached option, which uses this routine to
174
708
  create the option. You can override createOption to return a custom option.</p>
175
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Option</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:699</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="description"><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="description-1"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#description-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the description.</p>
176
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
177
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:891</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="description-2"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">argsDescription</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#description-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">argsDescription</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v8, instead use .argument to add command argument with description</p>
178
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:893</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="description-3"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#description-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the description.</p>
179
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:897</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="enablepositionaloptions"><span>enable<wbr/>Positional<wbr/>Options</span><a href="#enablepositionaloptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="enablepositionaloptions-1"><span class="tsd-kind-call-signature">enablePositionalOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">positional</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#enablepositionaloptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable positional options. Positional means global options are specified before subcommands which lets
709
+ </div>
710
+ <div class="tsd-parameters">
711
+ <h4 class="tsd-parameters-title">Parameters</h4>
712
+ <ul class="tsd-parameter-list">
713
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
714
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
715
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Option</span></h4><aside class="tsd-sources">
716
+ <ul>
717
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:699</li></ul></aside></div></li></ul></section>
718
+ <section class="tsd-panel tsd-member tsd-is-external">
719
+ <h3 class="tsd-anchor-link" id="description"><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
720
+ <ul class="tsd-signatures tsd-is-external">
721
+ <li class="tsd-is-external">
722
+ <div class="tsd-signature tsd-anchor-link" id="description-1"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#description-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
723
+ <div class="tsd-description">
724
+ <div class="tsd-comment tsd-typography"><p>Set the description.</p>
725
+ </div>
726
+ <div class="tsd-parameters">
727
+ <h4 class="tsd-parameters-title">Parameters</h4>
728
+ <ul class="tsd-parameter-list">
729
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
730
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
731
+ <aside class="tsd-sources">
732
+ <ul>
733
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:891</li></ul></aside></div></li>
734
+ <li class="tsd-is-external">
735
+ <div class="tsd-signature tsd-anchor-link" id="description-2"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">argsDescription</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#description-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
736
+ <div class="tsd-description">
737
+ <div class="tsd-parameters">
738
+ <h4 class="tsd-parameters-title">Parameters</h4>
739
+ <ul class="tsd-parameter-list">
740
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li>
741
+ <li><span><span class="tsd-kind-parameter">argsDescription</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div>
742
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
743
+ <div class="tsd-comment tsd-typography">
744
+ <div class="tsd-tag-deprecated">
745
+ <h4 class="tsd-anchor-link" id="deprecated-2">Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v8, instead use .argument to add command argument with description</p>
746
+ </div></div><aside class="tsd-sources">
747
+ <ul>
748
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:893</li></ul></aside></div></li>
749
+ <li class="tsd-is-external">
750
+ <div class="tsd-signature tsd-anchor-link" id="description-3"><span class="tsd-kind-call-signature">description</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#description-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
751
+ <div class="tsd-description">
752
+ <div class="tsd-comment tsd-typography"><p>Get the description.</p>
753
+ </div>
754
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
755
+ <ul>
756
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:897</li></ul></aside></div></li></ul></section>
757
+ <section class="tsd-panel tsd-member tsd-is-external">
758
+ <h3 class="tsd-anchor-link" id="enablepositionaloptions"><span>enable<wbr/>Positional<wbr/>Options</span><a href="#enablepositionaloptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
759
+ <ul class="tsd-signatures tsd-is-external">
760
+ <li class="tsd-is-external">
761
+ <div class="tsd-signature tsd-anchor-link" id="enablepositionaloptions-1"><span class="tsd-kind-call-signature">enablePositionalOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">positional</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#enablepositionaloptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
762
+ <div class="tsd-description">
763
+ <div class="tsd-comment tsd-typography"><p>Enable positional options. Positional means global options are specified before subcommands which lets
180
764
  subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.</p>
181
765
  <p>The default behaviour is non-positional and global options may appear anywhere on the command line.</p>
182
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">positional</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
183
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:785</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="error"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="error-1"><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">errorOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ErrorOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#error-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Display error message and exit (or call exitOverride).</p>
184
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">errorOptions</span>: <span class="tsd-signature-type">ErrorOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:558</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="executabledir"><span>executable<wbr/>Dir</span><a href="#executabledir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="executabledir-1"><span class="tsd-kind-call-signature">executableDir</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#executabledir-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the directory for searching for executable subcommands of this command.</p>
185
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
186
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">executableDir</span><span class="hl-3">(</span><span class="hl-4">__dirname</span><span class="hl-3">);</span><br/><span class="hl-8">// or</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">executableDir</span><span class="hl-3">(</span><span class="hl-1">&#39;subcommands&#39;</span><span class="hl-3">);</span>
766
+ </div>
767
+ <div class="tsd-parameters">
768
+ <h4 class="tsd-parameters-title">Parameters</h4>
769
+ <ul class="tsd-parameter-list">
770
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">positional</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
771
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
772
+ <aside class="tsd-sources">
773
+ <ul>
774
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:785</li></ul></aside></div></li></ul></section>
775
+ <section class="tsd-panel tsd-member tsd-is-external">
776
+ <h3 class="tsd-anchor-link" id="error"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
777
+ <ul class="tsd-signatures tsd-is-external">
778
+ <li class="tsd-is-external">
779
+ <div class="tsd-signature tsd-anchor-link" id="error-1"><span class="tsd-kind-call-signature">error</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">errorOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ErrorOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#error-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
780
+ <div class="tsd-description">
781
+ <div class="tsd-comment tsd-typography"><p>Display error message and exit (or call exitOverride).</p>
782
+ </div>
783
+ <div class="tsd-parameters">
784
+ <h4 class="tsd-parameters-title">Parameters</h4>
785
+ <ul class="tsd-parameter-list">
786
+ <li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span></li>
787
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">errorOptions</span>: <span class="tsd-signature-type">ErrorOptions</span></span></li></ul></div>
788
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4><aside class="tsd-sources">
789
+ <ul>
790
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:558</li></ul></aside></div></li></ul></section>
791
+ <section class="tsd-panel tsd-member tsd-is-external">
792
+ <h3 class="tsd-anchor-link" id="executabledir"><span>executable<wbr/>Dir</span><a href="#executabledir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
793
+ <ul class="tsd-signatures tsd-is-external">
794
+ <li class="tsd-is-external">
795
+ <div class="tsd-signature tsd-anchor-link" id="executabledir-1"><span class="tsd-kind-call-signature">executableDir</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#executabledir-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
796
+ <div class="tsd-description">
797
+ <div class="tsd-comment tsd-typography"><p>Set the directory for searching for executable subcommands of this command.</p>
798
+ </div>
799
+ <div class="tsd-parameters">
800
+ <h4 class="tsd-parameters-title">Parameters</h4>
801
+ <ul class="tsd-parameter-list">
802
+ <li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
803
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
804
+
805
+ <div class="tsd-comment tsd-typography">
806
+ <div class="tsd-tag-example">
807
+ <h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">executableDir</span><span class="hl-3">(</span><span class="hl-4">__dirname</span><span class="hl-3">);</span><br/><span class="hl-8">// or</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">executableDir</span><span class="hl-3">(</span><span class="hl-1">&#39;subcommands&#39;</span><span class="hl-3">);</span>
187
808
  </code><button type="button">Copy</button></pre>
188
809
 
189
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:986</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="executabledir-2"><span class="tsd-kind-call-signature">executableDir</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#executabledir-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the executable search directory.</p>
190
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:990</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="exitoverride"><span>exit<wbr/>Override</span><a href="#exitoverride" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="exitoverride-1"><span class="tsd-kind-call-signature">exitOverride</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommanderError</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#exitoverride-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register callback to use as replacement for calling process.exit.</p>
191
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommanderError</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:553</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="getoptionvalue"><span>get<wbr/>Option<wbr/>Value</span><a href="#getoptionvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getoptionvalue-1"><span class="tsd-kind-call-signature">getOptionValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getoptionvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve option value.</p>
192
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:723</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="getoptionvaluesource"><span>get<wbr/>Option<wbr/>Value<wbr/>Source</span><a href="#getoptionvaluesource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getoptionvaluesource-1"><span class="tsd-kind-call-signature">getOptionValueSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><a href="#getoptionvaluesource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get source of option value.</p>
193
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OptionValueSource</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:742</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="getoptionvaluesourcewithglobals"><span>get<wbr/>Option<wbr/>Value<wbr/>Source<wbr/>With<wbr/>Globals</span><a href="#getoptionvaluesourcewithglobals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="getoptionvaluesourcewithglobals-1"><span class="tsd-kind-call-signature">getOptionValueSourceWithGlobals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><a href="#getoptionvaluesourcewithglobals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get source of option value. See also .optsWithGlobals().</p>
194
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OptionValueSource</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:747</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="help"><span>help</span><a href="#help" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="help-1"><span class="tsd-kind-call-signature">help</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#help-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Output help information and exit.</p>
810
+ </div></div><aside class="tsd-sources">
811
+ <ul>
812
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:986</li></ul></aside></div></li>
813
+ <li class="tsd-is-external">
814
+ <div class="tsd-signature tsd-anchor-link" id="executabledir-2"><span class="tsd-kind-call-signature">executableDir</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#executabledir-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
815
+ <div class="tsd-description">
816
+ <div class="tsd-comment tsd-typography"><p>Get the executable search directory.</p>
817
+ </div>
818
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
819
+ <ul>
820
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:990</li></ul></aside></div></li></ul></section>
821
+ <section class="tsd-panel tsd-member tsd-is-external">
822
+ <h3 class="tsd-anchor-link" id="exitoverride"><span>exit<wbr/>Override</span><a href="#exitoverride" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
823
+ <ul class="tsd-signatures tsd-is-external">
824
+ <li class="tsd-is-external">
825
+ <div class="tsd-signature tsd-anchor-link" id="exitoverride-1"><span class="tsd-kind-call-signature">exitOverride</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommanderError</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#exitoverride-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
826
+ <div class="tsd-description">
827
+ <div class="tsd-comment tsd-typography"><p>Register callback to use as replacement for calling process.exit.</p>
828
+ </div>
829
+ <div class="tsd-parameters">
830
+ <h4 class="tsd-parameters-title">Parameters</h4>
831
+ <ul class="tsd-parameter-list">
832
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CommanderError</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div>
833
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
834
+ <ul>
835
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:553</li></ul></aside></div></li></ul></section>
836
+ <section class="tsd-panel tsd-member tsd-is-external">
837
+ <h3 class="tsd-anchor-link" id="getoptionvalue"><span>get<wbr/>Option<wbr/>Value</span><a href="#getoptionvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
838
+ <ul class="tsd-signatures tsd-is-external">
839
+ <li class="tsd-is-external">
840
+ <div class="tsd-signature tsd-anchor-link" id="getoptionvalue-1"><span class="tsd-kind-call-signature">getOptionValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#getoptionvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
841
+ <div class="tsd-description">
842
+ <div class="tsd-comment tsd-typography"><p>Retrieve option value.</p>
843
+ </div>
844
+ <div class="tsd-parameters">
845
+ <h4 class="tsd-parameters-title">Parameters</h4>
846
+ <ul class="tsd-parameter-list">
847
+ <li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
848
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
849
+ <ul>
850
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:723</li></ul></aside></div></li></ul></section>
851
+ <section class="tsd-panel tsd-member tsd-is-external">
852
+ <h3 class="tsd-anchor-link" id="getoptionvaluesource"><span>get<wbr/>Option<wbr/>Value<wbr/>Source</span><a href="#getoptionvaluesource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
853
+ <ul class="tsd-signatures tsd-is-external">
854
+ <li class="tsd-is-external">
855
+ <div class="tsd-signature tsd-anchor-link" id="getoptionvaluesource-1"><span class="tsd-kind-call-signature">getOptionValueSource</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><a href="#getoptionvaluesource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
856
+ <div class="tsd-description">
857
+ <div class="tsd-comment tsd-typography"><p>Get source of option value.</p>
858
+ </div>
859
+ <div class="tsd-parameters">
860
+ <h4 class="tsd-parameters-title">Parameters</h4>
861
+ <ul class="tsd-parameter-list">
862
+ <li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
863
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OptionValueSource</span></h4><aside class="tsd-sources">
864
+ <ul>
865
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:742</li></ul></aside></div></li></ul></section>
866
+ <section class="tsd-panel tsd-member tsd-is-external">
867
+ <h3 class="tsd-anchor-link" id="getoptionvaluesourcewithglobals"><span>get<wbr/>Option<wbr/>Value<wbr/>Source<wbr/>With<wbr/>Globals</span><a href="#getoptionvaluesourcewithglobals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
868
+ <ul class="tsd-signatures tsd-is-external">
869
+ <li class="tsd-is-external">
870
+ <div class="tsd-signature tsd-anchor-link" id="getoptionvaluesourcewithglobals-1"><span class="tsd-kind-call-signature">getOptionValueSourceWithGlobals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><a href="#getoptionvaluesourcewithglobals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
871
+ <div class="tsd-description">
872
+ <div class="tsd-comment tsd-typography"><p>Get source of option value. See also .optsWithGlobals().</p>
873
+ </div>
874
+ <div class="tsd-parameters">
875
+ <h4 class="tsd-parameters-title">Parameters</h4>
876
+ <ul class="tsd-parameter-list">
877
+ <li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
878
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">OptionValueSource</span></h4><aside class="tsd-sources">
879
+ <ul>
880
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:747</li></ul></aside></div></li></ul></section>
881
+ <section class="tsd-panel tsd-member tsd-is-external">
882
+ <h3 class="tsd-anchor-link" id="help"><span>help</span><a href="#help" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
883
+ <ul class="tsd-signatures tsd-is-external">
884
+ <li class="tsd-is-external">
885
+ <div class="tsd-signature tsd-anchor-link" id="help-1"><span class="tsd-kind-call-signature">help</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#help-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
886
+ <div class="tsd-description">
887
+ <div class="tsd-comment tsd-typography"><p>Output help information and exit.</p>
195
888
  <p>Outputs built-in help, and custom text added using <code>.addHelpText()</code>.</p>
196
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1072</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="help-2"><span class="tsd-kind-call-signature">help</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#help-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7</p>
197
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1074</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="helpcommand"><span>help<wbr/>Command</span><a href="#helpcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpcommand-1"><span class="tsd-kind-call-signature">helpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Customise or override default help command. By default a help command is automatically added if your command has subcommands.</p>
198
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;show help&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">); </span><span class="hl-8">// suppress default help command</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">); </span><span class="hl-8">// add help command even if no subcommands</span>
889
+ </div>
890
+ <div class="tsd-parameters">
891
+ <h4 class="tsd-parameters-title">Parameters</h4>
892
+ <ul class="tsd-parameter-list">
893
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div>
894
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4><aside class="tsd-sources">
895
+ <ul>
896
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1072</li></ul></aside></div></li>
897
+ <li class="tsd-is-external">
898
+ <div class="tsd-signature tsd-anchor-link" id="help-2"><span class="tsd-kind-call-signature">help</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><a href="#help-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
899
+ <div class="tsd-description">
900
+ <div class="tsd-parameters">
901
+ <h4 class="tsd-parameters-title">Parameters</h4>
902
+ <ul class="tsd-parameter-list">
903
+ <li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div>
904
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">never</span></h4>
905
+ <div class="tsd-comment tsd-typography">
906
+ <div class="tsd-tag-deprecated">
907
+ <h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7</p>
908
+ </div></div><aside class="tsd-sources">
909
+ <ul>
910
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1074</li></ul></aside></div></li></ul></section>
911
+ <section class="tsd-panel tsd-member tsd-is-external">
912
+ <h3 class="tsd-anchor-link" id="helpcommand"><span>help<wbr/>Command</span><a href="#helpcommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
913
+ <ul class="tsd-signatures tsd-is-external">
914
+ <li class="tsd-is-external">
915
+ <div class="tsd-signature tsd-anchor-link" id="helpcommand-1"><span class="tsd-kind-call-signature">helpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nameAndArgs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpcommand-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
916
+ <div class="tsd-description">
917
+ <div class="tsd-comment tsd-typography"><p>Customise or override default help command. By default a help command is automatically added if your command has subcommands.</p>
918
+ </div>
919
+ <div class="tsd-parameters">
920
+ <h4 class="tsd-parameters-title">Parameters</h4>
921
+ <ul class="tsd-parameter-list">
922
+ <li><span><span class="tsd-kind-parameter">nameAndArgs</span>: <span class="tsd-signature-type">string</span></span></li>
923
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
924
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
925
+ <div class="tsd-comment tsd-typography">
926
+ <div class="tsd-tag-example">
927
+ <h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;show help&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">); </span><span class="hl-8">// suppress default help command</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">); </span><span class="hl-8">// add help command even if no subcommands</span>
199
928
  </code><button type="button">Copy</button></pre>
200
929
 
201
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:527</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpcommand-2"><span class="tsd-kind-call-signature">helpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpcommand-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Customise or override default help command. By default a help command is automatically added if your command has subcommands.</p>
202
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;show help&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">); </span><span class="hl-8">// suppress default help command</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">); </span><span class="hl-8">// add help command even if no subcommands</span>
930
+ </div></div><aside class="tsd-sources">
931
+ <ul>
932
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:527</li></ul></aside></div></li>
933
+ <li class="tsd-is-external">
934
+ <div class="tsd-signature tsd-anchor-link" id="helpcommand-2"><span class="tsd-kind-call-signature">helpCommand</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">enable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpcommand-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
935
+ <div class="tsd-description">
936
+ <div class="tsd-comment tsd-typography"><p>Customise or override default help command. By default a help command is automatically added if your command has subcommands.</p>
937
+ </div>
938
+ <div class="tsd-parameters">
939
+ <h4 class="tsd-parameters-title">Parameters</h4>
940
+ <ul class="tsd-parameter-list">
941
+ <li><span><span class="tsd-kind-parameter">enable</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
942
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
943
+ <div class="tsd-comment tsd-typography">
944
+ <div class="tsd-tag-example">
945
+ <h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-1">&#39;help [cmd]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;show help&#39;</span><span class="hl-3">);</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">false</span><span class="hl-3">); </span><span class="hl-8">// suppress default help command</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">helpCommand</span><span class="hl-3">(</span><span class="hl-0">true</span><span class="hl-3">); </span><span class="hl-8">// add help command even if no subcommands</span>
203
946
  </code><button type="button">Copy</button></pre>
204
947
 
205
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:528</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="helpgroup"><span>help<wbr/>Group</span><a href="#helpgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpgroup-1"><span class="tsd-kind-call-signature">helpGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the help group heading for this subcommand in parent command's help.</p>
206
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
207
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:997</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpgroup-2"><span class="tsd-kind-call-signature">helpGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#helpgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the help group heading for this subcommand in parent command's help.</p>
208
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1001</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="helpinformation"><span>help<wbr/>Information</span><a href="#helpinformation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpinformation-1"><span class="tsd-kind-call-signature">helpInformation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#helpinformation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return command help documentation.</p>
209
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1052</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="helpoption"><span>help<wbr/>Option</span><a href="#helpoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="helpoption-1"><span class="tsd-kind-call-signature">helpOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>You can pass in flags and a description to override the help
948
+ </div></div><aside class="tsd-sources">
949
+ <ul>
950
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:528</li></ul></aside></div></li></ul></section>
951
+ <section class="tsd-panel tsd-member tsd-is-external">
952
+ <h3 class="tsd-anchor-link" id="helpgroup"><span>help<wbr/>Group</span><a href="#helpgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
953
+ <ul class="tsd-signatures tsd-is-external">
954
+ <li class="tsd-is-external">
955
+ <div class="tsd-signature tsd-anchor-link" id="helpgroup-1"><span class="tsd-kind-call-signature">helpGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
956
+ <div class="tsd-description">
957
+ <div class="tsd-comment tsd-typography"><p>Set the help group heading for this subcommand in parent command's help.</p>
958
+ </div>
959
+ <div class="tsd-parameters">
960
+ <h4 class="tsd-parameters-title">Parameters</h4>
961
+ <ul class="tsd-parameter-list">
962
+ <li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
963
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
964
+ <aside class="tsd-sources">
965
+ <ul>
966
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:997</li></ul></aside></div></li>
967
+ <li class="tsd-is-external">
968
+ <div class="tsd-signature tsd-anchor-link" id="helpgroup-2"><span class="tsd-kind-call-signature">helpGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#helpgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
969
+ <div class="tsd-description">
970
+ <div class="tsd-comment tsd-typography"><p>Get the help group heading for this subcommand in parent command's help.</p>
971
+ </div>
972
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
973
+ <ul>
974
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1001</li></ul></aside></div></li></ul></section>
975
+ <section class="tsd-panel tsd-member tsd-is-external">
976
+ <h3 class="tsd-anchor-link" id="helpinformation"><span>help<wbr/>Information</span><a href="#helpinformation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
977
+ <ul class="tsd-signatures tsd-is-external">
978
+ <li class="tsd-is-external">
979
+ <div class="tsd-signature tsd-anchor-link" id="helpinformation-1"><span class="tsd-kind-call-signature">helpInformation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#helpinformation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
980
+ <div class="tsd-description">
981
+ <div class="tsd-comment tsd-typography"><p>Return command help documentation.</p>
982
+ </div>
983
+ <div class="tsd-parameters">
984
+ <h4 class="tsd-parameters-title">Parameters</h4>
985
+ <ul class="tsd-parameter-list">
986
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div>
987
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
988
+ <ul>
989
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1052</li></ul></aside></div></li></ul></section>
990
+ <section class="tsd-panel tsd-member tsd-is-external">
991
+ <h3 class="tsd-anchor-link" id="helpoption"><span>help<wbr/>Option</span><a href="#helpoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
992
+ <ul class="tsd-signatures tsd-is-external">
993
+ <li class="tsd-is-external">
994
+ <div class="tsd-signature tsd-anchor-link" id="helpoption-1"><span class="tsd-kind-call-signature">helpOption</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#helpoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
995
+ <div class="tsd-description">
996
+ <div class="tsd-comment tsd-typography"><p>You can pass in flags and a description to override the help
210
997
  flags and help description for your command. Pass in false
211
998
  to disable the built-in help option.</p>
212
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1059</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="hook"><span>hook</span><a href="#hook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="hook-1"><span class="tsd-kind-call-signature">hook</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HookEvent</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">thisCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">actionCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#hook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add hook for life cycle event.</p>
213
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">HookEvent</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thisCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">actionCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:542</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="name-1"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#name-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the name of the command.</p>
214
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
215
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:953</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="name-2"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#name-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the name of the command.</p>
216
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:957</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="namefromfilename"><span>name<wbr/>From<wbr/>Filename</span><a href="#namefromfilename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="namefromfilename-1"><span class="tsd-kind-call-signature">nameFromFilename</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#namefromfilename-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the name of the command from script filename, such as process.argv[1],
999
+ </div>
1000
+ <div class="tsd-parameters">
1001
+ <h4 class="tsd-parameters-title">Parameters</h4>
1002
+ <ul class="tsd-parameter-list">
1003
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></span></li>
1004
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1005
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1006
+ <ul>
1007
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1059</li></ul></aside></div></li></ul></section>
1008
+ <section class="tsd-panel tsd-member tsd-is-external">
1009
+ <h3 class="tsd-anchor-link" id="hook"><span>hook</span><a href="#hook" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1010
+ <ul class="tsd-signatures tsd-is-external">
1011
+ <li class="tsd-is-external">
1012
+ <div class="tsd-signature tsd-anchor-link" id="hook-1"><span class="tsd-kind-call-signature">hook</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HookEvent</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">thisCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">actionCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#hook-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1013
+ <div class="tsd-description">
1014
+ <div class="tsd-comment tsd-typography"><p>Add hook for life cycle event.</p>
1015
+ </div>
1016
+ <div class="tsd-parameters">
1017
+ <h4 class="tsd-parameters-title">Parameters</h4>
1018
+ <ul class="tsd-parameter-list">
1019
+ <li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">HookEvent</span></span></li>
1020
+ <li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">thisCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">actionCommand</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div>
1021
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1022
+ <ul>
1023
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:542</li></ul></aside></div></li></ul></section>
1024
+ <section class="tsd-panel tsd-member tsd-is-external">
1025
+ <h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1026
+ <ul class="tsd-signatures tsd-is-external">
1027
+ <li class="tsd-is-external">
1028
+ <div class="tsd-signature tsd-anchor-link" id="name-1"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#name-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1029
+ <div class="tsd-description">
1030
+ <div class="tsd-comment tsd-typography"><p>Set the name of the command.</p>
1031
+ </div>
1032
+ <div class="tsd-parameters">
1033
+ <h4 class="tsd-parameters-title">Parameters</h4>
1034
+ <ul class="tsd-parameter-list">
1035
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1036
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1037
+ <aside class="tsd-sources">
1038
+ <ul>
1039
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:953</li></ul></aside></div></li>
1040
+ <li class="tsd-is-external">
1041
+ <div class="tsd-signature tsd-anchor-link" id="name-2"><span class="tsd-kind-call-signature">name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#name-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1042
+ <div class="tsd-description">
1043
+ <div class="tsd-comment tsd-typography"><p>Get the name of the command.</p>
1044
+ </div>
1045
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1046
+ <ul>
1047
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:957</li></ul></aside></div></li></ul></section>
1048
+ <section class="tsd-panel tsd-member tsd-is-external">
1049
+ <h3 class="tsd-anchor-link" id="namefromfilename"><span>name<wbr/>From<wbr/>Filename</span><a href="#namefromfilename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1050
+ <ul class="tsd-signatures tsd-is-external">
1051
+ <li class="tsd-is-external">
1052
+ <div class="tsd-signature tsd-anchor-link" id="namefromfilename-1"><span class="tsd-kind-call-signature">nameFromFilename</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#namefromfilename-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1053
+ <div class="tsd-description">
1054
+ <div class="tsd-comment tsd-typography"><p>Set the name of the command from script filename, such as process.argv[1],
217
1055
  or require.main.filename, or __filename.</p>
218
1056
  <p>(Used internally and public although not documented in README.)</p>
219
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
220
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">nameFromFilename</span><span class="hl-3">(</span><span class="hl-4">require</span><span class="hl-3">.</span><span class="hl-4">main</span><span class="hl-3">.</span><span class="hl-4">filename</span><span class="hl-3">);</span>
1057
+ </div>
1058
+ <div class="tsd-parameters">
1059
+ <h4 class="tsd-parameters-title">Parameters</h4>
1060
+ <ul class="tsd-parameter-list">
1061
+ <li><span><span class="tsd-kind-parameter">filename</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1062
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1063
+
1064
+ <div class="tsd-comment tsd-typography">
1065
+ <div class="tsd-tag-example">
1066
+ <h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">nameFromFilename</span><span class="hl-3">(</span><span class="hl-4">require</span><span class="hl-3">.</span><span class="hl-4">main</span><span class="hl-3">.</span><span class="hl-4">filename</span><span class="hl-3">);</span>
221
1067
  </code><button type="button">Copy</button></pre>
222
1068
 
223
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:972</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Add a listener (callback) for when events occur. (Implemented using EventEmitter.)</p>
224
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1091</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="option"><span>option</span><a href="#option" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="option-1"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define option with <code>flags</code>, <code>description</code>, and optional argument parsing function or <code>defaultValue</code> or both.</p>
1069
+ </div></div><aside class="tsd-sources">
1070
+ <ul>
1071
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:972</li></ul></aside></div></li></ul></section>
1072
+ <section class="tsd-panel tsd-member tsd-is-external">
1073
+ <h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1074
+ <ul class="tsd-signatures tsd-is-external">
1075
+ <li class="tsd-is-external">
1076
+ <div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1077
+ <div class="tsd-description">
1078
+ <div class="tsd-comment tsd-typography"><p>Add a listener (callback) for when events occur. (Implemented using EventEmitter.)</p>
1079
+ </div>
1080
+ <div class="tsd-parameters">
1081
+ <h4 class="tsd-parameters-title">Parameters</h4>
1082
+ <ul class="tsd-parameter-list">
1083
+ <li><span><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">symbol</span></span></li>
1084
+ <li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span></li></ul></div>
1085
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1086
+ <ul>
1087
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1091</li></ul></aside></div></li></ul></section>
1088
+ <section class="tsd-panel tsd-member tsd-is-external">
1089
+ <h3 class="tsd-anchor-link" id="option"><span>option</span><a href="#option" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1090
+ <ul class="tsd-signatures tsd-is-external">
1091
+ <li class="tsd-is-external">
1092
+ <div class="tsd-signature tsd-anchor-link" id="option-1"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1093
+ <div class="tsd-description">
1094
+ <div class="tsd-comment tsd-typography"><p>Define option with <code>flags</code>, <code>description</code>, and optional argument parsing function or <code>defaultValue</code> or both.</p>
225
1095
  <p>The <code>flags</code> string contains the short and/or long flags, separated by comma, a pipe or space. A required
226
1096
  option-argument is indicated by <code>&lt;&gt;</code> and an optional option-argument by <code>[]</code>.</p>
227
1097
  <p>See the README for more details, and see also addOption() and requiredOption().</p>
228
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
229
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --pepper&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add pepper&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;--pt, --pizza-type &lt;TYPE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;type of pizza&#39;</span><span class="hl-3">) </span><span class="hl-8">// required option-argument</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-c, --cheese [CHEESE]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add extra cheese&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;mozzarella&#39;</span><span class="hl-3">) </span><span class="hl-8">// optional option-argument with default</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-t, --tip &lt;VALUE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add tip to purchase cost&#39;</span><span class="hl-3">, </span><span class="hl-4">parseFloat</span><span class="hl-3">) </span><span class="hl-8">// custom parse function</span>
1098
+ </div>
1099
+ <div class="tsd-parameters">
1100
+ <h4 class="tsd-parameters-title">Parameters</h4>
1101
+ <ul class="tsd-parameter-list">
1102
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1103
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1104
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
1105
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1106
+
1107
+ <div class="tsd-comment tsd-typography">
1108
+ <div class="tsd-tag-example">
1109
+ <h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --pepper&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add pepper&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;--pt, --pizza-type &lt;TYPE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;type of pizza&#39;</span><span class="hl-3">) </span><span class="hl-8">// required option-argument</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-c, --cheese [CHEESE]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add extra cheese&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;mozzarella&#39;</span><span class="hl-3">) </span><span class="hl-8">// optional option-argument with default</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-t, --tip &lt;VALUE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add tip to purchase cost&#39;</span><span class="hl-3">, </span><span class="hl-4">parseFloat</span><span class="hl-3">) </span><span class="hl-8">// custom parse function</span>
230
1110
  </code><button type="button">Copy</button></pre>
231
1111
 
232
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:648</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="option-2"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define option with <code>flags</code>, <code>description</code>, and optional argument parsing function or <code>defaultValue</code> or both.</p>
1112
+ </div></div><aside class="tsd-sources">
1113
+ <ul>
1114
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:648</li></ul></aside></div></li>
1115
+ <li class="tsd-is-external">
1116
+ <div class="tsd-signature tsd-anchor-link" id="option-2"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1117
+ <div class="tsd-description">
1118
+ <div class="tsd-comment tsd-typography"><p>Define option with <code>flags</code>, <code>description</code>, and optional argument parsing function or <code>defaultValue</code> or both.</p>
233
1119
  <p>The <code>flags</code> string contains the short and/or long flags, separated by comma, a pipe or space. A required
234
1120
  option-argument is indicated by <code>&lt;&gt;</code> and an optional option-argument by <code>[]</code>.</p>
235
1121
  <p>See the README for more details, and see also addOption() and requiredOption().</p>
236
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="optiont"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
237
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --pepper&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add pepper&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;--pt, --pizza-type &lt;TYPE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;type of pizza&#39;</span><span class="hl-3">) </span><span class="hl-8">// required option-argument</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-c, --cheese [CHEESE]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add extra cheese&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;mozzarella&#39;</span><span class="hl-3">) </span><span class="hl-8">// optional option-argument with default</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-t, --tip &lt;VALUE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add tip to purchase cost&#39;</span><span class="hl-3">, </span><span class="hl-4">parseFloat</span><span class="hl-3">) </span><span class="hl-8">// custom parse function</span>
1122
+ </div>
1123
+ <section class="tsd-panel">
1124
+ <h4>Type Parameters</h4>
1125
+ <ul class="tsd-type-parameter-list">
1126
+ <li><span id="optiont"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section>
1127
+ <div class="tsd-parameters">
1128
+ <h4 class="tsd-parameters-title">Parameters</h4>
1129
+ <ul class="tsd-parameter-list">
1130
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1131
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1132
+ <li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a></span></li>
1133
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#optiont">T</a></span></li></ul></div>
1134
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1135
+
1136
+ <div class="tsd-comment tsd-typography">
1137
+ <div class="tsd-tag-example">
1138
+ <h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="js"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --pepper&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add pepper&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;--pt, --pizza-type &lt;TYPE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;type of pizza&#39;</span><span class="hl-3">) </span><span class="hl-8">// required option-argument</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-c, --cheese [CHEESE]&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add extra cheese&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;mozzarella&#39;</span><span class="hl-3">) </span><span class="hl-8">// optional option-argument with default</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-t, --tip &lt;VALUE&gt;&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;add tip to purchase cost&#39;</span><span class="hl-3">, </span><span class="hl-4">parseFloat</span><span class="hl-3">) </span><span class="hl-8">// custom parse function</span>
238
1139
  </code><button type="button">Copy</button></pre>
239
1140
 
240
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:653</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="option-3"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">regexp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">regexp</span>: <span class="tsd-signature-type">RegExp</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-4">Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7, instead use choices or a custom function</p>
241
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:660</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="optionsgroup"><span>options<wbr/>Group</span><a href="#optionsgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="optionsgroup-1"><span class="tsd-kind-call-signature">optionsGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#optionsgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the default help group heading for options added to this command.
1141
+ </div></div><aside class="tsd-sources">
1142
+ <ul>
1143
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:653</li></ul></aside></div></li>
1144
+ <li class="tsd-is-external">
1145
+ <div class="tsd-signature tsd-anchor-link" id="option-3"><span class="tsd-kind-call-signature">option</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">regexp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#option-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1146
+ <div class="tsd-description">
1147
+ <div class="tsd-parameters">
1148
+ <h4 class="tsd-parameters-title">Parameters</h4>
1149
+ <ul class="tsd-parameter-list">
1150
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1151
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1152
+ <li><span><span class="tsd-kind-parameter">regexp</span>: <span class="tsd-signature-type">RegExp</span></span></li>
1153
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
1154
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
1155
+ <div class="tsd-comment tsd-typography">
1156
+ <div class="tsd-tag-deprecated">
1157
+ <h4 class="tsd-anchor-link" id="deprecated-4">Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7, instead use choices or a custom function</p>
1158
+ </div></div><aside class="tsd-sources">
1159
+ <ul>
1160
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:660</li></ul></aside></div></li></ul></section>
1161
+ <section class="tsd-panel tsd-member tsd-is-external">
1162
+ <h3 class="tsd-anchor-link" id="optionsgroup"><span>options<wbr/>Group</span><a href="#optionsgroup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1163
+ <ul class="tsd-signatures tsd-is-external">
1164
+ <li class="tsd-is-external">
1165
+ <div class="tsd-signature tsd-anchor-link" id="optionsgroup-1"><span class="tsd-kind-call-signature">optionsGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">heading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#optionsgroup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1166
+ <div class="tsd-description">
1167
+ <div class="tsd-comment tsd-typography"><p>Set the default help group heading for options added to this command.
242
1168
  (This does not override a group set directly on the option using .helpGroup().)</p>
243
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
244
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">optionsGroup</span><span class="hl-3">(</span><span class="hl-1">&#39;Development Options:&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-d, --debug&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;output extra debugging&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --profile&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;output profiling information&#39;</span><span class="hl-3">)</span>
1169
+ </div>
1170
+ <div class="tsd-parameters">
1171
+ <h4 class="tsd-parameters-title">Parameters</h4>
1172
+ <ul class="tsd-parameter-list">
1173
+ <li><span><span class="tsd-kind-parameter">heading</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1174
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1175
+
1176
+ <div class="tsd-comment tsd-typography">
1177
+ <div class="tsd-tag-example">
1178
+ <h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">program</span><br/><span class="hl-3"> .</span><span class="hl-5">optionsGroup</span><span class="hl-3">(</span><span class="hl-1">&#39;Development Options:&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-d, --debug&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;output extra debugging&#39;</span><span class="hl-3">)</span><br/><span class="hl-3"> .</span><span class="hl-5">option</span><span class="hl-3">(</span><span class="hl-1">&#39;-p, --profile&#39;</span><span class="hl-3">, </span><span class="hl-1">&#39;output profiling information&#39;</span><span class="hl-3">)</span>
245
1179
  </code><button type="button">Copy</button></pre>
246
1180
 
247
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1033</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="optionsgroup-2"><span class="tsd-kind-call-signature">optionsGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#optionsgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the default help group heading for options added to this command.</p>
248
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1037</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="opts"><span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="opts-1"><span class="tsd-kind-call-signature">opts</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a><a href="#opts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return an object containing local option values as key-value pairs</p>
249
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="optst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:878</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="optswithglobals"><span>opts<wbr/>With<wbr/>Globals</span><a href="#optswithglobals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="optswithglobals-1"><span class="tsd-kind-call-signature">optsWithGlobals</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a><a href="#optswithglobals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return an object containing merged local and global option values as key-value pairs.</p>
250
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="optswithglobalst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:883</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="outputhelp"><span>output<wbr/>Help</span><a href="#outputhelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="outputhelp-1"><span class="tsd-kind-call-signature">outputHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#outputhelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Output help information for this command.</p>
1181
+ </div></div><aside class="tsd-sources">
1182
+ <ul>
1183
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1033</li></ul></aside></div></li>
1184
+ <li class="tsd-is-external">
1185
+ <div class="tsd-signature tsd-anchor-link" id="optionsgroup-2"><span class="tsd-kind-call-signature">optionsGroup</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#optionsgroup-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1186
+ <div class="tsd-description">
1187
+ <div class="tsd-comment tsd-typography"><p>Get the default help group heading for options added to this command.</p>
1188
+ </div>
1189
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1190
+ <ul>
1191
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1037</li></ul></aside></div></li></ul></section>
1192
+ <section class="tsd-panel tsd-member tsd-is-external">
1193
+ <h3 class="tsd-anchor-link" id="opts"><span>opts</span><a href="#opts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1194
+ <ul class="tsd-signatures tsd-is-external">
1195
+ <li class="tsd-is-external">
1196
+ <div class="tsd-signature tsd-anchor-link" id="opts-1"><span class="tsd-kind-call-signature">opts</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a><a href="#opts-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1197
+ <div class="tsd-description">
1198
+ <div class="tsd-comment tsd-typography"><p>Return an object containing local option values as key-value pairs</p>
1199
+ </div>
1200
+ <section class="tsd-panel">
1201
+ <h4>Type Parameters</h4>
1202
+ <ul class="tsd-type-parameter-list">
1203
+ <li><span id="optst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section>
1204
+ <h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#optst">T</a></h4><aside class="tsd-sources">
1205
+ <ul>
1206
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:878</li></ul></aside></div></li></ul></section>
1207
+ <section class="tsd-panel tsd-member tsd-is-external">
1208
+ <h3 class="tsd-anchor-link" id="optswithglobals"><span>opts<wbr/>With<wbr/>Globals</span><a href="#optswithglobals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1209
+ <ul class="tsd-signatures tsd-is-external">
1210
+ <li class="tsd-is-external">
1211
+ <div class="tsd-signature tsd-anchor-link" id="optswithglobals-1"><span class="tsd-kind-call-signature">optsWithGlobals</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a><a href="#optswithglobals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1212
+ <div class="tsd-description">
1213
+ <div class="tsd-comment tsd-typography"><p>Return an object containing merged local and global option values as key-value pairs.</p>
1214
+ </div>
1215
+ <section class="tsd-panel">
1216
+ <h4>Type Parameters</h4>
1217
+ <ul class="tsd-type-parameter-list">
1218
+ <li><span id="optswithglobalst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section>
1219
+ <h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#optswithglobalst">T</a></h4><aside class="tsd-sources">
1220
+ <ul>
1221
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:883</li></ul></aside></div></li></ul></section>
1222
+ <section class="tsd-panel tsd-member tsd-is-external">
1223
+ <h3 class="tsd-anchor-link" id="outputhelp"><span>output<wbr/>Help</span><a href="#outputhelp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1224
+ <ul class="tsd-signatures tsd-is-external">
1225
+ <li class="tsd-is-external">
1226
+ <div class="tsd-signature tsd-anchor-link" id="outputhelp-1"><span class="tsd-kind-call-signature">outputHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HelpContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#outputhelp-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1227
+ <div class="tsd-description">
1228
+ <div class="tsd-comment tsd-typography"><p>Output help information for this command.</p>
251
1229
  <p>Outputs built-in help, and custom text added using <code>.addHelpText()</code>.</p>
252
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1045</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="outputhelp-2"><span class="tsd-kind-call-signature">outputHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#outputhelp-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-5">Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7</p>
253
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1047</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="parse"><span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="parse-1"><span class="tsd-kind-call-signature">parse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">parseOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ParseOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#parse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse <code>argv</code>, setting options and invoking commands when defined.</p>
1230
+ </div>
1231
+ <div class="tsd-parameters">
1232
+ <h4 class="tsd-parameters-title">Parameters</h4>
1233
+ <ul class="tsd-parameter-list">
1234
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">HelpContext</span></span></li></ul></div>
1235
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1236
+ <ul>
1237
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1045</li></ul></aside></div></li>
1238
+ <li class="tsd-is-external">
1239
+ <div class="tsd-signature tsd-anchor-link" id="outputhelp-2"><span class="tsd-kind-call-signature">outputHelp</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#outputhelp-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1240
+ <div class="tsd-description">
1241
+ <div class="tsd-parameters">
1242
+ <h4 class="tsd-parameters-title">Parameters</h4>
1243
+ <ul class="tsd-parameter-list">
1244
+ <li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">string</span></span></li></ul></div>
1245
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
1246
+ <div class="tsd-comment tsd-typography">
1247
+ <div class="tsd-tag-deprecated">
1248
+ <h4 class="tsd-anchor-link" id="deprecated-5">Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7</p>
1249
+ </div></div><aside class="tsd-sources">
1250
+ <ul>
1251
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:1047</li></ul></aside></div></li></ul></section>
1252
+ <section class="tsd-panel tsd-member tsd-is-external">
1253
+ <h3 class="tsd-anchor-link" id="parse"><span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1254
+ <ul class="tsd-signatures tsd-is-external">
1255
+ <li class="tsd-is-external">
1256
+ <div class="tsd-signature tsd-anchor-link" id="parse-1"><span class="tsd-kind-call-signature">parse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">parseOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ParseOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#parse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1257
+ <div class="tsd-description">
1258
+ <div class="tsd-comment tsd-typography"><p>Parse <code>argv</code>, setting options and invoking commands when defined.</p>
254
1259
  <p>Use parseAsync instead of parse if any of your action handlers are async.</p>
255
1260
  <p>Call with no parameters to parse <code>process.argv</code>. Detects Electron and special node options like <code>node --eval</code>. Easy mode!</p>
256
1261
  <p>Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are <code>from</code>:</p>
@@ -259,11 +1264,29 @@ option-argument is indicated by <code>&lt;&gt;</code> and an optional option-arg
259
1264
  <li><code>'electron'</code>: <code>argv[0]</code> is the application and <code>argv[1]</code> varies depending on whether the electron application is packaged</li>
260
1265
  <li><code>'user'</code>: just user arguments</li>
261
1266
  </ul>
262
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parseOptions</span>: <span class="tsd-signature-type">ParseOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
263
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(); </span><span class="hl-8">// parse process.argv and auto-detect electron and special node flags</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(</span><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-4">argv</span><span class="hl-3">); </span><span class="hl-8">// assume argv[0] is app and argv[1] is script</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(</span><span class="hl-4">my</span><span class="hl-3">-</span><span class="hl-4">args</span><span class="hl-3">, { </span><span class="hl-4">from:</span><span class="hl-3"> </span><span class="hl-1">&#39;user&#39;</span><span class="hl-3"> }); </span><span class="hl-8">// just user supplied arguments, nothing special about argv[0]</span>
1267
+ </div>
1268
+ <div class="tsd-parameters">
1269
+ <h4 class="tsd-parameters-title">Parameters</h4>
1270
+ <ul class="tsd-parameter-list">
1271
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li>
1272
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parseOptions</span>: <span class="tsd-signature-type">ParseOptions</span></span></li></ul></div>
1273
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1274
+
1275
+ <div class="tsd-comment tsd-typography">
1276
+ <div class="tsd-tag-example">
1277
+ <h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(); </span><span class="hl-8">// parse process.argv and auto-detect electron and special node flags</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(</span><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-4">argv</span><span class="hl-3">); </span><span class="hl-8">// assume argv[0] is app and argv[1] is script</span><br/><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parse</span><span class="hl-3">(</span><span class="hl-4">my</span><span class="hl-3">-</span><span class="hl-4">args</span><span class="hl-3">, { </span><span class="hl-4">from:</span><span class="hl-3"> </span><span class="hl-1">&#39;user&#39;</span><span class="hl-3"> }); </span><span class="hl-8">// just user supplied arguments, nothing special about argv[0]</span>
264
1278
  </code><button>Copy</button></pre>
265
1279
 
266
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:819</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="parseasync"><span>parse<wbr/>Async</span><a href="#parseasync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="parseasync-1"><span class="tsd-kind-call-signature">parseAsync</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ParseOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">&gt;</span><a href="#parseasync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse <code>argv</code>, setting options and invoking commands when defined.</p>
1280
+ </div></div><aside class="tsd-sources">
1281
+ <ul>
1282
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:819</li></ul></aside></div></li></ul></section>
1283
+ <section class="tsd-panel tsd-member tsd-is-external">
1284
+ <h3 class="tsd-anchor-link" id="parseasync"><span>parse<wbr/>Async</span><a href="#parseasync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1285
+ <ul class="tsd-signatures tsd-is-external">
1286
+ <li class="tsd-is-external">
1287
+ <div class="tsd-signature tsd-anchor-link" id="parseasync-1"><span class="tsd-kind-call-signature">parseAsync</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ParseOptions</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">&gt;</span><a href="#parseasync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1288
+ <div class="tsd-description">
1289
+ <div class="tsd-comment tsd-typography"><p>Parse <code>argv</code>, setting options and invoking commands when defined.</p>
267
1290
  <p>Call with no parameters to parse <code>process.argv</code>. Detects Electron and special node options like <code>node --eval</code>. Easy mode!</p>
268
1291
  <p>Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are <code>from</code>:</p>
269
1292
  <ul>
@@ -271,11 +1294,29 @@ option-argument is indicated by <code>&lt;&gt;</code> and an optional option-arg
271
1294
  <li><code>'electron'</code>: <code>argv[0]</code> is the application and <code>argv[1]</code> varies depending on whether the electron application is packaged</li>
272
1295
  <li><code>'user'</code>: just user arguments</li>
273
1296
  </ul>
274
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parseOptions</span>: <span class="tsd-signature-type">ParseOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise</p>
275
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-16">Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(); </span><span class="hl-8">// parse process.argv and auto-detect electron and special node flags</span><br/><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(</span><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-4">argv</span><span class="hl-3">); </span><span class="hl-8">// assume argv[0] is app and argv[1] is script</span><br/><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(</span><span class="hl-4">my</span><span class="hl-3">-</span><span class="hl-4">args</span><span class="hl-3">, { </span><span class="hl-4">from:</span><span class="hl-3"> </span><span class="hl-1">&#39;user&#39;</span><span class="hl-3"> }); </span><span class="hl-8">// just user supplied arguments, nothing special about argv[0]</span>
1297
+ </div>
1298
+ <div class="tsd-parameters">
1299
+ <h4 class="tsd-parameters-title">Parameters</h4>
1300
+ <ul class="tsd-parameter-list">
1301
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-keyword">readonly</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li>
1302
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parseOptions</span>: <span class="tsd-signature-type">ParseOptions</span></span></li></ul></div>
1303
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="" class="tsd-signature-type tsd-kind-class">Command</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise</p>
1304
+
1305
+ <div class="tsd-comment tsd-typography">
1306
+ <div class="tsd-tag-example">
1307
+ <h4 class="tsd-anchor-link" id="example-16">Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(); </span><span class="hl-8">// parse process.argv and auto-detect electron and special node flags</span><br/><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(</span><span class="hl-4">process</span><span class="hl-3">.</span><span class="hl-4">argv</span><span class="hl-3">); </span><span class="hl-8">// assume argv[0] is app and argv[1] is script</span><br/><span class="hl-6">await</span><span class="hl-3"> </span><span class="hl-4">program</span><span class="hl-3">.</span><span class="hl-5">parseAsync</span><span class="hl-3">(</span><span class="hl-4">my</span><span class="hl-3">-</span><span class="hl-4">args</span><span class="hl-3">, { </span><span class="hl-4">from:</span><span class="hl-3"> </span><span class="hl-1">&#39;user&#39;</span><span class="hl-3"> }); </span><span class="hl-8">// just user supplied arguments, nothing special about argv[0]</span>
276
1308
  </code><button>Copy</button></pre>
277
1309
 
278
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:840</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="parseoptions"><span>parse<wbr/>Options</span><a href="#parseoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="parseoptions-1"><span class="tsd-kind-call-signature">parseOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ParseOptionsResult</span><a href="#parseoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse options from <code>argv</code> removing known options,
1310
+ </div></div><aside class="tsd-sources">
1311
+ <ul>
1312
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:840</li></ul></aside></div></li></ul></section>
1313
+ <section class="tsd-panel tsd-member tsd-is-external">
1314
+ <h3 class="tsd-anchor-link" id="parseoptions"><span>parse<wbr/>Options</span><a href="#parseoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1315
+ <ul class="tsd-signatures tsd-is-external">
1316
+ <li class="tsd-is-external">
1317
+ <div class="tsd-signature tsd-anchor-link" id="parseoptions-1"><span class="tsd-kind-call-signature">parseOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">argv</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ParseOptionsResult</span><a href="#parseoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1318
+ <div class="tsd-description">
1319
+ <div class="tsd-comment tsd-typography"><p>Parse options from <code>argv</code> removing known options,
279
1320
  and return argv split into operands and unknown arguments.</p>
280
1321
  <p>Side effects: modifies command by storing options. Does not reset state if called again.</p>
281
1322
  <pre><code>argv =&gt; operands, unknown
@@ -284,46 +1325,328 @@ op --known kkk =&gt; [op], []
284
1325
  sub --unknown uuu op =&gt; [sub], [--unknown uuu op]
285
1326
  sub -- --unknown uuu op =&gt; [sub --unknown uuu op], []
286
1327
  </code></pre>
287
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParseOptionsResult</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:873</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="passthroughoptions"><span>pass<wbr/>Through<wbr/>Options</span><a href="#passthroughoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="passthroughoptions-1"><span class="tsd-kind-call-signature">passThroughOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passThrough</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#passthroughoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Pass through options that come after command-arguments rather than treat them as command-options,
1328
+ </div>
1329
+ <div class="tsd-parameters">
1330
+ <h4 class="tsd-parameters-title">Parameters</h4>
1331
+ <ul class="tsd-parameter-list">
1332
+ <li><span><span class="tsd-kind-parameter">argv</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
1333
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ParseOptionsResult</span></h4><aside class="tsd-sources">
1334
+ <ul>
1335
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:873</li></ul></aside></div></li></ul></section>
1336
+ <section class="tsd-panel tsd-member tsd-is-external">
1337
+ <h3 class="tsd-anchor-link" id="passthroughoptions"><span>pass<wbr/>Through<wbr/>Options</span><a href="#passthroughoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1338
+ <ul class="tsd-signatures tsd-is-external">
1339
+ <li class="tsd-is-external">
1340
+ <div class="tsd-signature tsd-anchor-link" id="passthroughoptions-1"><span class="tsd-kind-call-signature">passThroughOptions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">passThrough</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#passthroughoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1341
+ <div class="tsd-description">
1342
+ <div class="tsd-comment tsd-typography"><p>Pass through options that come after command-arguments rather than treat them as command-options,
288
1343
  so actual command-options come before command-arguments. Turning this on for a subcommand requires
289
1344
  positional options to have been enabled on the program (parent commands).</p>
290
1345
  <p>The default behaviour is non-positional and options may appear before or after command-arguments.</p>
291
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">passThrough</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
292
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:796</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="requiredoption"><span>required<wbr/>Option</span><a href="#requiredoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="requiredoption-1"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define a required option, which must have a value after parsing. This usually means
1346
+ </div>
1347
+ <div class="tsd-parameters">
1348
+ <h4 class="tsd-parameters-title">Parameters</h4>
1349
+ <ul class="tsd-parameter-list">
1350
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">passThrough</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
1351
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1352
+ <aside class="tsd-sources">
1353
+ <ul>
1354
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:796</li></ul></aside></div></li></ul></section>
1355
+ <section class="tsd-panel tsd-member tsd-is-external">
1356
+ <h3 class="tsd-anchor-link" id="requiredoption"><span>required<wbr/>Option</span><a href="#requiredoption" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1357
+ <ul class="tsd-signatures tsd-is-external">
1358
+ <li class="tsd-is-external">
1359
+ <div class="tsd-signature tsd-anchor-link" id="requiredoption-1"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1360
+ <div class="tsd-description">
1361
+ <div class="tsd-comment tsd-typography"><p>Define a required option, which must have a value after parsing. This usually means
293
1362
  the option must be specified on the command line. (Otherwise the same as .option().)</p>
294
1363
  <p>The <code>flags</code> string contains the short and/or long flags, separated by comma, a pipe or space.</p>
295
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:673</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="requiredoption-2"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Define a required option, which must have a value after parsing. This usually means
1364
+ </div>
1365
+ <div class="tsd-parameters">
1366
+ <h4 class="tsd-parameters-title">Parameters</h4>
1367
+ <ul class="tsd-parameter-list">
1368
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1369
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1370
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
1371
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1372
+ <ul>
1373
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:673</li></ul></aside></div></li>
1374
+ <li class="tsd-is-external">
1375
+ <div class="tsd-signature tsd-anchor-link" id="requiredoption-2"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parseArg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1376
+ <div class="tsd-description">
1377
+ <div class="tsd-comment tsd-typography"><p>Define a required option, which must have a value after parsing. This usually means
296
1378
  the option must be specified on the command line. (Otherwise the same as .option().)</p>
297
1379
  <p>The <code>flags</code> string contains the short and/or long flags, separated by comma, a pipe or space.</p>
298
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="requiredoptiont"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:678</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="requiredoption-3"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">regexp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">regexp</span>: <span class="tsd-signature-type">RegExp</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-6">Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7, instead use choices or a custom function</p>
299
- </div></div><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:685</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="restorestatebeforeparse"><span>restore<wbr/>State<wbr/>Before<wbr/>Parse</span><a href="#restorestatebeforeparse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="restorestatebeforeparse-1"><span class="tsd-kind-call-signature">restoreStateBeforeParse</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#restorestatebeforeparse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Restore state before parse for calls after the first.
1380
+ </div>
1381
+ <section class="tsd-panel">
1382
+ <h4>Type Parameters</h4>
1383
+ <ul class="tsd-type-parameter-list">
1384
+ <li><span id="requiredoptiont"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section>
1385
+ <div class="tsd-parameters">
1386
+ <h4 class="tsd-parameters-title">Parameters</h4>
1387
+ <ul class="tsd-parameter-list">
1388
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1389
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1390
+ <li><span><span class="tsd-kind-parameter">parseArg</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">previous</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a></span></li>
1391
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#requiredoptiont">T</a></span></li></ul></div>
1392
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1393
+ <ul>
1394
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:678</li></ul></aside></div></li>
1395
+ <li class="tsd-is-external">
1396
+ <div class="tsd-signature tsd-anchor-link" id="requiredoption-3"><span class="tsd-kind-call-signature">requiredOption</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">regexp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#requiredoption-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1397
+ <div class="tsd-description">
1398
+ <div class="tsd-parameters">
1399
+ <h4 class="tsd-parameters-title">Parameters</h4>
1400
+ <ul class="tsd-parameter-list">
1401
+ <li><span><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1402
+ <li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li>
1403
+ <li><span><span class="tsd-kind-parameter">regexp</span>: <span class="tsd-signature-type">RegExp</span></span></li>
1404
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div>
1405
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
1406
+ <div class="tsd-comment tsd-typography">
1407
+ <div class="tsd-tag-deprecated">
1408
+ <h4 class="tsd-anchor-link" id="deprecated-6">Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v7, instead use choices or a custom function</p>
1409
+ </div></div><aside class="tsd-sources">
1410
+ <ul>
1411
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:685</li></ul></aside></div></li></ul></section>
1412
+ <section class="tsd-panel tsd-member tsd-is-external">
1413
+ <h3 class="tsd-anchor-link" id="restorestatebeforeparse"><span>restore<wbr/>State<wbr/>Before<wbr/>Parse</span><a href="#restorestatebeforeparse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1414
+ <ul class="tsd-signatures tsd-is-external">
1415
+ <li class="tsd-is-external">
1416
+ <div class="tsd-signature tsd-anchor-link" id="restorestatebeforeparse-1"><span class="tsd-kind-call-signature">restoreStateBeforeParse</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#restorestatebeforeparse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1417
+ <div class="tsd-description">
1418
+ <div class="tsd-comment tsd-typography"><p>Restore state before parse for calls after the first.
300
1419
  Not usually called directly, but available for subclasses to save their custom state.</p>
301
1420
  <p>This is called in a lazy way. Only commands used in parsing chain will have state restored.</p>
302
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:859</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="savestatebeforeparse"><span>save<wbr/>State<wbr/>Before<wbr/>Parse</span><a href="#savestatebeforeparse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="savestatebeforeparse-1"><span class="tsd-kind-call-signature">saveStateBeforeParse</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#savestatebeforeparse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Called the first time parse is called to save state and allow a restore before subsequent calls to parse.
1421
+ </div>
1422
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1423
+ <ul>
1424
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:859</li></ul></aside></div></li></ul></section>
1425
+ <section class="tsd-panel tsd-member tsd-is-external">
1426
+ <h3 class="tsd-anchor-link" id="savestatebeforeparse"><span>save<wbr/>State<wbr/>Before<wbr/>Parse</span><a href="#savestatebeforeparse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1427
+ <ul class="tsd-signatures tsd-is-external">
1428
+ <li class="tsd-is-external">
1429
+ <div class="tsd-signature tsd-anchor-link" id="savestatebeforeparse-1"><span class="tsd-kind-call-signature">saveStateBeforeParse</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#savestatebeforeparse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1430
+ <div class="tsd-description">
1431
+ <div class="tsd-comment tsd-typography"><p>Called the first time parse is called to save state and allow a restore before subsequent calls to parse.
303
1432
  Not usually called directly, but available for subclasses to save their custom state.</p>
304
1433
  <p>This is called in a lazy way. Only commands used in parsing chain will have state saved.</p>
305
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:851</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="setoptionvalue"><span>set<wbr/>Option<wbr/>Value</span><a href="#setoptionvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setoptionvalue-1"><span class="tsd-kind-call-signature">setOptionValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setoptionvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Store option value.</p>
306
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:728</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="setoptionvaluewithsource"><span>set<wbr/>Option<wbr/>Value<wbr/>With<wbr/>Source</span><a href="#setoptionvaluewithsource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="setoptionvaluewithsource-1"><span class="tsd-kind-call-signature">setOptionValueWithSource</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setoptionvaluewithsource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Store option value and where the value came from.</p>
307
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">unknown</span></span></li><li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">OptionValueSource</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:733</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="showhelpaftererror"><span>show<wbr/>Help<wbr/>After<wbr/>Error</span><a href="#showhelpaftererror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="showhelpaftererror-1"><span class="tsd-kind-call-signature">showHelpAfterError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">displayHelp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#showhelpaftererror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Display the help or a custom message after an error occurs.</p>
308
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">displayHelp</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:604</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="showsuggestionaftererror"><span>show<wbr/>Suggestion<wbr/>After<wbr/>Error</span><a href="#showsuggestionaftererror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="showsuggestionaftererror-1"><span class="tsd-kind-call-signature">showSuggestionAfterError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">displaySuggestion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#showsuggestionaftererror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Display suggestion of similar commands for unknown commands, or options for unknown options.</p>
309
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">displaySuggestion</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:609</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="storeoptionsasproperties"><span>store<wbr/>Options<wbr/>As<wbr/>Properties</span><a href="#storeoptionsasproperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-1"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a><a href="#storeoptionsasproperties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
1434
+ </div>
1435
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
1436
+ <ul>
1437
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:851</li></ul></aside></div></li></ul></section>
1438
+ <section class="tsd-panel tsd-member tsd-is-external">
1439
+ <h3 class="tsd-anchor-link" id="setoptionvalue"><span>set<wbr/>Option<wbr/>Value</span><a href="#setoptionvalue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1440
+ <ul class="tsd-signatures tsd-is-external">
1441
+ <li class="tsd-is-external">
1442
+ <div class="tsd-signature tsd-anchor-link" id="setoptionvalue-1"><span class="tsd-kind-call-signature">setOptionValue</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setoptionvalue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1443
+ <div class="tsd-description">
1444
+ <div class="tsd-comment tsd-typography"><p>Store option value.</p>
1445
+ </div>
1446
+ <div class="tsd-parameters">
1447
+ <h4 class="tsd-parameters-title">Parameters</h4>
1448
+ <ul class="tsd-parameter-list">
1449
+ <li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li>
1450
+ <li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">unknown</span></span></li></ul></div>
1451
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1452
+ <ul>
1453
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:728</li></ul></aside></div></li></ul></section>
1454
+ <section class="tsd-panel tsd-member tsd-is-external">
1455
+ <h3 class="tsd-anchor-link" id="setoptionvaluewithsource"><span>set<wbr/>Option<wbr/>Value<wbr/>With<wbr/>Source</span><a href="#setoptionvaluewithsource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1456
+ <ul class="tsd-signatures tsd-is-external">
1457
+ <li class="tsd-is-external">
1458
+ <div class="tsd-signature tsd-anchor-link" id="setoptionvaluewithsource-1"><span class="tsd-kind-call-signature">setOptionValueWithSource</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OptionValueSource</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#setoptionvaluewithsource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1459
+ <div class="tsd-description">
1460
+ <div class="tsd-comment tsd-typography"><p>Store option value and where the value came from.</p>
1461
+ </div>
1462
+ <div class="tsd-parameters">
1463
+ <h4 class="tsd-parameters-title">Parameters</h4>
1464
+ <ul class="tsd-parameter-list">
1465
+ <li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span></li>
1466
+ <li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">unknown</span></span></li>
1467
+ <li><span><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type">OptionValueSource</span></span></li></ul></div>
1468
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1469
+ <ul>
1470
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:733</li></ul></aside></div></li></ul></section>
1471
+ <section class="tsd-panel tsd-member tsd-is-external">
1472
+ <h3 class="tsd-anchor-link" id="showhelpaftererror"><span>show<wbr/>Help<wbr/>After<wbr/>Error</span><a href="#showhelpaftererror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1473
+ <ul class="tsd-signatures tsd-is-external">
1474
+ <li class="tsd-is-external">
1475
+ <div class="tsd-signature tsd-anchor-link" id="showhelpaftererror-1"><span class="tsd-kind-call-signature">showHelpAfterError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">displayHelp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#showhelpaftererror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1476
+ <div class="tsd-description">
1477
+ <div class="tsd-comment tsd-typography"><p>Display the help or a custom message after an error occurs.</p>
1478
+ </div>
1479
+ <div class="tsd-parameters">
1480
+ <h4 class="tsd-parameters-title">Parameters</h4>
1481
+ <ul class="tsd-parameter-list">
1482
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">displayHelp</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span></span></li></ul></div>
1483
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1484
+ <ul>
1485
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:604</li></ul></aside></div></li></ul></section>
1486
+ <section class="tsd-panel tsd-member tsd-is-external">
1487
+ <h3 class="tsd-anchor-link" id="showsuggestionaftererror"><span>show<wbr/>Suggestion<wbr/>After<wbr/>Error</span><a href="#showsuggestionaftererror" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1488
+ <ul class="tsd-signatures tsd-is-external">
1489
+ <li class="tsd-is-external">
1490
+ <div class="tsd-signature tsd-anchor-link" id="showsuggestionaftererror-1"><span class="tsd-kind-call-signature">showSuggestionAfterError</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">displaySuggestion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#showsuggestionaftererror-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1491
+ <div class="tsd-description">
1492
+ <div class="tsd-comment tsd-typography"><p>Display suggestion of similar commands for unknown commands, or options for unknown options.</p>
1493
+ </div>
1494
+ <div class="tsd-parameters">
1495
+ <h4 class="tsd-parameters-title">Parameters</h4>
1496
+ <ul class="tsd-parameter-list">
1497
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">displaySuggestion</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
1498
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1499
+ <ul>
1500
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:609</li></ul></aside></div></li></ul></section>
1501
+ <section class="tsd-panel tsd-member tsd-is-external">
1502
+ <h3 class="tsd-anchor-link" id="storeoptionsasproperties"><span>store<wbr/>Options<wbr/>As<wbr/>Properties</span><a href="#storeoptionsasproperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1503
+ <ul class="tsd-signatures tsd-is-external">
1504
+ <li class="tsd-is-external">
1505
+ <div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-1"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a><a href="#storeoptionsasproperties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1506
+ <div class="tsd-description">
1507
+ <div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
310
1508
  or store separately (specify false). In both cases the option values can be accessed using .opts().</p>
311
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="storeoptionsaspropertiest"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a></h4><p><code>this</code> command for chaining</p>
312
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:714</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-2"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">storeAsProperties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a><a href="#storeoptionsasproperties-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
1509
+ </div>
1510
+ <section class="tsd-panel">
1511
+ <h4>Type Parameters</h4>
1512
+ <ul class="tsd-type-parameter-list">
1513
+ <li><span id="storeoptionsaspropertiest"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section>
1514
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest">T</a></h4><p><code>this</code> command for chaining</p>
1515
+ <aside class="tsd-sources">
1516
+ <ul>
1517
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:714</li></ul></aside></div></li>
1518
+ <li class="tsd-is-external">
1519
+ <div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-2"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">storeAsProperties</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a><a href="#storeoptionsasproperties-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1520
+ <div class="tsd-description">
1521
+ <div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
313
1522
  or store separately (specify false). In both cases the option values can be accessed using .opts().</p>
314
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="storeoptionsaspropertiest-1"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">storeAsProperties</span>: <span class="tsd-signature-type">true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a></h4><p><code>this</code> command for chaining</p>
315
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:715</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-3"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">storeAsProperties</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#storeoptionsasproperties-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
1523
+ </div>
1524
+ <section class="tsd-panel">
1525
+ <h4>Type Parameters</h4>
1526
+ <ul class="tsd-type-parameter-list">
1527
+ <li><span id="storeoptionsaspropertiest-1"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">OptionValues</span></span></li></ul></section>
1528
+ <div class="tsd-parameters">
1529
+ <h4 class="tsd-parameters-title">Parameters</h4>
1530
+ <ul class="tsd-parameter-list">
1531
+ <li><span><span class="tsd-kind-parameter">storeAsProperties</span>: <span class="tsd-signature-type">true</span></span></li></ul></div>
1532
+ <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Command</a> <span class="tsd-signature-symbol">&amp;</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#storeoptionsaspropertiest-1">T</a></h4><p><code>this</code> command for chaining</p>
1533
+ <aside class="tsd-sources">
1534
+ <ul>
1535
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:715</li></ul></aside></div></li>
1536
+ <li class="tsd-is-external">
1537
+ <div class="tsd-signature tsd-anchor-link" id="storeoptionsasproperties-3"><span class="tsd-kind-call-signature">storeOptionsAsProperties</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">storeAsProperties</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#storeoptionsasproperties-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1538
+ <div class="tsd-description">
1539
+ <div class="tsd-comment tsd-typography"><p>Whether to store option values as properties on command object,
316
1540
  or store separately (specify false). In both cases the option values can be accessed using .opts().</p>
317
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">storeAsProperties</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
318
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:718</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="summary"><span>summary</span><a href="#summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="summary-1"><span class="tsd-kind-call-signature">summary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#summary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the summary. Used when listed as subcommand of parent.</p>
319
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
320
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:905</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="summary-2"><span class="tsd-kind-call-signature">summary</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#summary-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the summary.</p>
321
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:909</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="usage"><span>usage</span><a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="usage-1"><span class="tsd-kind-call-signature">usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#usage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the command usage.</p>
322
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
323
- <aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:942</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="usage-2"><span class="tsd-kind-call-signature">usage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#usage-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the command usage.</p>
324
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:946</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-external"><h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-external"><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="version-1"><span class="tsd-kind-call-signature">version</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the program version to <code>str</code>.</p>
1541
+ </div>
1542
+ <div class="tsd-parameters">
1543
+ <h4 class="tsd-parameters-title">Parameters</h4>
1544
+ <ul class="tsd-parameter-list">
1545
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">storeAsProperties</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
1546
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1547
+ <aside class="tsd-sources">
1548
+ <ul>
1549
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:718</li></ul></aside></div></li></ul></section>
1550
+ <section class="tsd-panel tsd-member tsd-is-external">
1551
+ <h3 class="tsd-anchor-link" id="summary"><span>summary</span><a href="#summary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1552
+ <ul class="tsd-signatures tsd-is-external">
1553
+ <li class="tsd-is-external">
1554
+ <div class="tsd-signature tsd-anchor-link" id="summary-1"><span class="tsd-kind-call-signature">summary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#summary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1555
+ <div class="tsd-description">
1556
+ <div class="tsd-comment tsd-typography"><p>Set the summary. Used when listed as subcommand of parent.</p>
1557
+ </div>
1558
+ <div class="tsd-parameters">
1559
+ <h4 class="tsd-parameters-title">Parameters</h4>
1560
+ <ul class="tsd-parameter-list">
1561
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1562
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1563
+ <aside class="tsd-sources">
1564
+ <ul>
1565
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:905</li></ul></aside></div></li>
1566
+ <li class="tsd-is-external">
1567
+ <div class="tsd-signature tsd-anchor-link" id="summary-2"><span class="tsd-kind-call-signature">summary</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#summary-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1568
+ <div class="tsd-description">
1569
+ <div class="tsd-comment tsd-typography"><p>Get the summary.</p>
1570
+ </div>
1571
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1572
+ <ul>
1573
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:909</li></ul></aside></div></li></ul></section>
1574
+ <section class="tsd-panel tsd-member tsd-is-external">
1575
+ <h3 class="tsd-anchor-link" id="usage"><span>usage</span><a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1576
+ <ul class="tsd-signatures tsd-is-external">
1577
+ <li class="tsd-is-external">
1578
+ <div class="tsd-signature tsd-anchor-link" id="usage-1"><span class="tsd-kind-call-signature">usage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#usage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1579
+ <div class="tsd-description">
1580
+ <div class="tsd-comment tsd-typography"><p>Set the command usage.</p>
1581
+ </div>
1582
+ <div class="tsd-parameters">
1583
+ <h4 class="tsd-parameters-title">Parameters</h4>
1584
+ <ul class="tsd-parameter-list">
1585
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1586
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p><code>this</code> command for chaining</p>
1587
+ <aside class="tsd-sources">
1588
+ <ul>
1589
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:942</li></ul></aside></div></li>
1590
+ <li class="tsd-is-external">
1591
+ <div class="tsd-signature tsd-anchor-link" id="usage-2"><span class="tsd-kind-call-signature">usage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#usage-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1592
+ <div class="tsd-description">
1593
+ <div class="tsd-comment tsd-typography"><p>Get the command usage.</p>
1594
+ </div>
1595
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1596
+ <ul>
1597
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:946</li></ul></aside></div></li></ul></section>
1598
+ <section class="tsd-panel tsd-member tsd-is-external">
1599
+ <h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1600
+ <ul class="tsd-signatures tsd-is-external">
1601
+ <li class="tsd-is-external">
1602
+ <div class="tsd-signature tsd-anchor-link" id="version-1"><span class="tsd-kind-call-signature">version</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">flags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1603
+ <div class="tsd-description">
1604
+ <div class="tsd-comment tsd-typography"><p>Set the program version to <code>str</code>.</p>
325
1605
  <p>This method auto-registers the &quot;-V, --version&quot; flag
326
1606
  which will print the version number when passed.</p>
327
1607
  <p>You can optionally supply the flags and description to override the defaults.</p>
328
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:394</li></ul></aside></div></li><li class="tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="version-2"><span class="tsd-kind-call-signature">version</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#version-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the program version.</p>
329
- </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:398</li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#args" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>args</span></a><a href="#commands" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commands</span></a><a href="#options" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#parent" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#processedargs" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>processed<wbr/>Args</span></a><a href="#registeredarguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>registered<wbr/>Arguments</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#action" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action</span></a><a href="#addargument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Argument</span></a><a href="#addcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Command</span></a><a href="#addhelpcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Command</span></a><a href="#addhelpoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Option</span></a><a href="#addhelptext" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Text</span></a><a href="#addoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Option</span></a><a href="#alias" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>alias</span></a><a href="#aliases" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aliases</span></a><a href="#allowexcessarguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>allow<wbr/>Excess<wbr/>Arguments</span></a><a href="#allowunknownoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>allow<wbr/>Unknown<wbr/>Option</span></a><a href="#argument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>argument</span></a><a href="#arguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>arguments</span></a><a href="#combineflagandoptionalvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>combine<wbr/>Flag<wbr/>And<wbr/>Optional<wbr/>Value</span></a><a href="#command" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>command</span></a><a href="#commandsgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>commands<wbr/>Group</span></a><a href="#configurehelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Help</span></a><a href="#configureoutput" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Output</span></a><a href="#copyinheritedsettings" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Inherited<wbr/>Settings</span></a><a href="#createargument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Argument</span></a><a href="#createcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Command</span></a><a href="#createhelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Help</span></a><a href="#createoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Option</span></a><a href="#description" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>description</span></a><a href="#enablepositionaloptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Positional<wbr/>Options</span></a><a href="#error" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>error</span></a><a href="#executabledir" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>executable<wbr/>Dir</span></a><a href="#exitoverride" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exit<wbr/>Override</span></a><a href="#getoptionvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value</span></a><a href="#getoptionvaluesource" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value<wbr/>Source</span></a><a href="#getoptionvaluesourcewithglobals" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value<wbr/>Source<wbr/>With<wbr/>Globals</span></a><a href="#help" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help</span></a><a href="#helpcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Command</span></a><a href="#helpgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Group</span></a><a href="#helpinformation" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Information</span></a><a href="#helpoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Option</span></a><a href="#hook" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hook</span></a><a href="#name" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a><a href="#namefromfilename" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name<wbr/>From<wbr/>Filename</span></a><a href="#on" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#option" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>option</span></a><a href="#optionsgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>options<wbr/>Group</span></a><a href="#opts" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>opts</span></a><a href="#optswithglobals" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>opts<wbr/>With<wbr/>Globals</span></a><a href="#outputhelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>output<wbr/>Help</span></a><a href="#parse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse</span></a><a href="#parseasync" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Async</span></a><a href="#parseoptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Options</span></a><a href="#passthroughoptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pass<wbr/>Through<wbr/>Options</span></a><a href="#requiredoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>required<wbr/>Option</span></a><a href="#restorestatebeforeparse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>State<wbr/>Before<wbr/>Parse</span></a><a href="#savestatebeforeparse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>State<wbr/>Before<wbr/>Parse</span></a><a href="#setoptionvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Option<wbr/>Value</span></a><a href="#setoptionvaluewithsource" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Option<wbr/>Value<wbr/>With<wbr/>Source</span></a><a href="#showhelpaftererror" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Help<wbr/>After<wbr/>Error</span></a><a href="#showsuggestionaftererror" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Suggestion<wbr/>After<wbr/>Error</span></a><a href="#storeoptionsasproperties" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>store<wbr/>Options<wbr/>As<wbr/>Properties</span></a><a href="#summary" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>summary</span></a><a href="#usage" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>usage</span></a><a href="#version" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>version</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1608
+ </div>
1609
+ <div class="tsd-parameters">
1610
+ <h4 class="tsd-parameters-title">Parameters</h4>
1611
+ <ul class="tsd-parameter-list">
1612
+ <li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span></li>
1613
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">flags</span>: <span class="tsd-signature-type">string</span></span></li>
1614
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1615
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><aside class="tsd-sources">
1616
+ <ul>
1617
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:394</li></ul></aside></div></li>
1618
+ <li class="tsd-is-external">
1619
+ <div class="tsd-signature tsd-anchor-link" id="version-2"><span class="tsd-kind-call-signature">version</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#version-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1620
+ <div class="tsd-description">
1621
+ <div class="tsd-comment tsd-typography"><p>Get the program version.</p>
1622
+ </div>
1623
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
1624
+ <ul>
1625
+ <li>Defined in node_modules/.pnpm/commander@14.0.3/node_modules/commander/typings/index.d.ts:398</li></ul></aside></div></li></ul></section></section></details></div>
1626
+ <div class="col-sidebar">
1627
+ <div class="page-menu">
1628
+ <div class="tsd-navigation settings">
1629
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1630
+ <h3>Settings</h3></summary>
1631
+ <div class="tsd-accordion-details">
1632
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
1633
+ <ul id="tsd-filter-options">
1634
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
1635
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
1636
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
1637
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
1638
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1639
+ <h3>On This Page</h3></summary>
1640
+ <div class="tsd-accordion-details">
1641
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
1642
+ <div><a href="#constructor" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
1643
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
1644
+ <div><a href="#args" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>args</span></a><a href="#commands" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commands</span></a><a href="#options" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#parent" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#processedargs" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>processed<wbr/>Args</span></a><a href="#registeredarguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>registered<wbr/>Arguments</span></a></div></details>
1645
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
1646
+ <div><a href="#action" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>action</span></a><a href="#addargument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Argument</span></a><a href="#addcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Command</span></a><a href="#addhelpcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Command</span></a><a href="#addhelpoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Option</span></a><a href="#addhelptext" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Help<wbr/>Text</span></a><a href="#addoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Option</span></a><a href="#alias" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>alias</span></a><a href="#aliases" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aliases</span></a><a href="#allowexcessarguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>allow<wbr/>Excess<wbr/>Arguments</span></a><a href="#allowunknownoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>allow<wbr/>Unknown<wbr/>Option</span></a><a href="#argument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>argument</span></a><a href="#arguments" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>arguments</span></a><a href="#combineflagandoptionalvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>combine<wbr/>Flag<wbr/>And<wbr/>Optional<wbr/>Value</span></a><a href="#command" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>command</span></a><a href="#commandsgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>commands<wbr/>Group</span></a><a href="#configurehelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Help</span></a><a href="#configureoutput" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure<wbr/>Output</span></a><a href="#copyinheritedsettings" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy<wbr/>Inherited<wbr/>Settings</span></a><a href="#createargument" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Argument</span></a><a href="#createcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Command</span></a><a href="#createhelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Help</span></a><a href="#createoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Option</span></a><a href="#description" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>description</span></a><a href="#enablepositionaloptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Positional<wbr/>Options</span></a><a href="#error" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>error</span></a><a href="#executabledir" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>executable<wbr/>Dir</span></a><a href="#exitoverride" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>exit<wbr/>Override</span></a><a href="#getoptionvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value</span></a><a href="#getoptionvaluesource" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value<wbr/>Source</span></a><a href="#getoptionvaluesourcewithglobals" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Option<wbr/>Value<wbr/>Source<wbr/>With<wbr/>Globals</span></a><a href="#help" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help</span></a><a href="#helpcommand" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Command</span></a><a href="#helpgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Group</span></a><a href="#helpinformation" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Information</span></a><a href="#helpoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>help<wbr/>Option</span></a><a href="#hook" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hook</span></a><a href="#name" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name</span></a><a href="#namefromfilename" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>name<wbr/>From<wbr/>Filename</span></a><a href="#on" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#option" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>option</span></a><a href="#optionsgroup" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>options<wbr/>Group</span></a><a href="#opts" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>opts</span></a><a href="#optswithglobals" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>opts<wbr/>With<wbr/>Globals</span></a><a href="#outputhelp" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>output<wbr/>Help</span></a><a href="#parse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse</span></a><a href="#parseasync" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Async</span></a><a href="#parseoptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse<wbr/>Options</span></a><a href="#passthroughoptions" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pass<wbr/>Through<wbr/>Options</span></a><a href="#requiredoption" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>required<wbr/>Option</span></a><a href="#restorestatebeforeparse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore<wbr/>State<wbr/>Before<wbr/>Parse</span></a><a href="#savestatebeforeparse" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>State<wbr/>Before<wbr/>Parse</span></a><a href="#setoptionvalue" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Option<wbr/>Value</span></a><a href="#setoptionvaluewithsource" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Option<wbr/>Value<wbr/>With<wbr/>Source</span></a><a href="#showhelpaftererror" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Help<wbr/>After<wbr/>Error</span></a><a href="#showsuggestionaftererror" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Suggestion<wbr/>After<wbr/>Error</span></a><a href="#storeoptionsasproperties" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>store<wbr/>Options<wbr/>As<wbr/>Properties</span></a><a href="#summary" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>summary</span></a><a href="#usage" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>usage</span></a><a href="#version" class="tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>version</span></a></div></details></div></details></div>
1647
+ <div class="site-menu">
1648
+ <nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a>
1649
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
1650
+ <li>Loading...</li></ul></nav></div></div></div><footer>
1651
+ <p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
1652
+ <div class="overlay"></div></body></html>