@imagile-dev/toil 0.0.0-stage → 0.1.0-alpha.2
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 +202 -0
- package/NOTICE +70 -0
- package/README.md +157 -2
- package/dist/api.d.ts +460 -0
- package/dist/api.js +2 -0
- package/dist/toil-lib.js +174980 -0
- package/dist/toil.js +5 -0
- package/package.json +77 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
Copyright 2026 Imagile
|
|
2
|
+
|
|
3
|
+
This product is licensed under the Apache License, Version 2.0 (see LICENSE).
|
|
4
|
+
|
|
5
|
+
This product includes software adapted from jmespath.js
|
|
6
|
+
(https://github.com/jmespath/jmespath.js), the JMESPath reference
|
|
7
|
+
implementation in JavaScript, Copyright 2014 James Saryerwinnie, licensed under
|
|
8
|
+
the Apache License, Version 2.0. The lexer, parser and interpreter in
|
|
9
|
+
src/core/query/ are a strict TypeScript adaptation of it, changed to pass the
|
|
10
|
+
JMESPath compliance suite and to read only data's own keys.
|
|
11
|
+
|
|
12
|
+
The repository's tests include the JMESPath compliance suite, in
|
|
13
|
+
test/fixtures/jmespath/, as distributed with jmespath.py
|
|
14
|
+
(https://github.com/jmespath/jmespath.py), Copyright (c) 2013 Amazon.com, Inc.
|
|
15
|
+
or its affiliates, licensed under the MIT License (see
|
|
16
|
+
test/fixtures/jmespath/LICENSE). It is not part of the published package.
|
|
17
|
+
|
|
18
|
+
The util commands that read YAML or validate JSON Schema bundle, loaded only
|
|
19
|
+
when such a command runs:
|
|
20
|
+
|
|
21
|
+
- js-yaml (https://github.com/nodeca/js-yaml), Copyright (C) 2011-2015 by
|
|
22
|
+
Vitaly Puzrin, licensed under the MIT License.
|
|
23
|
+
- @cfworker/json-schema (https://github.com/cfworker/cfworker), by Jeremy
|
|
24
|
+
Danyow, licensed under the MIT License.
|
|
25
|
+
|
|
26
|
+
util md bundles, loaded only when it runs, the ADF JSON schema
|
|
27
|
+
(src/areas/util/md/adf-schema.json), dist/json-schema/v1/full.json from
|
|
28
|
+
@atlaskit/adf-schema 57.6.21 (https://www.npmjs.com/package/@atlaskit/adf-schema),
|
|
29
|
+
Copyright Atlassian Pty Ltd, licensed under the Apache License, Version 2.0,
|
|
30
|
+
unchanged.
|
|
31
|
+
|
|
32
|
+
`util openapi` bundles, as published and loaded only when it runs, the schemas it
|
|
33
|
+
validates documents against (src/areas/util/openapi/schemas/):
|
|
34
|
+
|
|
35
|
+
- The OpenAPI 3.0 (2024-10-18), 3.1 (2025-11-23) and 3.2 (2025-11-23) schemas and
|
|
36
|
+
the Swagger 2.0 schema (2017-08-27), from https://spec.openapis.org/oas/,
|
|
37
|
+
published by the OpenAPI Initiative (https://github.com/OAI/OpenAPI-Specification),
|
|
38
|
+
a Linux Foundation project, licensed under the Apache License, Version 2.0.
|
|
39
|
+
- The JSON Schema draft-04 meta-schema (http://json-schema.org/draft-04/schema),
|
|
40
|
+
which the Swagger 2.0 schema refers to, offered under the Academic Free License
|
|
41
|
+
3.0 or the BSD 3-Clause License, used here under the BSD 3-Clause License:
|
|
42
|
+
|
|
43
|
+
Copyright (c) 2022 JSON Schema Specification Authors
|
|
44
|
+
|
|
45
|
+
Redistribution and use in source and binary forms, with or without
|
|
46
|
+
modification, are permitted provided that the following conditions are
|
|
47
|
+
met:
|
|
48
|
+
|
|
49
|
+
1. Redistributions of source code must retain the above copyright
|
|
50
|
+
notice, this list of conditions and the following disclaimer.
|
|
51
|
+
|
|
52
|
+
2. Redistributions in binary form must reproduce the above copyright
|
|
53
|
+
notice, this list of conditions and the following disclaimer in the
|
|
54
|
+
documentation and/or other materials provided with the distribution.
|
|
55
|
+
|
|
56
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
57
|
+
contributors may be used to endorse or promote products derived from
|
|
58
|
+
this software without specific prior written permission.
|
|
59
|
+
|
|
60
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
61
|
+
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
62
|
+
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
63
|
+
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
64
|
+
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
65
|
+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
|
|
66
|
+
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
67
|
+
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
68
|
+
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
69
|
+
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
70
|
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,158 @@
|
|
|
1
|
-
#
|
|
1
|
+
# toil
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The token-efficient alternative to MCP: one CLI that gives agents your enterprise
|
|
4
|
+
tools and your databases while spending as little of their context as it can.
|
|
5
|
+
|
|
6
|
+
- **Compact JSON envelopes.** Every command returns one `{ ok, data, error, meta }`
|
|
7
|
+
envelope, so agents and scripts can use it as easily as people.
|
|
8
|
+
- **Only the fields you need.** `--select` trims a result to the fields a task
|
|
9
|
+
names before it reaches the agent.
|
|
10
|
+
- **No polling loops.** `toil wait --until <expression> -- <read>` repeats a read
|
|
11
|
+
until it's true and returns once.
|
|
12
|
+
- **A skill, not a tool list.** The `toil` skill is an index the agent reads a page
|
|
13
|
+
at a time, as a task needs it, instead of every tool schema loaded up front.
|
|
14
|
+
|
|
15
|
+
`toil mcp` serves the same commands as MCP tools for clients that want them. toil is
|
|
16
|
+
plain JavaScript on Node, so it also runs where executables are blocked.
|
|
17
|
+
|
|
18
|
+
> **Status:** Alpha: APIs and flags may change before 1.0
|
|
19
|
+
|
|
20
|
+
toil is published to npm as [`@imagile-dev/toil`](https://www.npmjs.com/package/@imagile-dev/toil),
|
|
21
|
+
and documented at [imagile-dev.github.io/toil](https://imagile-dev.github.io/toil/). This
|
|
22
|
+
README is for working from a clone of this repository; the site covers everything else
|
|
23
|
+
in more depth.
|
|
24
|
+
|
|
25
|
+
## Quick start
|
|
26
|
+
|
|
27
|
+
There are two ways to run toil: install it from npm, or run it from a clone. Both
|
|
28
|
+
need Node.js 24.14 or later, on Windows, macOS or Linux. There is no executable, no
|
|
29
|
+
native module and no install script.
|
|
30
|
+
|
|
31
|
+
### From npm
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npm install -g @imagile-dev/toil
|
|
35
|
+
toil version
|
|
36
|
+
toil deps scan # inventory the npm, Maven and NuGet packages in this folder
|
|
37
|
+
toil mcp # serve toil to an agent over stdio
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Releases are alpha and published under npm's `alpha` tag, which `latest` follows
|
|
41
|
+
until 1.0. The first alpha is being published; until it is, `npm install` returns
|
|
42
|
+
404, so use the clone path below meanwhile. Setup, connections and every command are on the
|
|
43
|
+
[site](https://imagile-dev.github.io/toil/docs/).
|
|
44
|
+
|
|
45
|
+
## Running from a clone
|
|
46
|
+
|
|
47
|
+
One command clones toil, builds it, adds a `toil` alias to your shell profile and
|
|
48
|
+
prints `toil version`:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
git clone https://github.com/imagile-dev/toil.git && cd toil && node scripts/setup.mjs
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
`node scripts/setup.mjs --skip-build` uses the committed bundle with no
|
|
55
|
+
`npm install`, and `--no-alias` leaves your shell profile alone. Running it again is
|
|
56
|
+
safe. The long form follows.
|
|
57
|
+
|
|
58
|
+
`dist/toil.js` and the bundle it runs, `dist/toil-lib.js`, are committed, and they
|
|
59
|
+
are the last released toil, so a clone runs as it is, with no `npm install`. They
|
|
60
|
+
import only Node's built-ins. Until the first release, the committed dist/toil.js is
|
|
61
|
+
the earlier single-file bundle; the release PR is the first to commit
|
|
62
|
+
dist/toil-lib.js.
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
git clone https://github.com/imagile-dev/toil.git
|
|
66
|
+
node toil/dist/toil.js version
|
|
67
|
+
node toil/dist/toil.js setup alias # bash or zsh
|
|
68
|
+
node toil/dist/toil.js setup alias --profile $PROFILE # PowerShell
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
`setup alias` adds a `toil` function to your shell profile, between two marker lines;
|
|
72
|
+
`setup remove-alias` takes it out. Open a new terminal and `toil version` works.
|
|
73
|
+
`git -C toil pull` brings the newest release, with nothing to rebuild.
|
|
74
|
+
|
|
75
|
+
### Building it yourself
|
|
76
|
+
|
|
77
|
+
The committed bundle changes only with a release. To run what's on `main` now, build
|
|
78
|
+
it:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
cd toil
|
|
82
|
+
npm ci
|
|
83
|
+
npm run build # writes dist/toil-lib.js, dist/toil.js, dist/api.js, dist/api.d.ts and the metafiles
|
|
84
|
+
node dist/toil.js version
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
A build rewrites the committed `dist/toil.js`, so run `git checkout -- dist/` before
|
|
88
|
+
`git pull`, then build again (or run `node scripts/setup.mjs`).
|
|
89
|
+
|
|
90
|
+
Don't commit the rebuilt `dist/`; `git checkout -- dist/` puts the released bundle
|
|
91
|
+
back. Until the first release, `dist/toil-lib.js` isn't committed yet, so after a
|
|
92
|
+
build it shows as untracked and `git checkout` leaves it: delete it
|
|
93
|
+
(`rm dist/toil-lib.js`, or `git clean -f dist/`). [CLAUDE.md](CLAUDE.md) has the rest of the gate (typecheck, lint, tests).
|
|
94
|
+
|
|
95
|
+
### Pointing an agent at the clone
|
|
96
|
+
|
|
97
|
+
**MCP.** Clients start servers without a shell, so they don't see a `toil` alias.
|
|
98
|
+
Register `node` with the clone's absolute path:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
claude mcp add toil -- node /path/to/toil/dist/toil.js mcp --areas jira
|
|
102
|
+
codex mcp add toil -- node /path/to/toil/dist/toil.js mcp --areas jira
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
or, for clients with an `mcpServers` file:
|
|
106
|
+
|
|
107
|
+
```json
|
|
108
|
+
{ "mcpServers": { "toil": { "command": "node", "args": ["/path/to/toil/dist/toil.js", "mcp", "--areas", "jira"] } } }
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
`--areas` limits the tools to what the task needs; without it toil serves every area
|
|
112
|
+
with a connection set up. [`skills/toil/mcp.md`](skills/toil/mcp.md) covers VS Code and
|
|
113
|
+
the rest.
|
|
114
|
+
|
|
115
|
+
**The toil skill.** [`skills/toil/`](skills/toil/SKILL.md) is toil's command
|
|
116
|
+
reference for agents, in the Agent Skills format, and the site's docs are the same
|
|
117
|
+
files rendered. toil carries it inside itself and installs it for your agent:
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
toil skill install --allow-write # ~/.agents/skills/toil: Codex, GitHub Copilot
|
|
121
|
+
toil skill install --claude --allow-write # ~/.claude/skills/toil: Claude Code
|
|
122
|
+
toil skill install --agent github-copilot --scope project --allow-write
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
The installed copy names the areas you have connections for and keeps itself
|
|
126
|
+
current, so there is nothing to update by hand. `skill` is newer than the committed
|
|
127
|
+
bundle, so until the next release run it from a bundle you built (above). In Claude
|
|
128
|
+
Code the clone is also a plugin marketplace: `claude plugin marketplace add
|
|
129
|
+
/path/to/toil`, then `claude plugin install toil@toil`.
|
|
130
|
+
[`skills/toil/install.md`](skills/toil/install.md) has the rest.
|
|
131
|
+
|
|
132
|
+
## What it does
|
|
133
|
+
|
|
134
|
+
| Area | What it covers |
|
|
135
|
+
|------|----------------|
|
|
136
|
+
| [`db`](https://imagile-dev.github.io/toil/docs/databases/) | SQLite, PostgreSQL, MySQL / MariaDB, SQL Server and Oracle: list schemas and tables, describe a table, preview rows, read-only queries with paging |
|
|
137
|
+
| [`util`](https://imagile-dev.github.io/toil/docs/utilities/) | Local commands with no connection or network: JWTs, dependency inventories, encodings and hashes, certificates, test and coverage reports, logs, secret scans, time and versions, Jira and Confluence markup, OpenAPI |
|
|
138
|
+
| [`skills`](https://imagile-dev.github.io/toil/docs/skills/) | Add a git-hosted skills marketplace, install its plugins for Codex, GitHub Copilot or Claude Code, switch them on and off |
|
|
139
|
+
| [The toil skill](https://imagile-dev.github.io/toil/docs/) | toil's own command reference for agents, one file per area |
|
|
140
|
+
| [Work tracking and source](https://imagile-dev.github.io/toil/integrations/) (9) | Jira, Confluence and Bitbucket (Data Center and Cloud), GitHub & GitHub Enterprise, Azure DevOps Server, local git |
|
|
141
|
+
| [Build, release and runtime](https://imagile-dev.github.io/toil/integrations/) (5) | JFrog Artifactory, Jenkins, OpenShift / Kubernetes, Sauce Labs, Split.IO |
|
|
142
|
+
| [Security and quality](https://imagile-dev.github.io/toil/integrations/) (7) | Checkmarx One, Contrast Security, SD Elements, SonarQube, Sonatype IQ Server, Sonatype OSS Index, OSV.dev |
|
|
143
|
+
| [Observability](https://imagile-dev.github.io/toil/integrations/) (4) | Dynatrace, Elasticsearch, Kibana, Falcon LogScale |
|
|
144
|
+
| [Design and data](https://imagile-dev.github.io/toil/integrations/) (2) | Figma, Alation |
|
|
145
|
+
|
|
146
|
+
Every integration that needs a credential signs in with a long-lived token you
|
|
147
|
+
generate once in the vendor's UI. Every integration records how far it has been
|
|
148
|
+
verified: `unit`, `live` or `stable`. Each one's
|
|
149
|
+
page on the [integrations board](https://imagile-dev.github.io/toil/integrations/)
|
|
150
|
+
says what its level means.
|
|
151
|
+
|
|
152
|
+
## Contributing
|
|
153
|
+
|
|
154
|
+
Read [CLAUDE.md](CLAUDE.md). It holds the rules for people and agents alike.
|
|
155
|
+
|
|
156
|
+
## License
|
|
157
|
+
|
|
158
|
+
Apache License 2.0 © Imagile. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
|