@tiechui/cli 0.1.0 → 0.2.0-darwin-arm64
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/chui +4 -0
- package/package.json +9 -18
- package/LICENSE +0 -661
- package/README.md +0 -549
- package/bin/chui.js +0 -44
package/chui
ADDED
package/package.json
CHANGED
|
@@ -6,23 +6,14 @@
|
|
|
6
6
|
"url": "git+https://github.com/b1ank1108/tiechui.git"
|
|
7
7
|
},
|
|
8
8
|
"name": "@tiechui/cli",
|
|
9
|
-
"version": "0.
|
|
10
|
-
"
|
|
11
|
-
|
|
12
|
-
"chui": "bin/chui.js",
|
|
13
|
-
"tiechui": "bin/chui.js"
|
|
14
|
-
},
|
|
15
|
-
"files": [
|
|
16
|
-
"bin"
|
|
9
|
+
"version": "0.2.0-darwin-arm64",
|
|
10
|
+
"os": [
|
|
11
|
+
"darwin"
|
|
17
12
|
],
|
|
18
|
-
"
|
|
19
|
-
"
|
|
20
|
-
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
"@tiechui/cli-linux-arm64": "npm:@tiechui/cli@0.1.0-linux-arm64",
|
|
25
|
-
"@tiechui/cli-linux-x64": "npm:@tiechui/cli@0.1.0-linux-x64",
|
|
26
|
-
"@tiechui/cli-win32-x64": "npm:@tiechui/cli@0.1.0-win32-x64"
|
|
27
|
-
}
|
|
13
|
+
"cpu": [
|
|
14
|
+
"arm64"
|
|
15
|
+
],
|
|
16
|
+
"files": [
|
|
17
|
+
"chui"
|
|
18
|
+
]
|
|
28
19
|
}
|
package/LICENSE
DELETED
|
@@ -1,661 +0,0 @@
|
|
|
1
|
-
GNU AFFERO GENERAL PUBLIC LICENSE
|
|
2
|
-
Version 3, 19 November 2007
|
|
3
|
-
|
|
4
|
-
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
|
5
|
-
Everyone is permitted to copy and distribute verbatim copies
|
|
6
|
-
of this license document, but changing it is not allowed.
|
|
7
|
-
|
|
8
|
-
Preamble
|
|
9
|
-
|
|
10
|
-
The GNU Affero General Public License is a free, copyleft license for
|
|
11
|
-
software and other kinds of works, specifically designed to ensure
|
|
12
|
-
cooperation with the community in the case of network server software.
|
|
13
|
-
|
|
14
|
-
The licenses for most software and other practical works are designed
|
|
15
|
-
to take away your freedom to share and change the works. By contrast,
|
|
16
|
-
our General Public Licenses are intended to guarantee your freedom to
|
|
17
|
-
share and change all versions of a program--to make sure it remains free
|
|
18
|
-
software for all its users.
|
|
19
|
-
|
|
20
|
-
When we speak of free software, we are referring to freedom, not
|
|
21
|
-
price. Our General Public Licenses are designed to make sure that you
|
|
22
|
-
have the freedom to distribute copies of free software (and charge for
|
|
23
|
-
them if you wish), that you receive source code or can get it if you
|
|
24
|
-
want it, that you can change the software or use pieces of it in new
|
|
25
|
-
free programs, and that you know you can do these things.
|
|
26
|
-
|
|
27
|
-
Developers that use our General Public Licenses protect your rights
|
|
28
|
-
with two steps: (1) assert copyright on the software, and (2) offer
|
|
29
|
-
you this License which gives you legal permission to copy, distribute
|
|
30
|
-
and/or modify the software.
|
|
31
|
-
|
|
32
|
-
A secondary benefit of defending all users' freedom is that
|
|
33
|
-
improvements made in alternate versions of the program, if they
|
|
34
|
-
receive widespread use, become available for other developers to
|
|
35
|
-
incorporate. Many developers of free software are heartened and
|
|
36
|
-
encouraged by the resulting cooperation. However, in the case of
|
|
37
|
-
software used on network servers, this result may fail to come about.
|
|
38
|
-
The GNU General Public License permits making a modified version and
|
|
39
|
-
letting the public access it on a server without ever releasing its
|
|
40
|
-
source code to the public.
|
|
41
|
-
|
|
42
|
-
The GNU Affero General Public License is designed specifically to
|
|
43
|
-
ensure that, in such cases, the modified source code becomes available
|
|
44
|
-
to the community. It requires the operator of a network server to
|
|
45
|
-
provide the source code of the modified version running there to the
|
|
46
|
-
users of that server. Therefore, public use of a modified version, on
|
|
47
|
-
a publicly accessible server, gives the public access to the source
|
|
48
|
-
code of the modified version.
|
|
49
|
-
|
|
50
|
-
An older license, called the Affero General Public License and
|
|
51
|
-
published by Affero, was designed to accomplish similar goals. This is
|
|
52
|
-
a different license, not a version of the Affero GPL, but Affero has
|
|
53
|
-
released a new version of the Affero GPL which permits relicensing under
|
|
54
|
-
this license.
|
|
55
|
-
|
|
56
|
-
The precise terms and conditions for copying, distribution and
|
|
57
|
-
modification follow.
|
|
58
|
-
|
|
59
|
-
TERMS AND CONDITIONS
|
|
60
|
-
|
|
61
|
-
0. Definitions.
|
|
62
|
-
|
|
63
|
-
"This License" refers to version 3 of the GNU Affero General Public License.
|
|
64
|
-
|
|
65
|
-
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
66
|
-
works, such as semiconductor masks.
|
|
67
|
-
|
|
68
|
-
"The Program" refers to any copyrightable work licensed under this
|
|
69
|
-
License. Each licensee is addressed as "you". "Licensees" and
|
|
70
|
-
"recipients" may be individuals or organizations.
|
|
71
|
-
|
|
72
|
-
To "modify" a work means to copy from or adapt all or part of the work
|
|
73
|
-
in a fashion requiring copyright permission, other than the making of an
|
|
74
|
-
exact copy. The resulting work is called a "modified version" of the
|
|
75
|
-
earlier work or a work "based on" the earlier work.
|
|
76
|
-
|
|
77
|
-
A "covered work" means either the unmodified Program or a work based
|
|
78
|
-
on the Program.
|
|
79
|
-
|
|
80
|
-
To "propagate" a work means to do anything with it that, without
|
|
81
|
-
permission, would make you directly or secondarily liable for
|
|
82
|
-
infringement under applicable copyright law, except executing it on a
|
|
83
|
-
computer or modifying a private copy. Propagation includes copying,
|
|
84
|
-
distribution (with or without modification), making available to the
|
|
85
|
-
public, and in some countries other activities as well.
|
|
86
|
-
|
|
87
|
-
To "convey" a work means any kind of propagation that enables other
|
|
88
|
-
parties to make or receive copies. Mere interaction with a user through
|
|
89
|
-
a computer network, with no transfer of a copy, is not conveying.
|
|
90
|
-
|
|
91
|
-
An interactive user interface displays "Appropriate Legal Notices"
|
|
92
|
-
to the extent that it includes a convenient and prominently visible
|
|
93
|
-
feature that (1) displays an appropriate copyright notice, and (2)
|
|
94
|
-
tells the user that there is no warranty for the work (except to the
|
|
95
|
-
extent that warranties are provided), that licensees may convey the
|
|
96
|
-
work under this License, and how to view a copy of this License. If
|
|
97
|
-
the interface presents a list of user commands or options, such as a
|
|
98
|
-
menu, a prominent item in the list meets this criterion.
|
|
99
|
-
|
|
100
|
-
1. Source Code.
|
|
101
|
-
|
|
102
|
-
The "source code" for a work means the preferred form of the work
|
|
103
|
-
for making modifications to it. "Object code" means any non-source
|
|
104
|
-
form of a work.
|
|
105
|
-
|
|
106
|
-
A "Standard Interface" means an interface that either is an official
|
|
107
|
-
standard defined by a recognized standards body, or, in the case of
|
|
108
|
-
interfaces specified for a particular programming language, one that
|
|
109
|
-
is widely used among developers working in that language.
|
|
110
|
-
|
|
111
|
-
The "System Libraries" of an executable work include anything, other
|
|
112
|
-
than the work as a whole, that (a) is included in the normal form of
|
|
113
|
-
packaging a Major Component, but which is not part of that Major
|
|
114
|
-
Component, and (b) serves only to enable use of the work with that
|
|
115
|
-
Major Component, or to implement a Standard Interface for which an
|
|
116
|
-
implementation is available to the public in source code form. A
|
|
117
|
-
"Major Component", in this context, means a major essential component
|
|
118
|
-
(kernel, window system, and so on) of the specific operating system
|
|
119
|
-
(if any) on which the executable work runs, or a compiler used to
|
|
120
|
-
produce the work, or an object code interpreter used to run it.
|
|
121
|
-
|
|
122
|
-
The "Corresponding Source" for a work in object code form means all
|
|
123
|
-
the source code needed to generate, install, and (for an executable
|
|
124
|
-
work) run the object code and to modify the work, including scripts to
|
|
125
|
-
control those activities. However, it does not include the work's
|
|
126
|
-
System Libraries, or general-purpose tools or generally available free
|
|
127
|
-
programs which are used unmodified in performing those activities but
|
|
128
|
-
which are not part of the work. For example, Corresponding Source
|
|
129
|
-
includes interface definition files associated with source files for
|
|
130
|
-
the work, and the source code for shared libraries and dynamically
|
|
131
|
-
linked subprograms that the work is specifically designed to require,
|
|
132
|
-
such as by intimate data communication or control flow between those
|
|
133
|
-
subprograms and other parts of the work.
|
|
134
|
-
|
|
135
|
-
The Corresponding Source need not include anything that users
|
|
136
|
-
can regenerate automatically from other parts of the Corresponding
|
|
137
|
-
Source.
|
|
138
|
-
|
|
139
|
-
The Corresponding Source for a work in source code form is that
|
|
140
|
-
same work.
|
|
141
|
-
|
|
142
|
-
2. Basic Permissions.
|
|
143
|
-
|
|
144
|
-
All rights granted under this License are granted for the term of
|
|
145
|
-
copyright on the Program, and are irrevocable provided the stated
|
|
146
|
-
conditions are met. This License explicitly affirms your unlimited
|
|
147
|
-
permission to run the unmodified Program. The output from running a
|
|
148
|
-
covered work is covered by this License only if the output, given its
|
|
149
|
-
content, constitutes a covered work. This License acknowledges your
|
|
150
|
-
rights of fair use or other equivalent, as provided by copyright law.
|
|
151
|
-
|
|
152
|
-
You may make, run and propagate covered works that you do not
|
|
153
|
-
convey, without conditions so long as your license otherwise remains
|
|
154
|
-
in force. You may convey covered works to others for the sole purpose
|
|
155
|
-
of having them make modifications exclusively for you, or provide you
|
|
156
|
-
with facilities for running those works, provided that you comply with
|
|
157
|
-
the terms of this License in conveying all material for which you do
|
|
158
|
-
not control copyright. Those thus making or running the covered works
|
|
159
|
-
for you must do so exclusively on your behalf, under your direction
|
|
160
|
-
and control, on terms that prohibit them from making any copies of
|
|
161
|
-
your copyrighted material outside their relationship with you.
|
|
162
|
-
|
|
163
|
-
Conveying under any other circumstances is permitted solely under
|
|
164
|
-
the conditions stated below. Sublicensing is not allowed; section 10
|
|
165
|
-
makes it unnecessary.
|
|
166
|
-
|
|
167
|
-
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
168
|
-
|
|
169
|
-
No covered work shall be deemed part of an effective technological
|
|
170
|
-
measure under any applicable law fulfilling obligations under article
|
|
171
|
-
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
172
|
-
similar laws prohibiting or restricting circumvention of such
|
|
173
|
-
measures.
|
|
174
|
-
|
|
175
|
-
When you convey a covered work, you waive any legal power to forbid
|
|
176
|
-
circumvention of technological measures to the extent such circumvention
|
|
177
|
-
is effected by exercising rights under this License with respect to
|
|
178
|
-
the covered work, and you disclaim any intention to limit operation or
|
|
179
|
-
modification of the work as a means of enforcing, against the work's
|
|
180
|
-
users, your or third parties' legal rights to forbid circumvention of
|
|
181
|
-
technological measures.
|
|
182
|
-
|
|
183
|
-
4. Conveying Verbatim Copies.
|
|
184
|
-
|
|
185
|
-
You may convey verbatim copies of the Program's source code as you
|
|
186
|
-
receive it, in any medium, provided that you conspicuously and
|
|
187
|
-
appropriately publish on each copy an appropriate copyright notice;
|
|
188
|
-
keep intact all notices stating that this License and any
|
|
189
|
-
non-permissive terms added in accord with section 7 apply to the code;
|
|
190
|
-
keep intact all notices of the absence of any warranty; and give all
|
|
191
|
-
recipients a copy of this License along with the Program.
|
|
192
|
-
|
|
193
|
-
You may charge any price or no price for each copy that you convey,
|
|
194
|
-
and you may offer support or warranty protection for a fee.
|
|
195
|
-
|
|
196
|
-
5. Conveying Modified Source Versions.
|
|
197
|
-
|
|
198
|
-
You may convey a work based on the Program, or the modifications to
|
|
199
|
-
produce it from the Program, in the form of source code under the
|
|
200
|
-
terms of section 4, provided that you also meet all of these conditions:
|
|
201
|
-
|
|
202
|
-
a) The work must carry prominent notices stating that you modified
|
|
203
|
-
it, and giving a relevant date.
|
|
204
|
-
|
|
205
|
-
b) The work must carry prominent notices stating that it is
|
|
206
|
-
released under this License and any conditions added under section
|
|
207
|
-
7. This requirement modifies the requirement in section 4 to
|
|
208
|
-
"keep intact all notices".
|
|
209
|
-
|
|
210
|
-
c) You must license the entire work, as a whole, under this
|
|
211
|
-
License to anyone who comes into possession of a copy. This
|
|
212
|
-
License will therefore apply, along with any applicable section 7
|
|
213
|
-
additional terms, to the whole of the work, and all its parts,
|
|
214
|
-
regardless of how they are packaged. This License gives no
|
|
215
|
-
permission to license the work in any other way, but it does not
|
|
216
|
-
invalidate such permission if you have separately received it.
|
|
217
|
-
|
|
218
|
-
d) If the work has interactive user interfaces, each must display
|
|
219
|
-
Appropriate Legal Notices; however, if the Program has interactive
|
|
220
|
-
interfaces that do not display Appropriate Legal Notices, your
|
|
221
|
-
work need not make them do so.
|
|
222
|
-
|
|
223
|
-
A compilation of a covered work with other separate and independent
|
|
224
|
-
works, which are not by their nature extensions of the covered work,
|
|
225
|
-
and which are not combined with it such as to form a larger program,
|
|
226
|
-
in or on a volume of a storage or distribution medium, is called an
|
|
227
|
-
"aggregate" if the compilation and its resulting copyright are not
|
|
228
|
-
used to limit the access or legal rights of the compilation's users
|
|
229
|
-
beyond what the individual works permit. Inclusion of a covered work
|
|
230
|
-
in an aggregate does not cause this License to apply to the other
|
|
231
|
-
parts of the aggregate.
|
|
232
|
-
|
|
233
|
-
6. Conveying Non-Source Forms.
|
|
234
|
-
|
|
235
|
-
You may convey a covered work in object code form under the terms
|
|
236
|
-
of sections 4 and 5, provided that you also convey the
|
|
237
|
-
machine-readable Corresponding Source under the terms of this License,
|
|
238
|
-
in one of these ways:
|
|
239
|
-
|
|
240
|
-
a) Convey the object code in, or embodied in, a physical product
|
|
241
|
-
(including a physical distribution medium), accompanied by the
|
|
242
|
-
Corresponding Source fixed on a durable physical medium
|
|
243
|
-
customarily used for software interchange.
|
|
244
|
-
|
|
245
|
-
b) Convey the object code in, or embodied in, a physical product
|
|
246
|
-
(including a physical distribution medium), accompanied by a
|
|
247
|
-
written offer, valid for at least three years and valid for as
|
|
248
|
-
long as you offer spare parts or customer support for that product
|
|
249
|
-
model, to give anyone who possesses the object code either (1) a
|
|
250
|
-
copy of the Corresponding Source for all the software in the
|
|
251
|
-
product that is covered by this License, on a durable physical
|
|
252
|
-
medium customarily used for software interchange, for a price no
|
|
253
|
-
more than your reasonable cost of physically performing this
|
|
254
|
-
conveying of source, or (2) access to copy the
|
|
255
|
-
Corresponding Source from a network server at no charge.
|
|
256
|
-
|
|
257
|
-
c) Convey individual copies of the object code with a copy of the
|
|
258
|
-
written offer to provide the Corresponding Source. This
|
|
259
|
-
alternative is allowed only occasionally and noncommercially, and
|
|
260
|
-
only if you received the object code with such an offer, in accord
|
|
261
|
-
with subsection 6b.
|
|
262
|
-
|
|
263
|
-
d) Convey the object code by offering access from a designated
|
|
264
|
-
place (gratis or for a charge), and offer equivalent access to the
|
|
265
|
-
Corresponding Source in the same way through the same place at no
|
|
266
|
-
further charge. You need not require recipients to copy the
|
|
267
|
-
Corresponding Source along with the object code. If the place to
|
|
268
|
-
copy the object code is a network server, the Corresponding Source
|
|
269
|
-
may be on a different server (operated by you or a third party)
|
|
270
|
-
that supports equivalent copying facilities, provided you maintain
|
|
271
|
-
clear directions next to the object code saying where to find the
|
|
272
|
-
Corresponding Source. Regardless of what server hosts the
|
|
273
|
-
Corresponding Source, you remain obligated to ensure that it is
|
|
274
|
-
available for as long as needed to satisfy these requirements.
|
|
275
|
-
|
|
276
|
-
e) Convey the object code using peer-to-peer transmission, provided
|
|
277
|
-
you inform other peers where the object code and Corresponding
|
|
278
|
-
Source of the work are being offered to the general public at no
|
|
279
|
-
charge under subsection 6d.
|
|
280
|
-
|
|
281
|
-
A separable portion of the object code, whose source code is excluded
|
|
282
|
-
from the Corresponding Source as a System Library, need not be
|
|
283
|
-
included in conveying the object code work.
|
|
284
|
-
|
|
285
|
-
A "User Product" is either (1) a "consumer product", which means any
|
|
286
|
-
tangible personal property which is normally used for personal, family,
|
|
287
|
-
or household purposes, or (2) anything designed or sold for incorporation
|
|
288
|
-
into a dwelling. In determining whether a product is a consumer product,
|
|
289
|
-
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
290
|
-
product received by a particular user, "normally used" refers to a
|
|
291
|
-
typical or common use of that class of product, regardless of the status
|
|
292
|
-
of the particular user or of the way in which the particular user
|
|
293
|
-
actually uses, or expects or is expected to use, the product. A product
|
|
294
|
-
is a consumer product regardless of whether the product has substantial
|
|
295
|
-
commercial, industrial or non-consumer uses, unless such uses represent
|
|
296
|
-
the only significant mode of use of the product.
|
|
297
|
-
|
|
298
|
-
"Installation Information" for a User Product means any methods,
|
|
299
|
-
procedures, authorization keys, or other information required to install
|
|
300
|
-
and execute modified versions of a covered work in that User Product from
|
|
301
|
-
a modified version of its Corresponding Source. The information must
|
|
302
|
-
suffice to ensure that the continued functioning of the modified object
|
|
303
|
-
code is in no case prevented or interfered with solely because
|
|
304
|
-
modification has been made.
|
|
305
|
-
|
|
306
|
-
If you convey an object code work under this section in, or with, or
|
|
307
|
-
specifically for use in, a User Product, and the conveying occurs as
|
|
308
|
-
part of a transaction in which the right of possession and use of the
|
|
309
|
-
User Product is transferred to the recipient in perpetuity or for a
|
|
310
|
-
fixed term (regardless of how the transaction is characterized), the
|
|
311
|
-
Corresponding Source conveyed under this section must be accompanied
|
|
312
|
-
by the Installation Information. But this requirement does not apply
|
|
313
|
-
if neither you nor any third party retains the ability to install
|
|
314
|
-
modified object code on the User Product (for example, the work has
|
|
315
|
-
been installed in ROM).
|
|
316
|
-
|
|
317
|
-
The requirement to provide Installation Information does not include a
|
|
318
|
-
requirement to continue to provide support service, warranty, or updates
|
|
319
|
-
for a work that has been modified or installed by the recipient, or for
|
|
320
|
-
the User Product in which it has been modified or installed. Access to a
|
|
321
|
-
network may be denied when the modification itself materially and
|
|
322
|
-
adversely affects the operation of the network or violates the rules and
|
|
323
|
-
protocols for communication across the network.
|
|
324
|
-
|
|
325
|
-
Corresponding Source conveyed, and Installation Information provided,
|
|
326
|
-
in accord with this section must be in a format that is publicly
|
|
327
|
-
documented (and with an implementation available to the public in
|
|
328
|
-
source code form), and must require no special password or key for
|
|
329
|
-
unpacking, reading or copying.
|
|
330
|
-
|
|
331
|
-
7. Additional Terms.
|
|
332
|
-
|
|
333
|
-
"Additional permissions" are terms that supplement the terms of this
|
|
334
|
-
License by making exceptions from one or more of its conditions.
|
|
335
|
-
Additional permissions that are applicable to the entire Program shall
|
|
336
|
-
be treated as though they were included in this License, to the extent
|
|
337
|
-
that they are valid under applicable law. If additional permissions
|
|
338
|
-
apply only to part of the Program, that part may be used separately
|
|
339
|
-
under those permissions, but the entire Program remains governed by
|
|
340
|
-
this License without regard to the additional permissions.
|
|
341
|
-
|
|
342
|
-
When you convey a copy of a covered work, you may at your option
|
|
343
|
-
remove any additional permissions from that copy, or from any part of
|
|
344
|
-
it. (Additional permissions may be written to require their own
|
|
345
|
-
removal in certain cases when you modify the work.) You may place
|
|
346
|
-
additional permissions on material, added by you to a covered work,
|
|
347
|
-
for which you have or can give appropriate copyright permission.
|
|
348
|
-
|
|
349
|
-
Notwithstanding any other provision of this License, for material you
|
|
350
|
-
add to a covered work, you may (if authorized by the copyright holders of
|
|
351
|
-
that material) supplement the terms of this License with terms:
|
|
352
|
-
|
|
353
|
-
a) Disclaiming warranty or limiting liability differently from the
|
|
354
|
-
terms of sections 15 and 16 of this License; or
|
|
355
|
-
|
|
356
|
-
b) Requiring preservation of specified reasonable legal notices or
|
|
357
|
-
author attributions in that material or in the Appropriate Legal
|
|
358
|
-
Notices displayed by works containing it; or
|
|
359
|
-
|
|
360
|
-
c) Prohibiting misrepresentation of the origin of that material, or
|
|
361
|
-
requiring that modified versions of such material be marked in
|
|
362
|
-
reasonable ways as different from the original version; or
|
|
363
|
-
|
|
364
|
-
d) Limiting the use for publicity purposes of names of licensors or
|
|
365
|
-
authors of the material; or
|
|
366
|
-
|
|
367
|
-
e) Declining to grant rights under trademark law for use of some
|
|
368
|
-
trade names, trademarks, or service marks; or
|
|
369
|
-
|
|
370
|
-
f) Requiring indemnification of licensors and authors of that
|
|
371
|
-
material by anyone who conveys the material (or modified versions of
|
|
372
|
-
it) with contractual assumptions of liability to the recipient, for
|
|
373
|
-
any liability that these contractual assumptions directly impose on
|
|
374
|
-
those licensors and authors.
|
|
375
|
-
|
|
376
|
-
All other non-permissive additional terms are considered "further
|
|
377
|
-
restrictions" within the meaning of section 10. If the Program as you
|
|
378
|
-
received it, or any part of it, contains a notice stating that it is
|
|
379
|
-
governed by this License along with a term that is a further
|
|
380
|
-
restriction, you may remove that term. If a license document contains
|
|
381
|
-
a further restriction but permits relicensing or conveying under this
|
|
382
|
-
License, you may add to a covered work material governed by the terms
|
|
383
|
-
of that license document, provided that the further restriction does
|
|
384
|
-
not survive such relicensing or conveying.
|
|
385
|
-
|
|
386
|
-
If you add terms to a covered work in accord with this section, you
|
|
387
|
-
must place, in the relevant source files, a statement of the
|
|
388
|
-
additional terms that apply to those files, or a notice indicating
|
|
389
|
-
where to find the applicable terms.
|
|
390
|
-
|
|
391
|
-
Additional terms, permissive or non-permissive, may be stated in the
|
|
392
|
-
form of a separately written license, or stated as exceptions;
|
|
393
|
-
the above requirements apply either way.
|
|
394
|
-
|
|
395
|
-
8. Termination.
|
|
396
|
-
|
|
397
|
-
You may not propagate or modify a covered work except as expressly
|
|
398
|
-
provided under this License. Any attempt otherwise to propagate or
|
|
399
|
-
modify it is void, and will automatically terminate your rights under
|
|
400
|
-
this License (including any patent licenses granted under the third
|
|
401
|
-
paragraph of section 11).
|
|
402
|
-
|
|
403
|
-
However, if you cease all violation of this License, then your
|
|
404
|
-
license from a particular copyright holder is reinstated (a)
|
|
405
|
-
provisionally, unless and until the copyright holder explicitly and
|
|
406
|
-
finally terminates your license, and (b) permanently, if the copyright
|
|
407
|
-
holder fails to notify you of the violation by some reasonable means
|
|
408
|
-
prior to 60 days after the cessation.
|
|
409
|
-
|
|
410
|
-
Moreover, your license from a particular copyright holder is
|
|
411
|
-
reinstated permanently if the copyright holder notifies you of the
|
|
412
|
-
violation by some reasonable means, this is the first time you have
|
|
413
|
-
received notice of violation of this License (for any work) from that
|
|
414
|
-
copyright holder, and you cure the violation prior to 30 days after
|
|
415
|
-
your receipt of the notice.
|
|
416
|
-
|
|
417
|
-
Termination of your rights under this section does not terminate the
|
|
418
|
-
licenses of parties who have received copies or rights from you under
|
|
419
|
-
this License. If your rights have been terminated and not permanently
|
|
420
|
-
reinstated, you do not qualify to receive new licenses for the same
|
|
421
|
-
material under section 10.
|
|
422
|
-
|
|
423
|
-
9. Acceptance Not Required for Having Copies.
|
|
424
|
-
|
|
425
|
-
You are not required to accept this License in order to receive or
|
|
426
|
-
run a copy of the Program. Ancillary propagation of a covered work
|
|
427
|
-
occurring solely as a consequence of using peer-to-peer transmission
|
|
428
|
-
to receive a copy likewise does not require acceptance. However,
|
|
429
|
-
nothing other than this License grants you permission to propagate or
|
|
430
|
-
modify any covered work. These actions infringe copyright if you do
|
|
431
|
-
not accept this License. Therefore, by modifying or propagating a
|
|
432
|
-
covered work, you indicate your acceptance of this License to do so.
|
|
433
|
-
|
|
434
|
-
10. Automatic Licensing of Downstream Recipients.
|
|
435
|
-
|
|
436
|
-
Each time you convey a covered work, the recipient automatically
|
|
437
|
-
receives a license from the original licensors, to run, modify and
|
|
438
|
-
propagate that work, subject to this License. You are not responsible
|
|
439
|
-
for enforcing compliance by third parties with this License.
|
|
440
|
-
|
|
441
|
-
An "entity transaction" is a transaction transferring control of an
|
|
442
|
-
organization, or substantially all assets of one, or subdividing an
|
|
443
|
-
organization, or merging organizations. If propagation of a covered
|
|
444
|
-
work results from an entity transaction, each party to that
|
|
445
|
-
transaction who receives a copy of the work also receives whatever
|
|
446
|
-
licenses to the work the party's predecessor in interest had or could
|
|
447
|
-
give under the previous paragraph, plus a right to possession of the
|
|
448
|
-
Corresponding Source of the work from the predecessor in interest, if
|
|
449
|
-
the predecessor has it or can get it with reasonable efforts.
|
|
450
|
-
|
|
451
|
-
You may not impose any further restrictions on the exercise of the
|
|
452
|
-
rights granted or affirmed under this License. For example, you may
|
|
453
|
-
not impose a license fee, royalty, or other charge for exercise of
|
|
454
|
-
rights granted under this License, and you may not initiate litigation
|
|
455
|
-
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
456
|
-
any patent claim is infringed by making, using, selling, offering for
|
|
457
|
-
sale, or importing the Program or any portion of it.
|
|
458
|
-
|
|
459
|
-
11. Patents.
|
|
460
|
-
|
|
461
|
-
A "contributor" is a copyright holder who authorizes use under this
|
|
462
|
-
License of the Program or a work on which the Program is based. The
|
|
463
|
-
work thus licensed is called the contributor's "contributor version".
|
|
464
|
-
|
|
465
|
-
A contributor's "essential patent claims" are all patent claims
|
|
466
|
-
owned or controlled by the contributor, whether already acquired or
|
|
467
|
-
hereafter acquired, that would be infringed by some manner, permitted
|
|
468
|
-
by this License, of making, using, or selling its contributor version,
|
|
469
|
-
but do not include claims that would be infringed only as a
|
|
470
|
-
consequence of further modification of the contributor version. For
|
|
471
|
-
purposes of this definition, "control" includes the right to grant
|
|
472
|
-
patent sublicenses in a manner consistent with the requirements of
|
|
473
|
-
this License.
|
|
474
|
-
|
|
475
|
-
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
476
|
-
patent license under the contributor's essential patent claims, to
|
|
477
|
-
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
478
|
-
propagate the contents of its contributor version.
|
|
479
|
-
|
|
480
|
-
In the following three paragraphs, a "patent license" is any express
|
|
481
|
-
agreement or commitment, however denominated, not to enforce a patent
|
|
482
|
-
(such as an express permission to practice a patent or covenant not to
|
|
483
|
-
sue for patent infringement). To "grant" such a patent license to a
|
|
484
|
-
party means to make such an agreement or commitment not to enforce a
|
|
485
|
-
patent against the party.
|
|
486
|
-
|
|
487
|
-
If you convey a covered work, knowingly relying on a patent license,
|
|
488
|
-
and the Corresponding Source of the work is not available for anyone
|
|
489
|
-
to copy, free of charge and under the terms of this License, through a
|
|
490
|
-
publicly available network server or other readily accessible means,
|
|
491
|
-
then you must either (1) cause the Corresponding Source to be so
|
|
492
|
-
available, or (2) arrange to deprive yourself of the benefit of the
|
|
493
|
-
patent license for this particular work, or (3) arrange, in a manner
|
|
494
|
-
consistent with the requirements of this License, to extend the patent
|
|
495
|
-
license to downstream recipients. "Knowingly relying" means you have
|
|
496
|
-
actual knowledge that, but for the patent license, your conveying the
|
|
497
|
-
covered work in a country, or your recipient's use of the covered work
|
|
498
|
-
in a country, would infringe one or more identifiable patents in that
|
|
499
|
-
country that you have reason to believe are valid.
|
|
500
|
-
|
|
501
|
-
If, pursuant to or in connection with a single transaction or
|
|
502
|
-
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
503
|
-
covered work, and grant a patent license to some of the parties
|
|
504
|
-
receiving the covered work authorizing them to use, propagate, modify
|
|
505
|
-
or convey a specific copy of the covered work, then the patent license
|
|
506
|
-
you grant is automatically extended to all recipients of the covered
|
|
507
|
-
work and works based on it.
|
|
508
|
-
|
|
509
|
-
A patent license is "discriminatory" if it does not include within
|
|
510
|
-
the scope of its coverage, prohibits the exercise of, or is
|
|
511
|
-
conditioned on the non-exercise of one or more of the rights that are
|
|
512
|
-
specifically granted under this License. You may not convey a covered
|
|
513
|
-
work if you are a party to an arrangement with a third party that is
|
|
514
|
-
in the business of distributing software, under which you make payment
|
|
515
|
-
to the third party based on the extent of your activity of conveying
|
|
516
|
-
the work, and under which the third party grants, to any of the
|
|
517
|
-
parties who would receive the covered work from you, a discriminatory
|
|
518
|
-
patent license (a) in connection with copies of the covered work
|
|
519
|
-
conveyed by you (or copies made from those copies), or (b) primarily
|
|
520
|
-
for and in connection with specific products or compilations that
|
|
521
|
-
contain the covered work, unless you entered into that arrangement,
|
|
522
|
-
or that patent license was granted, prior to 28 March 2007.
|
|
523
|
-
|
|
524
|
-
Nothing in this License shall be construed as excluding or limiting
|
|
525
|
-
any implied license or other defenses to infringement that may
|
|
526
|
-
otherwise be available to you under applicable patent law.
|
|
527
|
-
|
|
528
|
-
12. No Surrender of Others' Freedom.
|
|
529
|
-
|
|
530
|
-
If conditions are imposed on you (whether by court order, agreement or
|
|
531
|
-
otherwise) that contradict the conditions of this License, they do not
|
|
532
|
-
excuse you from the conditions of this License. If you cannot convey a
|
|
533
|
-
covered work so as to satisfy simultaneously your obligations under this
|
|
534
|
-
License and any other pertinent obligations, then as a consequence you may
|
|
535
|
-
not convey it at all. For example, if you agree to terms that obligate you
|
|
536
|
-
to collect a royalty for further conveying from those to whom you convey
|
|
537
|
-
the Program, the only way you could satisfy both those terms and this
|
|
538
|
-
License would be to refrain entirely from conveying the Program.
|
|
539
|
-
|
|
540
|
-
13. Remote Network Interaction; Use with the GNU General Public License.
|
|
541
|
-
|
|
542
|
-
Notwithstanding any other provision of this License, if you modify the
|
|
543
|
-
Program, your modified version must prominently offer all users
|
|
544
|
-
interacting with it remotely through a computer network (if your version
|
|
545
|
-
supports such interaction) an opportunity to receive the Corresponding
|
|
546
|
-
Source of your version by providing access to the Corresponding Source
|
|
547
|
-
from a network server at no charge, through some standard or customary
|
|
548
|
-
means of facilitating copying of software. This Corresponding Source
|
|
549
|
-
shall include the Corresponding Source for any work covered by version 3
|
|
550
|
-
of the GNU General Public License that is incorporated pursuant to the
|
|
551
|
-
following paragraph.
|
|
552
|
-
|
|
553
|
-
Notwithstanding any other provision of this License, you have
|
|
554
|
-
permission to link or combine any covered work with a work licensed
|
|
555
|
-
under version 3 of the GNU General Public License into a single
|
|
556
|
-
combined work, and to convey the resulting work. The terms of this
|
|
557
|
-
License will continue to apply to the part which is the covered work,
|
|
558
|
-
but the work with which it is combined will remain governed by version
|
|
559
|
-
3 of the GNU General Public License.
|
|
560
|
-
|
|
561
|
-
14. Revised Versions of this License.
|
|
562
|
-
|
|
563
|
-
The Free Software Foundation may publish revised and/or new versions of
|
|
564
|
-
the GNU Affero General Public License from time to time. Such new versions
|
|
565
|
-
will be similar in spirit to the present version, but may differ in detail to
|
|
566
|
-
address new problems or concerns.
|
|
567
|
-
|
|
568
|
-
Each version is given a distinguishing version number. If the
|
|
569
|
-
Program specifies that a certain numbered version of the GNU Affero General
|
|
570
|
-
Public License "or any later version" applies to it, you have the
|
|
571
|
-
option of following the terms and conditions either of that numbered
|
|
572
|
-
version or of any later version published by the Free Software
|
|
573
|
-
Foundation. If the Program does not specify a version number of the
|
|
574
|
-
GNU Affero General Public License, you may choose any version ever published
|
|
575
|
-
by the Free Software Foundation.
|
|
576
|
-
|
|
577
|
-
If the Program specifies that a proxy can decide which future
|
|
578
|
-
versions of the GNU Affero General Public License can be used, that proxy's
|
|
579
|
-
public statement of acceptance of a version permanently authorizes you
|
|
580
|
-
to choose that version for the Program.
|
|
581
|
-
|
|
582
|
-
Later license versions may give you additional or different
|
|
583
|
-
permissions. However, no additional obligations are imposed on any
|
|
584
|
-
author or copyright holder as a result of your choosing to follow a
|
|
585
|
-
later version.
|
|
586
|
-
|
|
587
|
-
15. Disclaimer of Warranty.
|
|
588
|
-
|
|
589
|
-
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
590
|
-
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
591
|
-
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
592
|
-
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
593
|
-
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
594
|
-
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
595
|
-
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
596
|
-
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
597
|
-
|
|
598
|
-
16. Limitation of Liability.
|
|
599
|
-
|
|
600
|
-
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
601
|
-
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
602
|
-
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
603
|
-
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
604
|
-
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
605
|
-
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
606
|
-
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
607
|
-
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
608
|
-
SUCH DAMAGES.
|
|
609
|
-
|
|
610
|
-
17. Interpretation of Sections 15 and 16.
|
|
611
|
-
|
|
612
|
-
If the disclaimer of warranty and limitation of liability provided
|
|
613
|
-
above cannot be given local legal effect according to their terms,
|
|
614
|
-
reviewing courts shall apply local law that most closely approximates
|
|
615
|
-
an absolute waiver of all civil liability in connection with the
|
|
616
|
-
Program, unless a warranty or assumption of liability accompanies a
|
|
617
|
-
copy of the Program in return for a fee.
|
|
618
|
-
|
|
619
|
-
END OF TERMS AND CONDITIONS
|
|
620
|
-
|
|
621
|
-
How to Apply These Terms to Your New Programs
|
|
622
|
-
|
|
623
|
-
If you develop a new program, and you want it to be of the greatest
|
|
624
|
-
possible use to the public, the best way to achieve this is to make it
|
|
625
|
-
free software which everyone can redistribute and change under these terms.
|
|
626
|
-
|
|
627
|
-
To do so, attach the following notices to the program. It is safest
|
|
628
|
-
to attach them to the start of each source file to most effectively
|
|
629
|
-
state the exclusion of warranty; and each file should have at least
|
|
630
|
-
the "copyright" line and a pointer to where the full notice is found.
|
|
631
|
-
|
|
632
|
-
<one line to give the program's name and a brief idea of what it does.>
|
|
633
|
-
Copyright (C) <year> <name of author>
|
|
634
|
-
|
|
635
|
-
This program is free software: you can redistribute it and/or modify
|
|
636
|
-
it under the terms of the GNU Affero General Public License as published
|
|
637
|
-
by the Free Software Foundation, either version 3 of the License, or
|
|
638
|
-
(at your option) any later version.
|
|
639
|
-
|
|
640
|
-
This program is distributed in the hope that it will be useful,
|
|
641
|
-
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
642
|
-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
643
|
-
GNU Affero General Public License for more details.
|
|
644
|
-
|
|
645
|
-
You should have received a copy of the GNU Affero General Public License
|
|
646
|
-
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
647
|
-
|
|
648
|
-
Also add information on how to contact you by electronic and paper mail.
|
|
649
|
-
|
|
650
|
-
If your software can interact with users remotely through a computer
|
|
651
|
-
network, you should also make sure that it provides a way for users to
|
|
652
|
-
get its source. For example, if your program is a web application, its
|
|
653
|
-
interface could display a "Source" link that leads users to an archive
|
|
654
|
-
of the code. There are many ways you could offer source, and different
|
|
655
|
-
solutions will be better for different programs; see section 13 for the
|
|
656
|
-
specific requirements.
|
|
657
|
-
|
|
658
|
-
You should also get your employer (if you work as a programmer) or school,
|
|
659
|
-
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
660
|
-
For more information on this, and how to apply and follow the GNU AGPL, see
|
|
661
|
-
<https://www.gnu.org/licenses/>.
|
package/README.md
DELETED
|
@@ -1,549 +0,0 @@
|
|
|
1
|
-
<p align="center">
|
|
2
|
-
<picture>
|
|
3
|
-
<source media="(prefers-color-scheme: dark)" srcset=".github/assets/logo-dark.svg">
|
|
4
|
-
<img src=".github/assets/logo.svg" width="130" alt="Tiechui">
|
|
5
|
-
</picture>
|
|
6
|
-
</p>
|
|
7
|
-
|
|
8
|
-
<h1 align="center">Tiechui · 铁锤</h1>
|
|
9
|
-
|
|
10
|
-
<p align="center">
|
|
11
|
-
A terminal coding agent written in Rust.<br>
|
|
12
|
-
One binary, installed as <code>chui</code> and <code>tiechui</code>, with an interactive terminal UI and a headless <code>exec</code>.
|
|
13
|
-
</p>
|
|
14
|
-
|
|
15
|
-
<p align="center">
|
|
16
|
-
<img alt="Rust 1.95" src="https://img.shields.io/badge/Rust-1.95-8fa8c9?style=flat-square&logo=rust&logoColor=white">
|
|
17
|
-
<img alt="macOS | Linux | Windows" src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-a99ccf?style=flat-square">
|
|
18
|
-
<img alt="Anthropic · OpenAI" src="https://img.shields.io/badge/wires-Anthropic%20%C2%B7%20OpenAI-8fb996?style=flat-square">
|
|
19
|
-
<a href="LICENSE"><img alt="AGPL-3.0" src="https://img.shields.io/badge/license-AGPL--3.0-d6b07a?style=flat-square"></a>
|
|
20
|
-
</p>
|
|
21
|
-
|
|
22
|
-
<p align="center">
|
|
23
|
-
<b>English</b> · <a href="README.zh-CN.md">简体中文</a> · <a href="https://b1ank1108.github.io/tiechui/">UI gallery</a>
|
|
24
|
-
</p>
|
|
25
|
-
|
|
26
|
-
<p align="center">
|
|
27
|
-
<img src=".github/assets/tui.png" width="720" alt="chui in a terminal: the session header, a turn with tool calls, a diff and a background shell, the composer, the status line in auto mode and the background activity row">
|
|
28
|
-
</p>
|
|
29
|
-
|
|
30
|
-
## Highlights
|
|
31
|
-
|
|
32
|
-
- **Two provider wires.** Anthropic Messages and OpenAI Chat Completions, including compatible gateways.
|
|
33
|
-
- **Sessions you can rewind.** Append-only JSONL with branches, resume, rewind and compaction.
|
|
34
|
-
- **A permission gate.** Rules for tools, shell commands, paths and MCP calls, in three modes: `rules`, `auto` (a model reviews what the rules would ask about) and `yolo`.
|
|
35
|
-
- **Background shells.** Long-running commands move to the background; the model is told when they finish.
|
|
36
|
-
- **Modules.** Questions, side chats, goals, scheduled prompts, subagents, skills, hooks and MCP.
|
|
37
|
-
- **Plugins.** Declarative T1 packages, out-of-process T2 JSON-RPC plugins with Rust and TypeScript SDKs, and a Git marketplace.
|
|
38
|
-
|
|
39
|
-
The interactive UI and `exec` run on the same session actor, providers, tools,
|
|
40
|
-
permissions and modules.
|
|
41
|
-
|
|
42
|
-
[Quick start](#quick-start) · [Install](#install) · [Configure](#configure) ·
|
|
43
|
-
[Use](#use) · [UI gallery](#ui-gallery) · [Permissions](#permissions-and-trust) ·
|
|
44
|
-
[Extend](#extend) · [Develop](#develop) · [Status](#status) · [License](#license)
|
|
45
|
-
|
|
46
|
-
## Quick start
|
|
47
|
-
|
|
48
|
-
```sh
|
|
49
|
-
npm i -g @tiechui/cli
|
|
50
|
-
chui
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
With no provider configured, `chui` asks for the service, address, key and model,
|
|
54
|
-
lists the models the service offers, checks them with one request and saves the
|
|
55
|
-
answers to `~/.tiechui`. `chui setup` adds another provider later.
|
|
56
|
-
|
|
57
|
-
## Install
|
|
58
|
-
|
|
59
|
-
macOS, Linux and Windows (x64) are supported. `rg` is used for content search;
|
|
60
|
-
file discovery and `@` completion are built in. On Windows the bash tool runs
|
|
61
|
-
through Git Bash from [Git for Windows](https://git-scm.com/download/win); set
|
|
62
|
-
`TIECHUI_GIT_BASH_PATH` if it is not found automatically.
|
|
63
|
-
|
|
64
|
-
**npm.**
|
|
65
|
-
|
|
66
|
-
```sh
|
|
67
|
-
npm i -g @tiechui/cli
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
Node 16 or later runs the native build for your platform, which npm installs as
|
|
71
|
-
an optional dependency. pnpm, yarn and bun work too.
|
|
72
|
-
|
|
73
|
-
**macOS and Linux.**
|
|
74
|
-
|
|
75
|
-
```sh
|
|
76
|
-
curl -fsSL https://github.com/b1ank1108/tiechui/releases/latest/download/install.sh | sh
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
It verifies the archive against `SHA256SUMS` and installs `chui` and `tiechui`
|
|
80
|
-
into `~/.local/bin`. Set `TIECHUI_VERSION` to pin a release or
|
|
81
|
-
`TIECHUI_INSTALL_DIR` to choose another directory.
|
|
82
|
-
|
|
83
|
-
**Windows (PowerShell).**
|
|
84
|
-
|
|
85
|
-
```powershell
|
|
86
|
-
irm https://github.com/b1ank1108/tiechui/releases/latest/download/install.ps1 | iex
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
It installs into `%LOCALAPPDATA%\Programs\tiechui` and adds that directory to
|
|
90
|
-
the user `Path`. The same variables apply.
|
|
91
|
-
|
|
92
|
-
Building from source needs Rust through rustup (the checkout pins **1.95.0**
|
|
93
|
-
with rustfmt and clippy) and Git.
|
|
94
|
-
|
|
95
|
-
**From source.** `cargo install --locked --path crates/tiechui-cli --root
|
|
96
|
-
<prefix>` installs `chui` and `tiechui` into `<prefix>/bin`. For development,
|
|
97
|
-
`cargo run --locked --bin chui -- --help` runs without installing.
|
|
98
|
-
|
|
99
|
-
**Managed install from a source checkout (macOS and Linux).** Build a tarball
|
|
100
|
-
with `cargo xtask dist`, or download one from a GitHub Release, then:
|
|
101
|
-
|
|
102
|
-
```sh
|
|
103
|
-
cargo xtask install tiechui-VERSION-TARGET.tar.gz --prefix ~/.local
|
|
104
|
-
~/.local/bin/chui doctor --prefix ~/.local
|
|
105
|
-
cargo xtask uninstall --prefix ~/.local
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
The installer has no default prefix. It:
|
|
109
|
-
|
|
110
|
-
- validates the archive and its manifest;
|
|
111
|
-
- records the hash of each binary it owns in `<prefix>/.tiechui-install/`;
|
|
112
|
-
- refuses to replace commands it did not install, including a `cargo install` copy;
|
|
113
|
-
- repairs moved or partial installs;
|
|
114
|
-
- rolls interrupted runs back through a journal.
|
|
115
|
-
|
|
116
|
-
Installation never touches the profile or your sessions. `cargo xtask
|
|
117
|
-
verify-release` runs the full release checks against a candidate.
|
|
118
|
-
|
|
119
|
-
## Configure
|
|
120
|
-
|
|
121
|
-
The profile directory is `$TIECHUI_HOME`, default `~/.tiechui`:
|
|
122
|
-
|
|
123
|
-
| Path | Contents |
|
|
124
|
-
| --- | --- |
|
|
125
|
-
| `config.toml` | Model selection, modules, permissions, MCP servers, UI |
|
|
126
|
-
| `providers.toml` | Providers and their models |
|
|
127
|
-
| `sessions/` | Session logs, grouped by working directory |
|
|
128
|
-
| `trust.json` | Project trust decisions |
|
|
129
|
-
| `plugins/`, `plugin-grants/`, `plugin-data/` | Installed packages, capability grants, plugin data |
|
|
130
|
-
| `mcp-oauth/` | MCP OAuth tokens (0600) |
|
|
131
|
-
| `agents/`, `themes/` | User subagent definitions, extra `.tmTheme` files |
|
|
132
|
-
| `state/` | Rewind, compaction and subagent state |
|
|
133
|
-
|
|
134
|
-
Configuration layers are applied in this order:
|
|
135
|
-
|
|
136
|
-
1. built-in defaults;
|
|
137
|
-
2. `~/.tiechui/config.toml`;
|
|
138
|
-
3. the nearest project's `.agents/config.toml` (or `.claude/config.toml`);
|
|
139
|
-
4. CLI flags.
|
|
140
|
-
|
|
141
|
-
Project files are searched up to the Git root and are ignored until you trust
|
|
142
|
-
the project. Providers come only from `~/.tiechui/providers.toml`; no project
|
|
143
|
-
or CLI layer can add or change them. There is no built-in model catalog, so you
|
|
144
|
-
declare every model.
|
|
145
|
-
|
|
146
|
-
The closest config wins; at the same directory `.agents/config.toml` takes
|
|
147
|
-
precedence over `.claude/config.toml`. Both use Tiechui's TOML schema. Supported
|
|
148
|
-
hooks can also come from `.claude/settings.json` and `.claude/settings.local.json`;
|
|
149
|
-
other Claude settings are not imported. Project `.tiechui/` resources are ignored.
|
|
150
|
-
The user profile remains `$TIECHUI_HOME` (default `~/.tiechui`).
|
|
151
|
-
|
|
152
|
-
[examples/config.toml](examples/config.toml) lists every supported configuration
|
|
153
|
-
field with explanations, and [examples/providers.toml](examples/providers.toml)
|
|
154
|
-
does the same for providers. Active entries preserve default behavior; optional
|
|
155
|
-
settings and non-default examples are commented out. `chui setup` writes the
|
|
156
|
-
minimal setup below for you: your own endpoint and model, then selects it.
|
|
157
|
-
|
|
158
|
-
`~/.tiechui/providers.toml`, where each top-level table is one provider:
|
|
159
|
-
|
|
160
|
-
```toml
|
|
161
|
-
[gateway]
|
|
162
|
-
wire = "openai-completions" # or "anthropic-messages"
|
|
163
|
-
base_url = "https://gateway.example" # /v1 is added unless the URL has a version
|
|
164
|
-
api_key_env = "GATEWAY_API_KEY" # or api_key = "..." to write the key inline
|
|
165
|
-
|
|
166
|
-
[gateway.compat] # only for non-OpenAI services
|
|
167
|
-
thinking_format = "deepseek"
|
|
168
|
-
max_tokens_field = "max_tokens"
|
|
169
|
-
requires_reasoning_content_on_assistant_messages = true
|
|
170
|
-
|
|
171
|
-
[[gateway.models]]
|
|
172
|
-
id = "example-model"
|
|
173
|
-
context_window = 400000
|
|
174
|
-
max_output = 131072
|
|
175
|
-
reasoning = true
|
|
176
|
-
images = true
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
`~/.tiechui/config.toml`:
|
|
180
|
-
|
|
181
|
-
```toml
|
|
182
|
-
model = "gateway/example-model" # <provider>/<model id>
|
|
183
|
-
thinking = "high" # off | minimal | low | medium | high | xhigh | max
|
|
184
|
-
|
|
185
|
-
[tui]
|
|
186
|
-
theme = "automatic" # follows the terminal background
|
|
187
|
-
|
|
188
|
-
[modules]
|
|
189
|
-
# goal = false # every built-in module is on by default
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
- If `base_url` is omitted, the default is `https://api.anthropic.com` or
|
|
193
|
-
`https://api.openai.com`, depending on the wire. A URL without a version
|
|
194
|
-
segment gets `/v1`; one that has its own, such as `/api/paas/v4`, is kept.
|
|
195
|
-
- The `compat` table adapts the request to services such as DeepSeek-style
|
|
196
|
-
reasoning gateways. A model's own `compat` table overrides single members, for
|
|
197
|
-
gateways that mix model families.
|
|
198
|
-
- Thinking levels are clamped to what the model declares in `thinking_levels`.
|
|
199
|
-
- Models can also set `cache_retention`, `prices` and, on Anthropic,
|
|
200
|
-
`fallback_models`.
|
|
201
|
-
|
|
202
|
-
Each provider takes its key from `api_key` in `providers.toml` or from the
|
|
203
|
-
environment variable named by `api_key_env`, never both. An inline key stays out
|
|
204
|
-
of the environment that tools inherit; keep the file private with `chmod 600`,
|
|
205
|
-
which `chui doctor` checks. Tiechui does not load any secrets file itself, so with
|
|
206
|
-
`api_key_env` export the variable in the shell that starts `chui`.
|
|
207
|
-
[schema/config.json](schema/config.json) and
|
|
208
|
-
[schema/providers.json](schema/providers.json) are the complete key references, and
|
|
209
|
-
[crates/tiechui-providers](crates/tiechui-providers/README.md) covers wire
|
|
210
|
-
compatibility.
|
|
211
|
-
|
|
212
|
-
## Use
|
|
213
|
-
|
|
214
|
-
```sh
|
|
215
|
-
chui # interactive, current directory
|
|
216
|
-
chui --cwd ~/src/app --model gateway/example-model --thinking high
|
|
217
|
-
chui --mode auto # permission mode for this run
|
|
218
|
-
chui --resume # pick a saved session
|
|
219
|
-
chui --resume SESSION_ID
|
|
220
|
-
chui exec "Explain the failing tests" # headless, prints the answer
|
|
221
|
-
chui exec "Continue" --resume SESSION_ID --json --approval allow-listed
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
`chui exec` accepts:
|
|
225
|
-
|
|
226
|
-
- `--model`, `--thinking`, `--mode` and `--cwd`;
|
|
227
|
-
- `--resume ID` (headless resume always needs an ID);
|
|
228
|
-
- `--json`, which prints protocol events;
|
|
229
|
-
- `--approval`, described in [Permissions and trust](#permissions-and-trust).
|
|
230
|
-
|
|
231
|
-
Other subcommands are `setup`, `doctor`, `trust`, `plugin`, `skills`, `hooks`
|
|
232
|
-
and `mcp`, and each has `--help`. The built-in tools are `read`, `write`, `edit`,
|
|
233
|
-
`grep`, `find` and `bash`, plus `shell_list`, `shell_output` and `shell_stop` for
|
|
234
|
-
background commands. Modules, plugins and MCP servers add more.
|
|
235
|
-
|
|
236
|
-
### Keys
|
|
237
|
-
|
|
238
|
-
| Key | Action |
|
|
239
|
-
| --- | --- |
|
|
240
|
-
| Enter | Send. While a turn is running, this queues steering for after the next tool call |
|
|
241
|
-
| Tab | Queue a follow-up; complete a menu item |
|
|
242
|
-
| Shift+Enter, Ctrl+J | New line |
|
|
243
|
-
| Up / Down | Input history |
|
|
244
|
-
| Alt+S | Stash or restore the draft |
|
|
245
|
-
| Esc | Stop the running turn. When idle, press twice to clear the draft; with an empty composer, twice opens rewind |
|
|
246
|
-
| Ctrl+O | Expanded transcript (scroll, select, copy) |
|
|
247
|
-
| Ctrl+V | Attach a clipboard image (PNG, JPEG, GIF, WebP, up to 20 MiB) |
|
|
248
|
-
| Ctrl+/ | Switch between the main chat and the side chat (`/btw`) |
|
|
249
|
-
| Alt+Left / Alt+Right | Open the subagent viewer (empty composer) |
|
|
250
|
-
| Ctrl+C | Clear input; press again to exit. Ctrl+D exits from an empty composer |
|
|
251
|
-
|
|
252
|
-
In the composer:
|
|
253
|
-
|
|
254
|
-
- `/` opens commands above the composer: Tab completes, Enter runs.
|
|
255
|
-
- `@` finds files and directories. Tab enters a directory; Enter inserts an `@path` reference. Shift+Tab switches to All, including plugins, skills and tasks.
|
|
256
|
-
- `$` selects a skill by name or description; Tab/Enter inserts its bound reference. Its instructions load when you send the message.
|
|
257
|
-
- `!command` runs a shell command through the permission gate. Like the model's commands, it shows in `/shells` and can move to the background.
|
|
258
|
-
|
|
259
|
-
The status line below the composer shows the model, directory and branch on the
|
|
260
|
-
left, and the permission mode (outside `rules`) and remaining context on the
|
|
261
|
-
right. A second row appears only while something runs in the background: shells,
|
|
262
|
-
a goal or scheduled tasks. `/statusline` chooses the items. See
|
|
263
|
-
[crates/tiechui-tui](crates/tiechui-tui/README.md).
|
|
264
|
-
|
|
265
|
-
### Slash commands
|
|
266
|
-
|
|
267
|
-
| Command | Purpose |
|
|
268
|
-
| --- | --- |
|
|
269
|
-
| `/model [provider/id]`, `/thinking [level]` | Switch model or thinking level |
|
|
270
|
-
| `/new`, `/resume`, `/retry` | New session, saved session, retry the failed request |
|
|
271
|
-
| `/reload` | Reload config, context files, skills, MCP, plugins and hooks |
|
|
272
|
-
| `/compact [instructions]` | Summarize older context now |
|
|
273
|
-
| `/context [system\|tools\|injections\|messages\|cache]` | Inspect what is sent to the model |
|
|
274
|
-
| `/rewind [detach]` | Restore code, conversation or both to an earlier turn |
|
|
275
|
-
| `/btw [question]`, `/btw model [provider/id]` | Side question on a snapshot of the main context |
|
|
276
|
-
| `/goal [objective]`, `/goal edit\|pause\|resume\|clear` | Persistent goal that continues while idle |
|
|
277
|
-
| `/loop [interval] <prompt>`, `/cron-list`, `/cron-delete <id>` | Run a prompt now and on an interval; list or cancel scheduled tasks |
|
|
278
|
-
| `/subagents` | Child tasks and their output |
|
|
279
|
-
| `/shells [output\|background\|stop <id>]` | Shell tasks: view output, move a running command to the background, stop it |
|
|
280
|
-
| `/permissions [rules\|auto\|yolo]` | Rules, grants and recent decisions; switch the mode for this session |
|
|
281
|
-
| `/status` | Module state, config paths, diagnostics |
|
|
282
|
-
| `/trust [allow\|deny]` | Project trust |
|
|
283
|
-
| `/skills` | Insert a skill into the draft; use `chui skills list` outside the TUI |
|
|
284
|
-
| `/mcp`, `/hooks` | Integration views |
|
|
285
|
-
| `/theme`, `/statusline` | Syntax theme picker, status line items |
|
|
286
|
-
| `/help`, `/quit` | Shortcuts, exit |
|
|
287
|
-
|
|
288
|
-
Disabling a module removes its commands. Plugins can add commands.
|
|
289
|
-
|
|
290
|
-
### Features
|
|
291
|
-
|
|
292
|
-
- **Background shells.**
|
|
293
|
-
- The model sets `background: true` on `bash` for servers and watchers. It gets a task ID at once and is told when the command finishes; `shell_output` reads its output and `shell_stop` stops it. The timeout still applies.
|
|
294
|
-
- `/shells` lists running and recent commands. In the panel, `b` moves a running command to the background, `x` stops it, Enter shows its output and Esc closes.
|
|
295
|
-
- Background tasks end with the session. Subagents run commands in the foreground only.
|
|
296
|
-
|
|
297
|
-
[modules/exec](modules/exec/src/lib.rs)
|
|
298
|
-
- **Rewind.** It previews the tracked edits before restoring them, and it keeps
|
|
299
|
-
the abandoned branch. It is not a filesystem snapshot: changes made by shell
|
|
300
|
-
commands or outside Tiechui are not restored.
|
|
301
|
-
[modules/rewind](modules/rewind/README.md)
|
|
302
|
-
- **Side chat.**
|
|
303
|
-
- `/btw` uses tools on a frozen reference copy of the main context. Reads and
|
|
304
|
-
searches are allowed; workspace changes require an explicit side-chat request
|
|
305
|
-
and still pass the normal permissions. The filesystem is shared.
|
|
306
|
-
- Ctrl+S shares the last answer with the main chat.
|
|
307
|
-
- Otherwise the side chat is discarded on reload or restart.
|
|
308
|
-
|
|
309
|
-
[modules/btw](modules/btw/README.md)
|
|
310
|
-
- **Goals.**
|
|
311
|
-
- A goal lives on the current branch and can keep the agent working while idle.
|
|
312
|
-
- Esc or Ctrl+C pauses it. After a restart it waits for input or `/goal resume`.
|
|
313
|
-
|
|
314
|
-
[modules/goal](modules/goal/README.md)
|
|
315
|
-
- **Scheduled prompts.**
|
|
316
|
-
- `/loop 5m <prompt>` runs the prompt now and then every 5 minutes while the session is idle.
|
|
317
|
-
- The model can schedule one-shot or recurring prompts with cron expressions in local time.
|
|
318
|
-
- Tasks are session-only unless saved to the trusted project's `.agents/scheduled_tasks.json`; recurring tasks expire after 7 days.
|
|
319
|
-
|
|
320
|
-
[modules/loop](modules/loop/README.md)
|
|
321
|
-
- **Compaction.**
|
|
322
|
-
- Native compaction runs near the context limit and on a recoverable overflow.
|
|
323
|
-
- Range compaction adds the tools `context_status`, `compact_history`, `search_history` and `read_history`.
|
|
324
|
-
- The session log is never rewritten.
|
|
325
|
-
|
|
326
|
-
[modules/compaction](modules/compaction/README.md)
|
|
327
|
-
- **Subagents.**
|
|
328
|
-
- The `subagent` tool runs built-in or user-defined agents: `scout`, `planner`, `reviewer`, `worker`, or `agents/*.md` from the profile or project.
|
|
329
|
-
- A dispatch is one task, a parallel batch, or a chain. A batch takes up to 8 tasks and runs 4 at once.
|
|
330
|
-
- Children have their own sessions and grants, within the parent's policy.
|
|
331
|
-
|
|
332
|
-
[modules/subagents](modules/subagents/README.md)
|
|
333
|
-
|
|
334
|
-
## UI gallery
|
|
335
|
-
|
|
336
|
-
The [UI gallery](https://b1ank1108.github.io/tiechui/) shows the terminal UI
|
|
337
|
-
screen by screen, in dark and light themes, at 80 and 40 columns and at three
|
|
338
|
-
color levels, rendered cell by cell from the TUI snapshot tests. Its source is
|
|
339
|
-
[`site/`](site/); `python3 scripts/ui_gallery.py` refreshes its data after
|
|
340
|
-
snapshot changes, and `.github/workflows/pages.yml` publishes it from `main`.
|
|
341
|
-
|
|
342
|
-
## Permissions and trust
|
|
343
|
-
|
|
344
|
-
Permissions are a **rule gate, not an OS sandbox**.
|
|
345
|
-
|
|
346
|
-
- **What is checked.** Every tool call, shell command (parsed with tree-sitter),
|
|
347
|
-
path and MCP call passes the interceptor. Once allowed, a program runs with
|
|
348
|
-
Tiechui's full user rights and inherits its environment, including exported
|
|
349
|
-
provider keys.
|
|
350
|
-
- **Rules.** Each rule has a `surface`, a `pattern`, an `action` (`allow`, `ask`
|
|
351
|
-
or `deny`) and an optional `reason` for denies. Within a surface, the last
|
|
352
|
-
matching rule wins, and an explicit deny always wins.
|
|
353
|
-
- **Defaults.** Reading and searching tools, session tools, MCP metadata and
|
|
354
|
-
read-only shell commands are allowed; everything else asks. Setting
|
|
355
|
-
`permissions.rules = []` drops the default tool allows.
|
|
356
|
-
- **Prompts.** You can allow once, allow the shown scope for the session, or
|
|
357
|
-
deny. Session grants are not restored on resume.
|
|
358
|
-
|
|
359
|
-
The **mode** decides what happens to a call the rules would ask about:
|
|
360
|
-
|
|
361
|
-
| Mode | Behavior |
|
|
362
|
-
| --- | --- |
|
|
363
|
-
| `rules` (default) | You are asked |
|
|
364
|
-
| `auto` | Edits inside the workspace pass. Anything else is reviewed by a one-off request to the session's model: allowed calls run, blocked calls return the reason to the model. After 3 blocks in a row or 20 in a session, or without model access, you are asked. Broad `bash` allows (`*`, interpreters, `npm run`, …) are ignored, so those commands are reviewed too |
|
|
365
|
-
| `yolo` | Approved |
|
|
366
|
-
|
|
367
|
-
Set the mode with `permissions.mode` in the user config (project config cannot
|
|
368
|
-
set it), `--mode` for one run, or `/permissions <mode>` for the current session.
|
|
369
|
-
In every mode, explicit denies apply, and writes to **protected paths** ask unless
|
|
370
|
-
a user rule allows them: `.git`, `.agents`, `.claude`, `.tiechui`, `.vscode`,
|
|
371
|
-
`.idea`, shell profiles, `.gitconfig`, `.mcp.json` and `.env` files. Invalid
|
|
372
|
-
project rules never pass without you.
|
|
373
|
-
|
|
374
|
-
Headless runs choose `--approval`:
|
|
375
|
-
|
|
376
|
-
| Value | Behavior |
|
|
377
|
-
| --- | --- |
|
|
378
|
-
| `allow-listed` (default) | Calls that still need you fail as tool errors |
|
|
379
|
-
| `deny` | Every intercepted call is denied |
|
|
380
|
-
| `yolo` | Same as `--mode yolo` when `--mode` is absent |
|
|
381
|
-
|
|
382
|
-
`chui trust allow|deny|status --cwd DIR` (or `/trust`) decides whether a project's
|
|
383
|
-
`.agents/` configuration, rules, skills and hooks load, with `.claude/`
|
|
384
|
-
compatibility. Command hooks and T2 plugin capabilities have their own approvals. See
|
|
385
|
-
[modules/permissions](modules/permissions/README.md).
|
|
386
|
-
|
|
387
|
-
The first time `chui` opens a project with such files, it asks and saves the answer
|
|
388
|
-
for the Git root. It then asks about any new or changed command hooks. Your home
|
|
389
|
-
directory and its parents are never saved this way, because every project below
|
|
390
|
-
would inherit them; use `chui trust allow` there. `chui exec` never asks: it skips
|
|
391
|
-
undecided project content and warns.
|
|
392
|
-
|
|
393
|
-
## Extend
|
|
394
|
-
|
|
395
|
-
### Plugins
|
|
396
|
-
|
|
397
|
-
- **T1 plugins** are declarative packages of skills, MCP servers and hooks.
|
|
398
|
-
- **T2 plugins** are separate processes speaking newline-delimited JSON-RPC 2.0.
|
|
399
|
-
- They can add tools, commands, interceptors and panels.
|
|
400
|
-
- Their capabilities need an interactive grant tied to the package's content hash. A changed package asks again.
|
|
401
|
-
- Headless runs need the grant to already exist.
|
|
402
|
-
|
|
403
|
-
```sh
|
|
404
|
-
chui plugin marketplace add ~/src/tiechui-plugins --ref main # a local clone or a public Git URL
|
|
405
|
-
chui plugin add sdk-typescript@tiechui-plugins
|
|
406
|
-
chui plugin list --json
|
|
407
|
-
chui plugin upgrade [NAME] # explicit only; shows what changed
|
|
408
|
-
chui plugin remove NAME
|
|
409
|
-
chui plugin add ./path/to/package # local package
|
|
410
|
-
```
|
|
411
|
-
|
|
412
|
-
Marketplaces use Codex's `marketplace.json` layout. Installs are pinned to the
|
|
413
|
-
resolved commit and content hash. Git runs with your config isolated and no
|
|
414
|
-
credentials of its own, so a private marketplace is added from a local clone.
|
|
415
|
-
The official example marketplace, `tiechui-plugins`, is not public yet.
|
|
416
|
-
|
|
417
|
-
Further reading:
|
|
418
|
-
|
|
419
|
-
- the [Rust SDK](crates/tiechui-plugin-sdk/README.md)
|
|
420
|
-
- the [TypeScript SDK](sdk/typescript/README.md): dependency-free, Node 25, no npm step
|
|
421
|
-
|
|
422
|
-
### Skills, context files and hooks
|
|
423
|
-
|
|
424
|
-
**Skills** are loaded from:
|
|
425
|
-
|
|
426
|
-
- `.agents/skills` and `.claude/skills` in your home directory
|
|
427
|
-
and in trusted projects;
|
|
428
|
-
- the profile's `skills/`.
|
|
429
|
-
|
|
430
|
-
These roots are discovered by default, without a skills configuration section.
|
|
431
|
-
List skills with `chui skills list`, or select one with `/skills` in the TUI. `AGENTS.md` and the other context files are
|
|
432
|
-
described in [modules/context-files](modules/context-files/README.md).
|
|
433
|
-
|
|
434
|
-
**Hooks:** `chui hooks list` lists them and `chui hooks trust` approves command
|
|
435
|
-
hooks.
|
|
436
|
-
|
|
437
|
-
### MCP
|
|
438
|
-
|
|
439
|
-
MCP supports stdio and Streamable HTTP servers: tools, resources and
|
|
440
|
-
elicitation. All of it goes through the permission gate.
|
|
441
|
-
|
|
442
|
-
```toml
|
|
443
|
-
[mcp_servers.local]
|
|
444
|
-
command = "/path/to/server"
|
|
445
|
-
args = []
|
|
446
|
-
env_vars = ["SERVICE_TOKEN"] # passed through; beyond HOME, PATH and a few basics, nothing else is
|
|
447
|
-
|
|
448
|
-
[mcp_servers.remote]
|
|
449
|
-
url = "https://mcp.example/mcp"
|
|
450
|
-
tool_timeout_sec = 60
|
|
451
|
-
```
|
|
452
|
-
|
|
453
|
-
```sh
|
|
454
|
-
chui mcp list
|
|
455
|
-
chui mcp login remote [--scopes a,b] # browser OAuth with PKCE and a loopback callback
|
|
456
|
-
chui mcp logout remote
|
|
457
|
-
```
|
|
458
|
-
|
|
459
|
-
OAuth tokens are refreshed automatically and stored with mode 0600. Logout
|
|
460
|
-
deletes the local token but does not revoke it on the server. A static header
|
|
461
|
-
or `bearer_token_env_var` takes precedence over OAuth. See
|
|
462
|
-
[modules/mcp](modules/mcp/README.md).
|
|
463
|
-
|
|
464
|
-
## Sessions and diagnostics
|
|
465
|
-
|
|
466
|
-
- **Sessions.** They are append-only JSONL trees with branches.
|
|
467
|
-
- Resuming restores messages and module state.
|
|
468
|
-
- It does not restore session grants or the side chat.
|
|
469
|
-
- The resume picker searches and previews. See [crates/tiechui-session](crates/tiechui-session/README.md).
|
|
470
|
-
- **`chui doctor`.** It is read-only and exits nonzero when it finds a problem. It checks:
|
|
471
|
-
- installed binaries against the ownership record;
|
|
472
|
-
- interrupted installs;
|
|
473
|
-
- 0700 profile directories, and 0600 secret and token files and a
|
|
474
|
-
`providers.toml` that holds an inline key;
|
|
475
|
-
- config and grant shapes, and session versions.
|
|
476
|
-
|
|
477
|
-
It never opens secret or token files and never prints credentials. Use `--prefix` and `--profile` to point it
|
|
478
|
-
elsewhere. A binary built from source skips the install checks.
|
|
479
|
-
|
|
480
|
-
## Develop
|
|
481
|
-
|
|
482
|
-
You need:
|
|
483
|
-
|
|
484
|
-
- Rust 1.95.0, Git, Python 3.10+ (standard library only), Node 25 (optional);
|
|
485
|
-
- `just`, `cargo-nextest`, `cargo-deny`;
|
|
486
|
-
- `rg` for content-search tests.
|
|
487
|
-
|
|
488
|
-
Tests use no network and no real credentials.
|
|
489
|
-
|
|
490
|
-
```sh
|
|
491
|
-
cargo fetch --locked && cargo deny fetch # once, before offline checks
|
|
492
|
-
just check # fmt, clippy, nextest, deny, schema and SDK drift, packaging tests
|
|
493
|
-
just pty # terminal emulator suite against a local mock provider
|
|
494
|
-
just pty resume approval # selected PTY cases
|
|
495
|
-
just plugins-check # validates ../tiechui-plugins when present
|
|
496
|
-
```
|
|
497
|
-
|
|
498
|
-
- Each part of `check` is its own recipe: `fmt`, `lint`, `test`, `deny`,
|
|
499
|
-
`schema-check`, `sdk-check` and `packaging-check`.
|
|
500
|
-
- `just fmt` only checks; `cargo fmt --all` rewrites.
|
|
501
|
-
- On a small disk, set `CARGO_INCREMENTAL=0`.
|
|
502
|
-
- The PTY suite is described in [tests/pty](tests/pty/README.md).
|
|
503
|
-
|
|
504
|
-
**CI** (`.github/workflows/ci.yml`) runs `just check` and `just pty` on Linux
|
|
505
|
-
and macOS. A Windows build and test runs as a non-blocking attempt.
|
|
506
|
-
|
|
507
|
-
**Release** (`.github/workflows/release.yml`) runs on a `v*` tag that must match
|
|
508
|
-
the workspace version:
|
|
509
|
-
|
|
510
|
-
- it builds tarballs on native Linux x86_64 and aarch64 and macOS arm64 and x86_64 runners, and a zip for Windows x86_64;
|
|
511
|
-
- it attaches them and a combined `SHA256SUMS` to a **draft** release, which you publish by hand.
|
|
512
|
-
|
|
513
|
-
### Layout
|
|
514
|
-
|
|
515
|
-
| Path | Role |
|
|
516
|
-
| --- | --- |
|
|
517
|
-
| `crates/tiechui-protocol`, `tiechui-model` | Protocol events and model types |
|
|
518
|
-
| `crates/tiechui-core` | Session actor: turns, tool scheduling, retry, replay, module lifecycle |
|
|
519
|
-
| `crates/tiechui-providers` | Anthropic and OpenAI-compatible wires |
|
|
520
|
-
| `crates/tiechui-config`, `tiechui-session` | Typed config, JSONL session store |
|
|
521
|
-
| `crates/tiechui-exec`, `tiechui-tools` | Process execution, built-in tools |
|
|
522
|
-
| `crates/tiechui-tui`, `tiechui-cli` | Terminal UI (protocol only), CLI |
|
|
523
|
-
| `crates/tiechui-plugin-api`, `tiechui-plugin-sdk`, `sdk/typescript` | Module API, plugin SDKs |
|
|
524
|
-
| `modules/` | editing, exec, permissions, ask, hooks, context-files, skills, mcp, plugins, context, rewind, btw, goal, loop, compaction, subagents, tool-search, ptc |
|
|
525
|
-
| `xtask/`, `scripts/`, `tests/` | Maintenance tasks, packaging, PTY tests |
|
|
526
|
-
| `site/` | UI gallery rendered from the TUI snapshots |
|
|
527
|
-
|
|
528
|
-
Features live in modules behind `tiechui-plugin-api`. The kernel carries no
|
|
529
|
-
feature policy and the TUI depends only on the protocol. The session actor is
|
|
530
|
-
described in [crates/tiechui-core](crates/tiechui-core/README.md).
|
|
531
|
-
|
|
532
|
-
## Status
|
|
533
|
-
|
|
534
|
-
Tiechui is young and changes quickly; config and session formats may still
|
|
535
|
-
change before 1.0. Not yet supported:
|
|
536
|
-
|
|
537
|
-
- an OS sandbox;
|
|
538
|
-
- the OpenAI Responses wire;
|
|
539
|
-
- subscription logins;
|
|
540
|
-
- `chui mcp serve`;
|
|
541
|
-
- Homebrew.
|
|
542
|
-
|
|
543
|
-
Windows builds ship with each release, but the Windows CI job is not yet
|
|
544
|
-
blocking.
|
|
545
|
-
|
|
546
|
-
## License
|
|
547
|
-
|
|
548
|
-
Tiechui is licensed under the [GNU Affero General Public License v3.0](LICENSE).
|
|
549
|
-
Contributions are welcome; see [CONTRIBUTING.md](CONTRIBUTING.md).
|
package/bin/chui.js
DELETED
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
"use strict";
|
|
3
|
-
// Runs the native build that the matching optional dependency installed.
|
|
4
|
-
const { spawn } = require("child_process");
|
|
5
|
-
const path = require("path");
|
|
6
|
-
|
|
7
|
-
const PLATFORMS = ["darwin-arm64", "darwin-x64", "linux-arm64", "linux-x64", "win32-x64"];
|
|
8
|
-
const platform = `${process.platform}-${process.arch}`;
|
|
9
|
-
|
|
10
|
-
let binary;
|
|
11
|
-
try {
|
|
12
|
-
const root = path.dirname(require.resolve(`@tiechui/cli-${platform}/package.json`));
|
|
13
|
-
binary = path.join(root, process.platform === "win32" ? "chui.exe" : "chui");
|
|
14
|
-
} catch {
|
|
15
|
-
console.error(
|
|
16
|
-
PLATFORMS.includes(platform)
|
|
17
|
-
? `chui: the ${platform} build is missing; optional dependencies were probably skipped. Reinstall with one of:\n` +
|
|
18
|
-
" npm i -g @tiechui/cli\n pnpm add -g @tiechui/cli\n yarn global add @tiechui/cli\n bun add -g @tiechui/cli"
|
|
19
|
-
: `chui: no build for ${platform}; supported: ${PLATFORMS.join(", ")}`,
|
|
20
|
-
);
|
|
21
|
-
process.exit(1);
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
const child = spawn(binary, process.argv.slice(2), {
|
|
25
|
-
stdio: "inherit",
|
|
26
|
-
env: { ...process.env, TIECHUI_INSTALL: "npm" },
|
|
27
|
-
});
|
|
28
|
-
child.on("error", (error) => {
|
|
29
|
-
console.error(`chui: ${binary}: ${error.message}`);
|
|
30
|
-
process.exit(1);
|
|
31
|
-
});
|
|
32
|
-
// The terminal already sends Ctrl+C to chui, which reads a second one as "exit now".
|
|
33
|
-
process.on("SIGINT", () => {});
|
|
34
|
-
for (const signal of ["SIGTERM", "SIGHUP"]) {
|
|
35
|
-
process.on(signal, () => child.kill(signal));
|
|
36
|
-
}
|
|
37
|
-
child.on("exit", (code, signal) => {
|
|
38
|
-
if (signal) {
|
|
39
|
-
process.removeAllListeners(signal);
|
|
40
|
-
process.kill(process.pid, signal);
|
|
41
|
-
} else {
|
|
42
|
-
process.exit(code ?? 1);
|
|
43
|
-
}
|
|
44
|
-
});
|