@dsh-cc/command-help 0.5.0

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.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # @dsh-cc/command-help
2
+
3
+ English | [中文](README.zh.md)
4
+
5
+ Human-facing `/help` command that lists every registered slash command, or shows the detail for one named command (including its input hint). The plugin registers one global command through [`ctx.commands`](../../interaction/commands/README.md), so every composed command adapter discovers and executes it without a model turn.
6
+
7
+ ## Command contract
8
+
9
+ | Input | Result |
10
+ |---|---|
11
+ | `/help` | List every registered command as `/name — description`, sorted by name. |
12
+ | `/help <cmd>` | Show one command's detail (name, description, and input hint when declared). An unknown command yields a friendly notice. |
13
+
14
+ Command details come from the command registry itself; only commands registered in the current composition are shown.
15
+
16
+ ## Composition
17
+
18
+ The plugin injects `commands`. A custom app mounts the owners plus this plugin:
19
+
20
+ ```yaml
21
+ - id: commands
22
+ name: '@deepseek-ai/dsh-commands'
23
+ - id: command-help
24
+ name: '@dsh-cc/command-help'
25
+ ```
26
+
27
+ ## Model Experience
28
+
29
+ The slash input and output are absent from model requests and consume no model tokens. Presentation text is never logged.
30
+
31
+ ## Known Limitations and Deferred Work
32
+
33
+ - **Registry-scoped view** — only commands registered in the current composition are listed; a command mounted under another agent scope is not shown.
package/README.zh.md ADDED
@@ -0,0 +1,33 @@
1
+ # @dsh-cc/command-help
2
+
3
+ [English](README.md) | 中文
4
+
5
+ 面向用户的 `/help` 命令:列出每个已注册的斜杠命令,或显示某个命名命令的详情(含输入提示)。该插件通过 [`ctx.commands`](../../interaction/commands/README.md) 注册一个全局命令,因此每个已组合的命令适配器都能发现并执行它,无需模型轮次。
6
+
7
+ ## 命令约定
8
+
9
+ | 输入 | 结果 |
10
+ |---|---|
11
+ | `/help` | 按名称排序列出每个已注册命令,格式为 `/name — description`。 |
12
+ | `/help <cmd>` | 显示单个命令的详情(名称、描述与声明了时的输入提示)。未知命令会给出友好提示。 |
13
+
14
+ 命令详情来自命令注册表本身;只显示当前组合中已注册的命令。
15
+
16
+ ## 组合
17
+
18
+ 该插件注入 `commands`。自定义应用会挂载它们的拥有者与此插件:
19
+
20
+ ```yaml
21
+ - id: commands
22
+ name: '@deepseek-ai/dsh-commands'
23
+ - id: command-help
24
+ name: '@dsh-cc/command-help'
25
+ ```
26
+
27
+ ## 模型体验
28
+
29
+ 斜杠输入与输出不会进入模型请求,也不消耗模型 token。呈现文本绝不会记录到日志中。
30
+
31
+ ## 已知限制与暂缓事项
32
+
33
+ - **注册表范围视图** —— 只列出当前组合中注册的命令;在其它 agent 作用域下挂载的命令不会被显示。
package/lib/help.d.ts ADDED
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Pure `/help` rendering: a sorted command index and a single-command detail
3
+ * view. No cordis imports, so the renderers are unit-testable in isolation.
4
+ * @module @dsh-cc/command-help/help
5
+ */
6
+ import type { CommandDescriptor } from '@deepseek-ai/dsh-commands';
7
+ import type { PluginCommandInfo } from './plugins.ts';
8
+ /**
9
+ * Render the full command index, sorted by name, merging harness commands
10
+ * with plugin commands. On a (theoretically impossible) name collision the
11
+ * harness side wins and the plugin entry is skipped.
12
+ * @param descriptors - the effective command descriptors for one agent.
13
+ * @param pluginCommands - commands exposed by the optional `ccPlugins` service.
14
+ * @returns a sorted multi-line list of `name — description`; plugin entries
15
+ * carry a trailing `[plugin: <name>]` marker.
16
+ */
17
+ export declare function formatHelpList(descriptors: readonly CommandDescriptor[], pluginCommands?: readonly PluginCommandInfo[]): string;
18
+ /**
19
+ * Render one command's detail, including its input hint when declared.
20
+ * @param descriptors - the effective command descriptors for one agent.
21
+ * @param name - the requested command name without the leading slash.
22
+ * @returns the detail block, or `undefined` when the name is unknown.
23
+ */
24
+ export declare function formatHelpDetail(descriptors: readonly CommandDescriptor[], name: string, pluginCommand?: PluginCommandInfo): string | undefined;
25
+ /**
26
+ * Render one plugin command's detail, including its plugin origin and
27
+ * optional argument hint.
28
+ * @param command - the plugin command info.
29
+ * @returns the detail block.
30
+ */
31
+ export declare function formatPluginHelpDetail(command: PluginCommandInfo): string;
32
+ //# sourceMappingURL=help.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAClE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAErD;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,WAAW,EAAE,SAAS,iBAAiB,EAAE,EACzC,cAAc,GAAE,SAAS,iBAAiB,EAAO,GAChD,MAAM,CAoBR;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,SAAS,iBAAiB,EAAE,EACzC,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,iBAAiB,GAChC,MAAM,GAAG,SAAS,CASpB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,CAMzE"}
package/lib/help.js ADDED
@@ -0,0 +1,68 @@
1
+ /**
2
+ * Pure `/help` rendering: a sorted command index and a single-command detail
3
+ * view. No cordis imports, so the renderers are unit-testable in isolation.
4
+ * @module @dsh-cc/command-help/help
5
+ */
6
+ /**
7
+ * Render the full command index, sorted by name, merging harness commands
8
+ * with plugin commands. On a (theoretically impossible) name collision the
9
+ * harness side wins and the plugin entry is skipped.
10
+ * @param descriptors - the effective command descriptors for one agent.
11
+ * @param pluginCommands - commands exposed by the optional `ccPlugins` service.
12
+ * @returns a sorted multi-line list of `name — description`; plugin entries
13
+ * carry a trailing `[plugin: <name>]` marker.
14
+ */
15
+ export function formatHelpList(descriptors, pluginCommands = []) {
16
+ const known = new Set(descriptors.map(cmd => cmd.name));
17
+ const merged = [
18
+ ...descriptors.map(cmd => ({
19
+ name: cmd.name,
20
+ description: cmd.description,
21
+ plugin: undefined,
22
+ })),
23
+ ...pluginCommands
24
+ .filter(cmd => !known.has(cmd.name))
25
+ .map(cmd => ({ name: cmd.name, description: cmd.description, plugin: cmd.plugin })),
26
+ ];
27
+ const sorted = merged.sort((a, b) => a.name.localeCompare(b.name));
28
+ if (sorted.length === 0)
29
+ return 'No commands registered.';
30
+ return sorted
31
+ .map(cmd => {
32
+ const marker = cmd.plugin === undefined ? '' : ` [plugin: ${cmd.plugin}]`;
33
+ return `/${cmd.name} — ${cmd.description}${marker}`;
34
+ })
35
+ .join('\n');
36
+ }
37
+ /**
38
+ * Render one command's detail, including its input hint when declared.
39
+ * @param descriptors - the effective command descriptors for one agent.
40
+ * @param name - the requested command name without the leading slash.
41
+ * @returns the detail block, or `undefined` when the name is unknown.
42
+ */
43
+ export function formatHelpDetail(descriptors, name, pluginCommand) {
44
+ const command = descriptors.find(cmd => cmd.name === name);
45
+ if (command === undefined) {
46
+ if (pluginCommand === undefined)
47
+ return undefined;
48
+ return formatPluginHelpDetail(pluginCommand);
49
+ }
50
+ const lines = [`/${command.name}`, command.description];
51
+ if (command.input !== undefined)
52
+ lines.push(`usage: /${command.name} ${command.input.hint}`);
53
+ return lines.join('\n');
54
+ }
55
+ /**
56
+ * Render one plugin command's detail, including its plugin origin and
57
+ * optional argument hint.
58
+ * @param command - the plugin command info.
59
+ * @returns the detail block.
60
+ */
61
+ export function formatPluginHelpDetail(command) {
62
+ const lines = [`/${command.name}`, command.description, `from plugin: ${command.plugin}`];
63
+ if (command.argumentHint !== undefined) {
64
+ lines.push(`usage: /${command.name} ${command.argumentHint}`);
65
+ }
66
+ return lines.join('\n');
67
+ }
68
+ //# sourceMappingURL=help.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAC5B,WAAyC,EACzC,iBAA+C,EAAE;IAEjD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IACvD,MAAM,MAAM,GAAG;QACb,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACzB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,WAAW,EAAE,GAAG,CAAC,WAAW;YAC5B,MAAM,EAAE,SAA+B;SACxC,CAAC,CAAC;QACH,GAAG,cAAc;aACd,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;aACnC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;KACtF,CAAA;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAClE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,yBAAyB,CAAA;IACzD,OAAO,MAAM;SACV,GAAG,CAAC,GAAG,CAAC,EAAE;QACT,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,MAAM,GAAG,CAAA;QACzE,OAAO,IAAI,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,WAAW,GAAG,MAAM,EAAE,CAAA;IACrD,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAA;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,WAAyC,EACzC,IAAY,EACZ,aAAiC;IAEjC,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;IAC1D,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,IAAI,aAAa,KAAK,SAAS;YAAE,OAAO,SAAS,CAAA;QACjD,OAAO,sBAAsB,CAAC,aAAa,CAAC,CAAA;IAC9C,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IACvD,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,WAAW,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAC5F,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA0B;IAC/D,MAAM,KAAK,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,WAAW,EAAE,gBAAgB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACzF,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,WAAW,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC"}
package/lib/index.d.ts ADDED
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Human-facing `/help` command: lists every registered slash command or shows
3
+ * the detail for one named command, including its input hint.
4
+ * @module @dsh-cc/command-help
5
+ */
6
+ import type { Context } from '@deepseek-ai/cordis';
7
+ export { formatPluginHelpDetail } from './help.ts';
8
+ export type { PluginCommandInfo } from './plugins.ts';
9
+ export { findPluginCommand, listPluginCommands } from './plugins.ts';
10
+ export declare const name = "command-help";
11
+ export declare const inject: string[];
12
+ /**
13
+ * Register the `/help` command for every composed command adapter.
14
+ * @param ctx - context carrying the command registry.
15
+ */
16
+ export declare function apply(ctx: Context): void;
17
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAKlD,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAClD,YAAY,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEpE,eAAO,MAAM,IAAI,iBAAiB,CAAA;AAClC,eAAO,MAAM,MAAM,UAAe,CAAA;AAqBlC;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAOxC"}
package/lib/index.js ADDED
@@ -0,0 +1,42 @@
1
+ /**
2
+ * Human-facing `/help` command: lists every registered slash command or shows
3
+ * the detail for one named command, including its input hint.
4
+ * @module @dsh-cc/command-help
5
+ */
6
+ import { formatHelpDetail, formatHelpList } from "./help.js";
7
+ import { findPluginCommand, listPluginCommands } from "./plugins.js";
8
+ export { formatPluginHelpDetail } from "./help.js";
9
+ export { findPluginCommand, listPluginCommands } from "./plugins.js";
10
+ export const name = 'command-help';
11
+ export const inject = ['commands'];
12
+ /** Execute `/help [cmd]`. */
13
+ function executeHelp(ctx, invocation) {
14
+ const descriptors = ctx.commands.list(invocation.agent);
15
+ const pluginCommands = listPluginCommands(ctx);
16
+ const token = invocation.rawInput.trim();
17
+ if (token.length === 0) {
18
+ return { kind: 'success', text: formatHelpList(descriptors, pluginCommands) };
19
+ }
20
+ const lowered = token.toLowerCase();
21
+ // Colon-form names (e.g. `codex:review`) cannot exist in the harness
22
+ // registry; they resolve against the plugin command table instead.
23
+ const pluginHit = findPluginCommand(ctx, lowered);
24
+ const detail = formatHelpDetail(descriptors, lowered, pluginHit);
25
+ if (detail === undefined) {
26
+ return { kind: 'success', text: `Unknown command /${token}. Try /help for a list.` };
27
+ }
28
+ return { kind: 'success', text: detail };
29
+ }
30
+ /**
31
+ * Register the `/help` command for every composed command adapter.
32
+ * @param ctx - context carrying the command registry.
33
+ */
34
+ export function apply(ctx) {
35
+ ctx.commands.register({
36
+ name: 'help',
37
+ description: 'list all slash commands, or show details for one (e.g. /help memory)',
38
+ input: { hint: '[command]' },
39
+ handler: (invocation) => executeHelp(ctx, invocation),
40
+ });
41
+ }
42
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC5D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAElD,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEpE,MAAM,CAAC,MAAM,IAAI,GAAG,cAAc,CAAA;AAClC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,UAAU,CAAC,CAAA;AAElC,6BAA6B;AAC7B,SAAS,WAAW,CAAC,GAAY,EAAE,UAA6B;IAC9D,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IACvD,MAAM,cAAc,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAA;IAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAA;IACxC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,EAAE,CAAA;IAC/E,CAAC;IACD,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,EAAE,CAAA;IACnC,qEAAqE;IACrE,mEAAmE;IACnE,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;IACjD,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,EAAE,OAAO,EAAE,SAAS,CAAC,CAAA;IAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,oBAAoB,KAAK,yBAAyB,EAAE,CAAA;IACtF,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;AAC1C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,GAAY;IAChC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACpB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,sEAAsE;QACnF,KAAK,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;QAC5B,OAAO,EAAE,CAAC,UAA6B,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,UAAU,CAAC;KACzE,CAAC,CAAA;AACJ,CAAC"}
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Package-owned invariant companion for `@dsh-cc/command-help`.
3
+ * @module @dsh-cc/command-help/invariant
4
+ */
5
+ import type { Context } from '@deepseek-ai/cordis';
6
+ /** Cordis companion plugin name. */
7
+ export declare const name = "command-help-invariant";
8
+ /** Service required before the companion can reserve package ownership. */
9
+ export declare const inject: string[];
10
+ /**
11
+ * Register this package's invariant companion.
12
+ * @param ctx - Cordis context carrying the invariant service.
13
+ * @returns the installed registration's disposer after setup succeeds.
14
+ */
15
+ export declare const apply: (ctx: Context) => Promise<() => void>;
16
+ //# sourceMappingURL=invariant.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../src/invariant.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAKlD,oCAAoC;AACpC,eAAO,MAAM,IAAI,2BAA2B,CAAA;AAC5C,2EAA2E;AAC3E,eAAO,MAAM,MAAM,UAAiB,CAAA;AASpC;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAI,KAAK,OAAO,KAAG,OAAO,CAAC,MAAM,IAAI,CACU,CAAA"}
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Package-owned invariant companion for `@dsh-cc/command-help`.
3
+ * @module @dsh-cc/command-help/invariant
4
+ */
5
+ const PACKAGE_NAME = '@dsh-cc/command-help';
6
+ /** Cordis companion plugin name. */
7
+ export const name = 'command-help-invariant';
8
+ /** Service required before the companion can reserve package ownership. */
9
+ export const inject = ['invariants'];
10
+ /**
11
+ * No runtime invariant: this command adapter owns no event stream or state projection; help
12
+ * behavior is a pure read/render over composed services, and the command registry owns
13
+ * registration and dispatch lifecycle.
14
+ */
15
+ const install = () => { };
16
+ /**
17
+ * Register this package's invariant companion.
18
+ * @param ctx - Cordis context carrying the invariant service.
19
+ * @returns the installed registration's disposer after setup succeeds.
20
+ */
21
+ export const apply = (ctx) => Promise.resolve(ctx.invariants.register(PACKAGE_NAME, install));
22
+ /* jscpd:ignore-end */
23
+ //# sourceMappingURL=invariant.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invariant.js","sourceRoot":"","sources":["../src/invariant.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,MAAM,YAAY,GAAG,sBAAsB,CAAA;AAE3C,oCAAoC;AACpC,MAAM,CAAC,MAAM,IAAI,GAAG,wBAAwB,CAAA;AAC5C,2EAA2E;AAC3E,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,YAAY,CAAC,CAAA;AAEpC;;;;GAIG;AACH,MAAM,OAAO,GAAuB,GAAG,EAAE,GAAE,CAAC,CAAA;AAE5C;;;;GAIG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,GAAY,EAAuB,EAAE,CACzD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;AACjE,sBAAsB"}
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Duck-typed, optional consumption of the cc-shell `ccPlugins` service. The
3
+ * service may be absent (behavior identical to before); when present it
4
+ * exposes plugin commands under colon names like `codex:review` that the
5
+ * harness command registry cannot host.
6
+ * @module @dsh-cc/command-help/plugins
7
+ */
8
+ import type { Context } from '@deepseek-ai/cordis';
9
+ /** Info exposed by the `ccPlugins` service for one plugin command. */
10
+ export interface PluginCommandInfo {
11
+ /** Display form `plugin:command`, e.g. `codex:review`. */
12
+ name: string;
13
+ plugin: string;
14
+ description: string;
15
+ argumentHint?: string;
16
+ }
17
+ /**
18
+ * Read plugin commands from the optional `ccPlugins` service.
19
+ * @param ctx - cordis context that may carry the service.
20
+ * @returns the plugin command list, empty when the service is absent or
21
+ * malformed.
22
+ */
23
+ export declare function listPluginCommands(ctx: Context): readonly PluginCommandInfo[];
24
+ /**
25
+ * Look up one plugin command by name (already lowercased by the caller).
26
+ * @param ctx - cordis context that may carry the service.
27
+ * @param name - exact `plugin:command` name, lowercase.
28
+ * @returns the matching info, or `undefined`.
29
+ */
30
+ export declare function findPluginCommand(ctx: Context, name: string): PluginCommandInfo | undefined;
31
+ //# sourceMappingURL=plugins.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAMD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,iBAAiB,EAAE,CAY7E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GACX,iBAAiB,GAAG,SAAS,CAE/B"}
package/lib/plugins.js ADDED
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Duck-typed, optional consumption of the cc-shell `ccPlugins` service. The
3
+ * service may be absent (behavior identical to before); when present it
4
+ * exposes plugin commands under colon names like `codex:review` that the
5
+ * harness command registry cannot host.
6
+ * @module @dsh-cc/command-help/plugins
7
+ */
8
+ /**
9
+ * Read plugin commands from the optional `ccPlugins` service.
10
+ * @param ctx - cordis context that may carry the service.
11
+ * @returns the plugin command list, empty when the service is absent or
12
+ * malformed.
13
+ */
14
+ export function listPluginCommands(ctx) {
15
+ // Cordis proxies ctx property access and throws when a service is absent;
16
+ // the service is optional, so absence must degrade to an empty list.
17
+ let service;
18
+ try {
19
+ service = ctx.ccPlugins;
20
+ }
21
+ catch {
22
+ return [];
23
+ }
24
+ if (service === undefined || typeof service.listPluginCommands !== 'function')
25
+ return [];
26
+ const listed = service.listPluginCommands();
27
+ return Array.isArray(listed) ? listed : [];
28
+ }
29
+ /**
30
+ * Look up one plugin command by name (already lowercased by the caller).
31
+ * @param ctx - cordis context that may carry the service.
32
+ * @param name - exact `plugin:command` name, lowercase.
33
+ * @returns the matching info, or `undefined`.
34
+ */
35
+ export function findPluginCommand(ctx, name) {
36
+ return listPluginCommands(ctx).find(cmd => cmd.name === name);
37
+ }
38
+ //# sourceMappingURL=plugins.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugins.js","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAiBH;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAY;IAC7C,0EAA0E;IAC1E,qEAAqE;IACrE,IAAI,OAAqC,CAAA;IACzC,IAAI,CAAC;QACH,OAAO,GAAI,GAAwC,CAAC,SAAS,CAAA;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAA;IACX,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,kBAAkB,KAAK,UAAU;QAAE,OAAO,EAAE,CAAA;IACxF,MAAM,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAA;IAC3C,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAY,EACZ,IAAY;IAEZ,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;AAC/D,CAAC"}
package/package.json ADDED
@@ -0,0 +1,43 @@
1
+ {
2
+ "name": "@dsh-cc/command-help",
3
+ "description": "Human-facing slash command to list or detail available slash commands",
4
+ "version": "0.5.0",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/dsh-cc/dsh-cc.git",
8
+ "directory": "packages/interaction/command-help"
9
+ },
10
+ "type": "module",
11
+ "exports": {
12
+ ".": {
13
+ "types": "./lib/index.d.ts",
14
+ "default": "./lib/index.js"
15
+ },
16
+ "./invariant": {
17
+ "types": "./lib/invariant.d.ts",
18
+ "default": "./lib/invariant.js"
19
+ },
20
+ "./src/*": "./src/*",
21
+ "./package.json": "./package.json"
22
+ },
23
+ "files": [
24
+ "lib"
25
+ ],
26
+ "license": "Apache-2.0",
27
+ "peerDependencies": {
28
+ "@deepseek-ai/dsh-commands": ">=0.1.1-rc.2",
29
+ "@deepseek-ai/dsh-invariants": ">=0.1.1-rc.2",
30
+ "@deepseek-ai/cordis": ">=0.1.1-rc.2"
31
+ },
32
+ "devDependencies": {
33
+ "@deepseek-ai/cordis-plugin-loader": "link:../../../../deepseek-harness/vendor/loader",
34
+ "@deepseek-ai/dsh-agent": "link:../../../../deepseek-harness/packages/core/agent",
35
+ "@deepseek-ai/dsh-commands": "link:../../../../deepseek-harness/packages/interaction/commands",
36
+ "@deepseek-ai/dsh-invariants": "link:../../../../deepseek-harness/packages/runtime-diagnostics/invariants",
37
+ "@deepseek-ai/dsh-session": "link:../../../../deepseek-harness/packages/core/session",
38
+ "@deepseek-ai/cordis": "link:../../../../deepseek-harness/vendor/cordis"
39
+ },
40
+ "publishConfig": {
41
+ "access": "public"
42
+ }
43
+ }