dsh-instructions-policy 0.0.0-stage → 0.6.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 +373 -0
- package/NOTICE +6 -0
- package/README.en.md +236 -0
- package/README.md +234 -2
- package/cordis.patch.yml +16 -0
- package/lib/client.js +606 -0
- package/lib/config.js +122 -0
- package/lib/discovery.js +315 -0
- package/lib/i18n.js +175 -0
- package/lib/index.js +233 -0
- package/lib/loader.js +478 -0
- package/lib/policy.js +95 -0
- package/lib/projection.js +444 -0
- package/lib/render.js +280 -0
- package/lib/state.js +168 -0
- package/lib/toolkit.js +235 -0
- package/lib/types.js +11 -0
- package/package.json +59 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
dsh-instructions-policy
|
|
2
|
+
Copyright (c) 2026 dsh-instructions-policy contributors
|
|
3
|
+
|
|
4
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
5
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
6
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
package/README.en.md
ADDED
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="./docs/banner.png" alt="dsh-instructions-policy" width="880" />
|
|
3
|
+
|
|
4
|
+
# dsh-instructions-policy
|
|
5
|
+
|
|
6
|
+

|
|
7
|
+

|
|
8
|
+
[](https://www.npmjs.com/package/dsh-instructions-policy)
|
|
9
|
+
|
|
10
|
+
[简体中文](README.md) · **English**
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
Session-scoped policy for **DeepSeek Harness (DSH)** workspace instructions: choose the root `AGENTS.md`, switch user-global instructions off, switch subdirectory discovery off — without copying a single preset file.
|
|
17
|
+
|
|
18
|
+
## When you need it
|
|
19
|
+
|
|
20
|
+
DSH hard-codes three instruction behaviours: it reads the **project root**'s `AGENTS.md`/`CLAUDE.md`, it reads the **user-global** `~/.dsh/AGENTS.md` and `~/.agents/AGENTS.md`, and it **appends** a directory's `AGENTS.md` after that directory is read. DSH exposes no per-session switch for any of this, and developers (like me) frequently need full control while working with an AI assistant. The usual workaround is to edit a preset — which means copying the whole `config.plugins` list and drifting on every DSH upgrade. This plugin does two things instead:
|
|
21
|
+
|
|
22
|
+
1. **It leaves presets alone**: the shipped instruction loader is replaced wholesale at the Loader's module import seam, so official presets keep upgrading as usual;
|
|
23
|
+
2. **It makes the policy session state**: both `/instructions` and the Web chip change it, and the policy is replayed only from events already declared in the session log, so resume, compaction, and fork never lose it.
|
|
24
|
+
|
|
25
|
+
*Note: "project root" follows the official mechanism — the first directory containing `.git` when walking up from the working directory, or the working directory itself when none is found.*
|
|
26
|
+
|
|
27
|
+
## How it works
|
|
28
|
+
|
|
29
|
+
<details>
|
|
30
|
+
<summary>Expand the mechanism tree</summary>
|
|
31
|
+
|
|
32
|
+
```text
|
|
33
|
+
profile boot
|
|
34
|
+
└─ cordis.patch.yml inserts the host row `instructions-policy`
|
|
35
|
+
├─ src/index.ts: wraps loader.internal.import into an accessor + Proxy (only `import` is overridden)
|
|
36
|
+
│ └─ any preset importing @deepseek-ai/dsh-agent-instructions
|
|
37
|
+
│ ├─ ① first imports the running shipped module with the original import → reuses the renderer
|
|
38
|
+
│ │ (so the prompt format always matches the installed DSH)
|
|
39
|
+
│ └─ ② hands this package's lib/loader.js to the Loader (facade merges host row + preset row config)
|
|
40
|
+
│ └─ every agent/pre-step (before the next step starts)
|
|
41
|
+
│ ├─ folds the session log surface.nodes → which instructions the model currently sees
|
|
42
|
+
│ ├─ replays command/run + command/done → this session's policy
|
|
43
|
+
│ ├─ discovers files: project root → cwd chain + user-global + already-touched subdirectories
|
|
44
|
+
│ ├─ renders: shipped renderer first, built-in fallback; reports omitted/truncated as rendered
|
|
45
|
+
│ └─ injects the agent-instructions message (with changes / policy)
|
|
46
|
+
│ ├─ compaction changes the surface → baseline is rebuilt on the next step;
|
|
47
|
+
│ │ nested waits until the matching directory is touched again
|
|
48
|
+
│ └─ after resume it recovers from the log → nothing is injected twice
|
|
49
|
+
└─ registers the `instructionsPolicy` session projection
|
|
50
|
+
└─ the Web chip reads policy/lock/last error/project root/loaded files through useProjection
|
|
51
|
+
└─ writes go through remote.commands.execute, which returns the handler result directly
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Because this uses the import seam every preset passes through, Standard / PTC / Creator and any other preset pick the policy up with no edits. Each step only sends a baseline when its identity changed or a nested addition appeared, so nothing is injected twice.
|
|
55
|
+
|
|
56
|
+
</details>
|
|
57
|
+
|
|
58
|
+
## Alignment and constraints
|
|
59
|
+
|
|
60
|
+
The project stays as close to the official plugin model as possible; the table below records the alignment and this project's own constraints.
|
|
61
|
+
|
|
62
|
+
<details>
|
|
63
|
+
<summary>Expand the conventions table</summary>
|
|
64
|
+
|
|
65
|
+
| Upstream convention | How this project complies |
|
|
66
|
+
|---|---|
|
|
67
|
+
| Official extension points only; the agent loop is untouched | `agent/pre-step`, `tools/result`, the command service, client slots |
|
|
68
|
+
| Model-visible ⟺ in the session log | both instruction text and policy are rebuilt from the session log |
|
|
69
|
+
| Prefer capabilities of the running version | reuses the installed version's instruction renderer |
|
|
70
|
+
|
|
71
|
+
**Following `agent-instructions`**: budgets, truncation, escaping, and `changes` record only what was actually rendered. Those are that package's behaviour, not a generic plugin rule.
|
|
72
|
+
|
|
73
|
+
**This project's own constraints**: zero runtime dependencies; no preset or shipped loader is copied.
|
|
74
|
+
|
|
75
|
+
</details>
|
|
76
|
+
|
|
77
|
+
## Usage
|
|
78
|
+
|
|
79
|
+
### Commands
|
|
80
|
+
|
|
81
|
+
```text
|
|
82
|
+
/instructions show the current policy, project root, and the files actually loaded
|
|
83
|
+
(appended subdirectory files included; budget exclusions listed separately)
|
|
84
|
+
/instructions root default restore reading the project root
|
|
85
|
+
/instructions root off skip the project-root layer (cwd and intermediate directories still load)
|
|
86
|
+
/instructions root custom <path> replace the project-root layer with one file
|
|
87
|
+
(a relative path resolves against cwd first, then the project root)
|
|
88
|
+
/instructions global on|off switch user-global instructions on or off
|
|
89
|
+
/instructions nested on|off switch subdirectory appends on or off (effective next step)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Subdirectory appends fire only when the `file_path` of a `read`/`write`/`edit` call lands inside the working-directory subtree (same as upstream); `cd` or a directory listing in a shell does not count.
|
|
93
|
+
|
|
94
|
+
The `files:` line of `/instructions show` lists the baseline files the renderer actually carries, plus any nested files already appended in the log. Baseline files dropped by the budget appear under `not loaded (budget):`; with `maxBytes: 0` it prints `budget: disabled` instead.
|
|
95
|
+
|
|
96
|
+
### Web chip
|
|
97
|
+
|
|
98
|
+
An "Instruction policy" menu appears to the left of the composer (next to the permission control). Hovering it shows the resolved project root, the files currently loaded, and both switches. A custom root can be picked from the workspace browser, or uploaded from this machine as a `.md`/`.markdown`/`.txt` file.
|
|
99
|
+
|
|
100
|
+

|
|
101
|
+
|
|
102
|
+
## Install
|
|
103
|
+
|
|
104
|
+
### Prerequisites
|
|
105
|
+
|
|
106
|
+
- DSH is installed and has been started at least once (`dsh --version` prints a version).
|
|
107
|
+
- Node.js follows DSH: 0.2.2 requires ≥ 24.9, 0.2.1 requires `^22.19.0 || >=24.0.0`; defer to DSH's `engines`.
|
|
108
|
+
- DSH `>=0.2.1-rc.5 <1.0.0-0` (all 0.x releases are admitted; 1.0 and its prereleases need re-validation).
|
|
109
|
+
|
|
110
|
+
### Steps
|
|
111
|
+
|
|
112
|
+
1. Install the package into a profile (`web` is the default Web profile name):
|
|
113
|
+
|
|
114
|
+
```sh
|
|
115
|
+
# from npm
|
|
116
|
+
dsh plugin --profile web add dsh-instructions-policy
|
|
117
|
+
# from GitHub (replace <owner>/<repo> with the repository)
|
|
118
|
+
dsh plugin --profile web add github:<owner>/<repo>
|
|
119
|
+
# local development: link the repository directory
|
|
120
|
+
dsh plugin --profile web add link:<path-to-repo>
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
2. Make the profile select this bundle. Edit `~/.dsh/profiles/web/package.json` (on Windows: `%USERPROFILE%\.dsh\profiles\web\package.json`) and add the package name to `dsh.profile.bundles`:
|
|
124
|
+
|
|
125
|
+
```json
|
|
126
|
+
{
|
|
127
|
+
"dsh": {
|
|
128
|
+
"profile": {
|
|
129
|
+
"bundles": [
|
|
130
|
+
"@deepseek-ai/dsh-base",
|
|
131
|
+
"@deepseek-ai/dsh-web-app",
|
|
132
|
+
"dsh-instructions-policy"
|
|
133
|
+
]
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Once installed you can also enable it from the Plugins page (equivalent to writing `dsh.profile.bundles`).
|
|
140
|
+
|
|
141
|
+
3. Restart `dsh web` and confirm the log line:
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
instructions-policy: redirecting @deepseek-ai/dsh-agent-instructions for N preset row(s)
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
4. Open any new task: the "Instruction policy" chip should appear at the left of the composer tool row; or run `/instructions show` to verify the project root and loaded files.
|
|
148
|
+
|
|
149
|
+
After upgrading, restart `dsh web`; if the interface does not change, force-reload the browser with Ctrl+F5.
|
|
150
|
+
|
|
151
|
+
### Upgrade / uninstall
|
|
152
|
+
|
|
153
|
+
```sh
|
|
154
|
+
# npm / GitHub install: upgrade
|
|
155
|
+
dsh plugin --profile web update dsh-instructions-policy
|
|
156
|
+
|
|
157
|
+
# link install: git pull in the repository, then restart dsh web
|
|
158
|
+
|
|
159
|
+
# uninstall: remove the package name from dsh.profile.bundles first, then
|
|
160
|
+
dsh plugin --profile web remove dsh-instructions-policy
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
After uninstalling, the redirect disappears and DSH returns to the default instruction loader; instruction messages already written to session logs stay in the history.
|
|
164
|
+
|
|
165
|
+
## Configuration
|
|
166
|
+
|
|
167
|
+
<details>
|
|
168
|
+
<summary>Expand the configuration reference</summary>
|
|
169
|
+
|
|
170
|
+
Defaults live in [cordis.patch.yml](cordis.patch.yml). To change them, override the row by `id` in `~/.dsh/profiles/<profile>/cordis.patch.yml`. **DSH replaces a row's `config` wholesale, with no deep merge**, so restate every field you need:
|
|
171
|
+
|
|
172
|
+
```yaml
|
|
173
|
+
- id: instructions-policy
|
|
174
|
+
config:
|
|
175
|
+
maxBytes: 16384
|
|
176
|
+
maxSourceBytes: 1048576
|
|
177
|
+
locale: auto
|
|
178
|
+
projectRootMarkers: ['.git']
|
|
179
|
+
candidates: ['AGENTS.md', 'CLAUDE.md']
|
|
180
|
+
localCandidates: ['AGENTS.local.md', 'CLAUDE.local.md']
|
|
181
|
+
policy:
|
|
182
|
+
root: default
|
|
183
|
+
file: null
|
|
184
|
+
global: true
|
|
185
|
+
nested: true
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
| Field | Default | Meaning |
|
|
189
|
+
|---|---|---|
|
|
190
|
+
| `policy.root` | `default` | `default` reads the project-root candidates; `off` skips that layer; `custom` replaces it with `policy.file` |
|
|
191
|
+
| `policy.file` | `null` | The custom root file. Usually written by the Web chip's "Choose local file…" or by `/instructions root custom <path>`; a project-root-relative path is also accepted |
|
|
192
|
+
| `policy.global` | `true` | Whether `~/.dsh/AGENTS.md` and `~/.agents/AGENTS.md` load (`$DSH_HOME` / `$DSH_AGENTS_HOME` override the roots; the UI shows the variable name) |
|
|
193
|
+
| `policy.nested` | `true` | Whether a touched subdirectory's instructions are appended |
|
|
194
|
+
| `locale` | `auto` | Language of `/instructions` results: `auto` follows the language chosen in DSH, then the system language; `zh` / `en` pin it; an untranslated language falls back to English |
|
|
195
|
+
| `maxBytes` | `65536` | Byte budget for an instruction message. The shipped renderer applies it per chain (user-global / project), so a merged frame can reach 2×; the built-in fallback applies it to the whole message. `0` disables instruction loading |
|
|
196
|
+
| `maxSourceBytes` | `1048576` | Per-file read cap; a larger file counts as absent |
|
|
197
|
+
| `projectRootMarkers` | `['.git']` | Directory entries that identify the project root while walking up |
|
|
198
|
+
| `candidates` | `['AGENTS.md', 'CLAUDE.md']` | Base candidates read in every directory |
|
|
199
|
+
| `localCandidates` | `['AGENTS.local.md', 'CLAUDE.local.md']` | Local overlays read after the base candidates |
|
|
200
|
+
|
|
201
|
+
`maxSourceBytes`, `projectRootMarkers`, `candidates`, and `localCandidates` are advanced fields that rarely need changing.
|
|
202
|
+
|
|
203
|
+
</details>
|
|
204
|
+
|
|
205
|
+
## Compatibility and known limitations
|
|
206
|
+
|
|
207
|
+
- This plugin replaces the shipped loader. A normal single-plugin install does not conflict, but do not mount the official loader in the same session: the two baseline/nested states would replace each other.
|
|
208
|
+
- This plugin's `changes.scope` is a displayPath, where the official loader uses a per-candidate key. After uninstalling or switching to a profile without the plugin, the official loader may re-read old messages and duplicate or misclassify them; start a new session or compact once first.
|
|
209
|
+
- It depends on `ctx.loader.internal` (an undocumented import seam). If upstream renames it or changes the implementation, the `apply` phase and the first pre-step self-check warn `policy inactive` and the policy falls back to the official default behaviour instead of silently corrupting the prompt.
|
|
210
|
+
- `engines.dsh` only blocks 1.0 (and 1.0 prereleases): 0.x minor upgrades pass. When something breaks, check the `redirecting …` log line and the `policy inactive` self-check first.
|
|
211
|
+
|
|
212
|
+
## Feedback
|
|
213
|
+
|
|
214
|
+
The plugin ships no logging of its own: it keeps zero runtime dependencies and writes no files. Diagnostics go through DSH's logger to the terminal running `dsh web` (Cordis' console logger). There is no log directory under `~/.dsh`, and the session JSONL records session events only, not logger output — so the "logs" a report needs are those terminal lines.
|
|
215
|
+
|
|
216
|
+
When filing an issue, include:
|
|
217
|
+
|
|
218
|
+
- DSH version (`dsh --version`), plugin version (the profile `package.json` or `node_modules/dsh-instructions-policy/package.json`), and the OS.
|
|
219
|
+
- The profile's `dsh.profile.bundles`, plus any line in `~/.dsh/profiles/<profile>/cordis.patch.yml` related to this plugin.
|
|
220
|
+
- Every line containing `instructions-policy` in the terminal that started `dsh web` (`redirecting …`, `policy inactive`, `compose failed`, …). If the terminal is gone, redirect and reproduce:
|
|
221
|
+
|
|
222
|
+
```powershell
|
|
223
|
+
dsh web *> dsh.log # PowerShell
|
|
224
|
+
# dsh web > dsh.log 2>&1 # cmd / bash
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
- The full `/instructions show` output (including the project root and the files actually loaded).
|
|
228
|
+
- Minimal reproduction steps, expected result, and actual result; redact private paths and repository names first.
|
|
229
|
+
|
|
230
|
+
Bar for a report: **reproducible** (steps), **versioned** (DSH + plugin + OS), **logged** (terminal output + `/instructions show`), **differential** (expected vs actual).
|
|
231
|
+
|
|
232
|
+
## License
|
|
233
|
+
|
|
234
|
+
Released under the [Mozilla Public License 2.0](LICENSE); copyright and Exhibit A notice are in [NOTICE](NOTICE).
|
|
235
|
+
|
|
236
|
+
Copyright (c) 2026 dsh-instructions-policy contributors.
|