@imagile-dev/toil-ui 0.0.0-stage → 0.1.0-alpha.1
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 +232 -0
- package/README.md +238 -2
- package/dist/app/assets/Graph-CeJeskZg.css +1 -0
- package/dist/app/assets/Graph-IKubvexT.js +7 -0
- package/dist/app/assets/cinzel-decorative-latin-700-normal-CnX1aK6s.woff2 +0 -0
- package/dist/app/assets/cinzel-decorative-latin-700-normal-ov6XPGpn.woff +0 -0
- package/dist/app/assets/cinzel-decorative-latin-ext-700-normal-BaOC-94C.woff +0 -0
- package/dist/app/assets/cinzel-decorative-latin-ext-700-normal-Dul5pKgq.woff2 +0 -0
- package/dist/app/assets/cinzel-latin-600-normal-CH_LB4su.woff +0 -0
- package/dist/app/assets/cinzel-latin-600-normal-Dd5YO2UX.woff2 +0 -0
- package/dist/app/assets/cinzel-latin-ext-600-normal-BEFdM_VE.woff2 +0 -0
- package/dist/app/assets/cinzel-latin-ext-600-normal-BY9Mq9iK.woff +0 -0
- package/dist/app/assets/crate-loading-Dw5rbPVs.webp +0 -0
- package/dist/app/assets/crate-lost-CaqeM6QF.webp +0 -0
- package/dist/app/assets/crop-grown-HG5zb5pJ.svg +74 -0
- package/dist/app/assets/crop-harvested-Q-ua5_kg.svg +79 -0
- package/dist/app/assets/eb-garamond-cyrillic-400-normal-C0kVTdou.woff +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-400-normal-DDLP67lu.woff2 +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-600-normal-CHfC3jm-.woff2 +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-600-normal-koFutDBv.woff +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-ext-400-normal-DG8lny6_.woff +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-ext-400-normal-o8fRvAFQ.woff2 +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-ext-600-normal-b6vuEf1e.woff +0 -0
- package/dist/app/assets/eb-garamond-cyrillic-ext-600-normal-cjIjEMm6.woff2 +0 -0
- package/dist/app/assets/eb-garamond-greek-400-normal-CVAbzS9p.woff2 +0 -0
- package/dist/app/assets/eb-garamond-greek-400-normal-d4JlP2QH.woff +0 -0
- package/dist/app/assets/eb-garamond-greek-600-normal--vWuDlyL.woff2 +0 -0
- package/dist/app/assets/eb-garamond-greek-600-normal-JScKXZBq.woff +0 -0
- package/dist/app/assets/eb-garamond-greek-ext-400-normal-BaZl8BIK.woff +0 -0
- package/dist/app/assets/eb-garamond-greek-ext-400-normal-K8pwR3tn.woff2 +0 -0
- package/dist/app/assets/eb-garamond-greek-ext-600-normal-B6KG6Acg.woff2 +0 -0
- package/dist/app/assets/eb-garamond-greek-ext-600-normal-DzPSPp8W.woff +0 -0
- package/dist/app/assets/eb-garamond-latin-400-normal-BCNrxLz_.woff2 +0 -0
- package/dist/app/assets/eb-garamond-latin-400-normal-maQnHeKB.woff +0 -0
- package/dist/app/assets/eb-garamond-latin-600-normal-DHwxsLHv.woff2 +0 -0
- package/dist/app/assets/eb-garamond-latin-600-normal-xCe6GkOx.woff +0 -0
- package/dist/app/assets/eb-garamond-latin-ext-400-normal-B4EmgUmt.woff +0 -0
- package/dist/app/assets/eb-garamond-latin-ext-400-normal-o4A__6QZ.woff2 +0 -0
- package/dist/app/assets/eb-garamond-latin-ext-600-normal-CoWPx8v4.woff +0 -0
- package/dist/app/assets/eb-garamond-latin-ext-600-normal-CrweTMKz.woff2 +0 -0
- package/dist/app/assets/eb-garamond-vietnamese-400-normal-CLvJdMEL.woff2 +0 -0
- package/dist/app/assets/eb-garamond-vietnamese-400-normal-ifvNSiWx.woff +0 -0
- package/dist/app/assets/eb-garamond-vietnamese-600-normal-DgZMCD0h.woff +0 -0
- package/dist/app/assets/eb-garamond-vietnamese-600-normal-Dmi8L14S.woff2 +0 -0
- package/dist/app/assets/empty-field-BN05R29i.svg +151 -0
- package/dist/app/assets/empty-sector-amtiZ3_V.webp +0 -0
- package/dist/app/assets/exo-2-cyrillic-400-normal-DkhFZ3TL.woff2 +0 -0
- package/dist/app/assets/exo-2-cyrillic-400-normal-h9Yg8YHF.woff +0 -0
- package/dist/app/assets/exo-2-cyrillic-600-normal-CENMUrsM.woff2 +0 -0
- package/dist/app/assets/exo-2-cyrillic-600-normal-DUkGHFVI.woff +0 -0
- package/dist/app/assets/exo-2-cyrillic-ext-400-normal-CkIweJqd.woff2 +0 -0
- package/dist/app/assets/exo-2-cyrillic-ext-400-normal-iCCHmvbS.woff +0 -0
- package/dist/app/assets/exo-2-cyrillic-ext-600-normal-Bva7FavC.woff +0 -0
- package/dist/app/assets/exo-2-cyrillic-ext-600-normal-c2lTakb1.woff2 +0 -0
- package/dist/app/assets/exo-2-latin-400-normal-D8MC3_dU.woff2 +0 -0
- package/dist/app/assets/exo-2-latin-400-normal-_vYD6UCb.woff +0 -0
- package/dist/app/assets/exo-2-latin-600-normal-DOMk466V.woff2 +0 -0
- package/dist/app/assets/exo-2-latin-600-normal-DZPWd1Z-.woff +0 -0
- package/dist/app/assets/exo-2-latin-ext-400-normal-BiLgrt0k.woff2 +0 -0
- package/dist/app/assets/exo-2-latin-ext-400-normal-eOOluZza.woff +0 -0
- package/dist/app/assets/exo-2-latin-ext-600-normal-70qtqWxx.woff2 +0 -0
- package/dist/app/assets/exo-2-latin-ext-600-normal-DMfc7h1y.woff +0 -0
- package/dist/app/assets/exo-2-vietnamese-400-normal-BgZK7AGH.woff2 +0 -0
- package/dist/app/assets/exo-2-vietnamese-400-normal-C-HDQfeq.woff +0 -0
- package/dist/app/assets/exo-2-vietnamese-600-normal-D_uNeL95.woff2 +0 -0
- package/dist/app/assets/exo-2-vietnamese-600-normal-H3VyuMj8.woff +0 -0
- package/dist/app/assets/favicon-Btr9J4ll.svg +18 -0
- package/dist/app/assets/fields-BxauQmw0.webp +0 -0
- package/dist/app/assets/fira-code-cyrillic-400-normal-UC0NFL4U.woff2 +0 -0
- package/dist/app/assets/fira-code-cyrillic-400-normal-dc1q3VD7.woff +0 -0
- package/dist/app/assets/fira-code-cyrillic-ext-400-normal-Buh61xzB.woff +0 -0
- package/dist/app/assets/fira-code-cyrillic-ext-400-normal-txZ9Fk_1.woff2 +0 -0
- package/dist/app/assets/fira-code-greek-400-normal-B2Gh_Y8s.woff2 +0 -0
- package/dist/app/assets/fira-code-greek-400-normal-DobhaxvF.woff +0 -0
- package/dist/app/assets/fira-code-greek-ext-400-normal-DR7mBgIM.woff2 +0 -0
- package/dist/app/assets/fira-code-greek-ext-400-normal-DSPUheWg.woff +0 -0
- package/dist/app/assets/fira-code-latin-400-normal-C-QZfXAs.woff +0 -0
- package/dist/app/assets/fira-code-latin-400-normal-DGosTW8U.woff2 +0 -0
- package/dist/app/assets/fira-code-latin-ext-400-normal-DG73JjOf.woff +0 -0
- package/dist/app/assets/fira-code-latin-ext-400-normal-KSMg0QLl.woff2 +0 -0
- package/dist/app/assets/fira-code-symbols2-400-normal-9X26I2LK.woff2 +0 -0
- package/dist/app/assets/fira-code-symbols2-400-normal-_QEZCEwe.woff +0 -0
- package/dist/app/assets/fredoka-latin-600-normal-C4zohCW5.woff2 +0 -0
- package/dist/app/assets/fredoka-latin-600-normal-CcrEjrB4.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-400-normal-BTotfTJu.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-400-normal-DZqxrq2p.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-600-normal-71GNu3SW.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-600-normal-BGq0mW3O.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-ext-400-normal-Dsrv2Tcn.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-ext-400-normal-g30qAdWV.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-ext-600-normal-Bz0x94Yp.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-cyrillic-ext-600-normal-DUMzJB7m.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-greek-400-normal-D9ESIMu3.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-greek-400-normal-_efipK4i.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-greek-600-normal-D-CqTdkO.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-greek-600-normal-DzTrcv_p.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-400-normal-CDDApCn2.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-400-normal-CYLoc0-x.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-600-normal-Cu4Hd6ag.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-600-normal-CuJfVYMP.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-ext-400-normal-C5H60-Va.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-ext-400-normal-RBey6euL.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-ext-600-normal-DIrixKbi.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-latin-ext-600-normal-DOrvGEcy.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-vietnamese-400-normal-DG4YqDda.woff2 +0 -0
- package/dist/app/assets/ibm-plex-sans-vietnamese-400-normal-fK1oJ5dG.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-vietnamese-600-normal-DgdngZtN.woff +0 -0
- package/dist/app/assets/ibm-plex-sans-vietnamese-600-normal-DpPYBSTl.woff2 +0 -0
- package/dist/app/assets/index-2965QO04.js +28 -0
- package/dist/app/assets/index-DafJtVDX.css +1 -0
- package/dist/app/assets/lightspeed-LxKj3vD3.svg +68 -0
- package/dist/app/assets/map-CFr4oRAS.webp +0 -0
- package/dist/app/assets/nebula-t0QcaA3K.webp +0 -0
- package/dist/app/assets/orbitron-latin-600-normal-75H6acHo.woff +0 -0
- package/dist/app/assets/orbitron-latin-600-normal-mazHmDYu.woff2 +0 -0
- package/dist/app/assets/orbitron-latin-700-normal-4jsRXGGJ.woff2 +0 -0
- package/dist/app/assets/orbitron-latin-700-normal-DmYOh-W9.woff +0 -0
- package/dist/app/assets/pallets-rO-RsztZ.webp +0 -0
- package/dist/app/assets/parchment-B0DDSYQX.webp +0 -0
- package/dist/app/assets/pixelify-sans-cyrillic-400-normal-Ckz2YJkH.woff2 +0 -0
- package/dist/app/assets/pixelify-sans-cyrillic-400-normal-DfOZNMlW.woff +0 -0
- package/dist/app/assets/pixelify-sans-cyrillic-600-normal-B3EuUOZG.woff +0 -0
- package/dist/app/assets/pixelify-sans-cyrillic-600-normal-BhqNJYOZ.woff2 +0 -0
- package/dist/app/assets/pixelify-sans-latin-400-normal-DLrIX9QE.woff2 +0 -0
- package/dist/app/assets/pixelify-sans-latin-400-normal-JapMNN6Z.woff +0 -0
- package/dist/app/assets/pixelify-sans-latin-600-normal-BNlgYbDL.woff +0 -0
- package/dist/app/assets/pixelify-sans-latin-600-normal-Dd_Dy7u5.woff2 +0 -0
- package/dist/app/assets/pixelify-sans-latin-ext-400-normal-BkfTUL4s.woff +0 -0
- package/dist/app/assets/pixelify-sans-latin-ext-400-normal-DdH6zlBQ.woff2 +0 -0
- package/dist/app/assets/pixelify-sans-latin-ext-600-normal-CDaIumwU.woff +0 -0
- package/dist/app/assets/pixelify-sans-latin-ext-600-normal-Dha6RiOG.woff2 +0 -0
- package/dist/app/assets/quill-and-scroll-BTgvJtxg.webp +0 -0
- package/dist/app/assets/racking-BI-9puyv.webp +0 -0
- package/dist/app/assets/source-serif-4-cyrillic-600-normal-BDP5YDHD.woff2 +0 -0
- package/dist/app/assets/source-serif-4-cyrillic-600-normal-DFnC3vAY.woff +0 -0
- package/dist/app/assets/source-serif-4-cyrillic-ext-600-normal-D_E8FDgP.woff2 +0 -0
- package/dist/app/assets/source-serif-4-cyrillic-ext-600-normal-DiT2IGQm.woff +0 -0
- package/dist/app/assets/source-serif-4-greek-600-normal-DdRkKr-1.woff2 +0 -0
- package/dist/app/assets/source-serif-4-greek-600-normal-DhXQw1Kl.woff +0 -0
- package/dist/app/assets/source-serif-4-latin-600-normal-DMD1h6_f.woff +0 -0
- package/dist/app/assets/source-serif-4-latin-600-normal-DouSKlru.woff2 +0 -0
- package/dist/app/assets/source-serif-4-latin-ext-600-normal-0sIUyHMO.woff2 +0 -0
- package/dist/app/assets/source-serif-4-latin-ext-600-normal-C6NNqpJh.woff +0 -0
- package/dist/app/assets/source-serif-4-vietnamese-600-normal-B0WJbuqT.woff +0 -0
- package/dist/app/assets/source-serif-4-vietnamese-600-normal-CznyfUKR.woff2 +0 -0
- package/dist/app/assets/star-chart-Chk7Xt5X.svg +91 -0
- package/dist/app/assets/starfield-BM71b4P5.svg +112 -0
- package/dist/app/assets/theme-B5wzykBQ.css +1 -0
- package/dist/app/assets/theme-CHdX0u8s.css +1 -0
- package/dist/app/assets/theme-DivLOVED.css +1 -0
- package/dist/app/assets/wood-panel-CFA5lKLa.svg +211 -0
- package/dist/app/index.html +16 -0
- package/dist/server/toil-ui.js +7886 -0
- package/package.json +95 -4
package/README.md
CHANGED
|
@@ -1,3 +1,239 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Toil UI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A local web app for seeing work across Jira, Azure DevOps and GitHub, read through
|
|
4
|
+
[toil](https://www.npmjs.com/package/@imagile-dev/toil): one dashboard per dossier,
|
|
5
|
+
with its stories, pull requests, builds and deployments side by side.
|
|
6
|
+
|
|
7
|
+
**Status: alpha, local only.** It runs on your own machine, binds loopback, and
|
|
8
|
+
reads through toil with your own connections and dossiers, read-only. Its
|
|
9
|
+
settings pages are the one place it changes anything, and only toil's own
|
|
10
|
+
connections and dossiers. Its Feedback dialog sends a report to Imagile through
|
|
11
|
+
`toil feedback`, only when you approve it. It is a separate package from toil: installing toil
|
|
12
|
+
never installs it.
|
|
13
|
+
|
|
14
|
+
## Start it
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @imagile-dev/toil-ui
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
It needs Node 24.14 or later and installs one dependency, `@imagile-dev/toil`, at
|
|
21
|
+
the exact version it was built with. Until a version shows on
|
|
22
|
+
[npm](https://www.npmjs.com/package/@imagile-dev/toil-ui), run it from a clone of
|
|
23
|
+
the repository:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npm ci --ignore-scripts
|
|
27
|
+
npm run build -w ui
|
|
28
|
+
node ui/dist/server/toil-ui.js
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
It prints one URL and keeps running until you press Ctrl+C:
|
|
32
|
+
|
|
33
|
+
```text
|
|
34
|
+
Toil UI 0.1.0-alpha.1 (alpha, local only), on toil 0.1.0-alpha.3
|
|
35
|
+
Syncing through toil, read-only, with your own connections and dossiers. Only its Settings pages change anything: toil's own connections and dossiers, when you ask. Feedback goes to Imagile only when you send it.
|
|
36
|
+
The cache is /home/you/.toil-ui/cache/toil-ui.db, kept 30 days after each sync; toil-ui wipe deletes it.
|
|
37
|
+
|
|
38
|
+
Open this URL in your browser. It carries this launch's token, so keep it to yourself:
|
|
39
|
+
http://127.0.0.1:53117/?token=<token>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Open that URL. The page trades the token for a session it keeps in memory, and the
|
|
43
|
+
token leaves the address bar. A reloaded page forgets its session, so open the URL
|
|
44
|
+
again to get back in. Each start prints a new token. Toil UI opens no browser
|
|
45
|
+
itself.
|
|
46
|
+
|
|
47
|
+
`toil-ui --sample` serves the sample dossiers and the scripted agent the site's
|
|
48
|
+
preview uses, with nothing connected to a tracker.
|
|
49
|
+
|
|
50
|
+
## What it reads
|
|
51
|
+
|
|
52
|
+
Each dashboard reads its dossier the way `toil dossiers show` describes it: the
|
|
53
|
+
Jira project, the Azure DevOps project and pipelines, the GitHub repository and
|
|
54
|
+
project board, and the OpenShift namespace of each environment. Every call runs
|
|
55
|
+
in-process through `@imagile-dev/toil/api`, read-only, and toil's audit log
|
|
56
|
+
records it with `via: "api"` and `caller: "toil-ui"`. A call that fails shows on
|
|
57
|
+
its own panel with toil's message and fix.
|
|
58
|
+
|
|
59
|
+
## Toil's configuration
|
|
60
|
+
|
|
61
|
+
The Settings pages manage what `toil connections` and `toil dossiers` manage, by
|
|
62
|
+
running those commands through `@imagile-dev/toil/api`, never by editing a file:
|
|
63
|
+
|
|
64
|
+
- **Connections:** list, add, test, set the default, turn writes on or off,
|
|
65
|
+
replace a secret (`toil connections login`) and remove. A secret goes from a
|
|
66
|
+
password field to toil, which keeps it in the OS credential store; the page
|
|
67
|
+
clears the field, and it is never logged, stored by Toil UI, or sent back.
|
|
68
|
+
Turning writes on asks you to type the connection's name, as the CLI does. A
|
|
69
|
+
connection made by `TOIL_*` env vars alone is shown read-only, with where it
|
|
70
|
+
came from.
|
|
71
|
+
- **Dossiers:** create one, add a repository, link an area, name a field, and
|
|
72
|
+
show and check any of them. A link to a connection with writes on is refused
|
|
73
|
+
here, as over MCP: make it on the CLI.
|
|
74
|
+
- **Bounds and time limit:** toil has no command for these, so they are shown
|
|
75
|
+
read-only, with the file or env var that sets them.
|
|
76
|
+
|
|
77
|
+
Every change is an explicit action, runs the command's own checks, and is in
|
|
78
|
+
toil's audit log as `caller: "toil-ui"`. The page can run no other command on this
|
|
79
|
+
path, and never a tracker write. Adding or changing connections needs a toil
|
|
80
|
+
newer than 0.1.0-alpha.2; with that one, use the CLI.
|
|
81
|
+
|
|
82
|
+
## Feedback
|
|
83
|
+
|
|
84
|
+
The **Feedback** button in the header opens a dialog for a bug report or a feature
|
|
85
|
+
request: the kind, a title, the details and your email. It sends through
|
|
86
|
+
`toil feedback` (toil's `skills/toil/core.md`, **Feedback**), never on its own:
|
|
87
|
+
|
|
88
|
+
- **A live preview.** As you type, the page asks toil for the report it would send,
|
|
89
|
+
read-only, and shows it exactly, with the endpoint. Nothing is sent to show it.
|
|
90
|
+
- **toil's disclaimer, and a checkbox.** The report goes to Imagile LLC, which files
|
|
91
|
+
it as a public GitHub issue; your email stays private; you remove company data
|
|
92
|
+
first. Send works only while the box is ticked, and any edit clears it, so you
|
|
93
|
+
agree to the report on screen and no other.
|
|
94
|
+
- **Only what you typed.** toil adds its version and commit, nothing else: no
|
|
95
|
+
dossier, connection, host or cached data.
|
|
96
|
+
- **The same lock as Settings.** `api/feedback` needs the session, the page's
|
|
97
|
+
Origin and the CSRF token, takes the four fields and nothing else, and runs
|
|
98
|
+
`toil feedback` and no other command. Your tick becomes the yes to the command's
|
|
99
|
+
own consent question. With sample data it sends nothing. With a toil that has no
|
|
100
|
+
`feedback` command (0.1.0-alpha.2), the dialog says so and points at the site's
|
|
101
|
+
form.
|
|
102
|
+
|
|
103
|
+
## Sync and the cache
|
|
104
|
+
|
|
105
|
+
The dashboards read from a local cache, which a sync fills. Press **Sync now** in
|
|
106
|
+
the Sync panel at the foot of the page. The sync makes the same toil calls the
|
|
107
|
+
dashboards make, for every dossier, and stores the answers. The work items go
|
|
108
|
+
through toil's Open Work Item mapping, with their status changes and the pull
|
|
109
|
+
requests, builds and deployments that name them.
|
|
110
|
+
|
|
111
|
+
- **Incremental.** After the first sync, Jira and Azure DevOps searches ask only for
|
|
112
|
+
what changed since the last good sync (`updatedSince`, five minutes early in
|
|
113
|
+
case the clocks disagree), and the GitHub board marks the issues whose
|
|
114
|
+
`updatedAt` moved. Only those items and their histories are fetched again.
|
|
115
|
+
Pull requests, builds, deployments and iterations have no "changed since" in
|
|
116
|
+
toil, so they're read again each time, bounded as the dashboards bound them.
|
|
117
|
+
- **Every page.** Each call follows `meta.page.nextCursor` to the end, up to 200
|
|
118
|
+
pages, and fails that source, saying so, rather than keep part of a listing.
|
|
119
|
+
- **Each source on its own.** Each area a dossier reads (Jira, Bitbucket, Jenkins,
|
|
120
|
+
OpenShift and so on) is a source with its own state. A source that fails shows
|
|
121
|
+
toil's message and fix in the Sync panel, and keeps its last good data, marked
|
|
122
|
+
stale. The other sources and dossiers aren't touched. The next sync asks it
|
|
123
|
+
for everything since its last good sync, so nothing is missed.
|
|
124
|
+
- **When.** The line under the header says when the data was synced. The panel
|
|
125
|
+
says when each dossier was synced, and shows a running sync's progress
|
|
126
|
+
(requests, pages and retries, from toil's own progress events).
|
|
127
|
+
- **Where.** The cache is one SQLite file, `cache/toil-ui.db` in the data folder,
|
|
128
|
+
through Node's built-in `node:sqlite`, so there's no native module. It holds
|
|
129
|
+
ticket content, so it stays on this machine and is readable by your account
|
|
130
|
+
only.
|
|
131
|
+
- **For how long.** Anything not synced again within the retention period (30
|
|
132
|
+
days by default) is deleted, at start and after each sync.
|
|
133
|
+
- **Wiping it.** **Wipe the cache** in the Sync panel deletes it after asking
|
|
134
|
+
first. `toil-ui wipe` does the same from a terminal, once `toil-ui` has
|
|
135
|
+
stopped: a running Toil UI holds `toil-ui.lock` in the data folder, and the
|
|
136
|
+
command refuses while it does. Your trackers are never touched. The next sync fetches everything again.
|
|
137
|
+
- **Deleted tickets.** An item deleted in its tracker stays in the cache until
|
|
138
|
+
the retention period ends or you wipe it, since an incremental search only
|
|
139
|
+
returns items that still exist.
|
|
140
|
+
|
|
141
|
+
The page can run only the reads the dashboards make: `dossiers list` and `dossiers
|
|
142
|
+
show`, and each area's search, history, pull request, build and deployment reads.
|
|
143
|
+
Any other command is refused before it reaches toil, and a change to a tracker is
|
|
144
|
+
never made from the page.
|
|
145
|
+
|
|
146
|
+
## The agent
|
|
147
|
+
|
|
148
|
+
The docked chat answers with the agent your organization already approved, on the
|
|
149
|
+
subscription you already have. Toil UI has three adapters, each an optional peer
|
|
150
|
+
dependency that is loaded only when you choose it:
|
|
151
|
+
|
|
152
|
+
| Adapter | Package | Starts | Signs in with |
|
|
153
|
+
|---|---|---|---|
|
|
154
|
+
| Claude | `@anthropic-ai/claude-agent-sdk` (and its peer `zod`) | `claude` (Claude Code) | Claude Code's own login, or Bedrock, Foundry or Vertex through Claude Code's environment switches |
|
|
155
|
+
| GitHub Copilot | `@github/copilot-sdk` | `copilot` (the Copilot CLI) | your Copilot seat, through the CLI |
|
|
156
|
+
| Codex | `@openai/codex-sdk` | `codex` (the Codex CLI) | the CLI's ChatGPT sign-in or its own API key setup |
|
|
157
|
+
|
|
158
|
+
```bash
|
|
159
|
+
npm install -g @anthropic-ai/claude-agent-sdk zod # beside a global toil-ui
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Then choose it under **Settings, Agent**: the adapter, the model (empty for the CLI's
|
|
163
|
+
default), the CLI's path (empty to use the one on `PATH`) and, for Claude, the
|
|
164
|
+
endpoint. The choice is kept in `<data folder>/agent.json`, never in toil's config,
|
|
165
|
+
and has no field for a key: each SDK signs in the way its CLI does. Install the SDK
|
|
166
|
+
with `--omit=optional` if you don't want its bundled copy of the CLI on disk; Toil UI
|
|
167
|
+
never starts that copy anyway.
|
|
168
|
+
|
|
169
|
+
- **Only the CLI already on this machine.** Toil UI finds it on `PATH` (skipping
|
|
170
|
+
relative entries and the working directory) or at the path you set, which must
|
|
171
|
+
name that CLI, hands that path to the SDK, and never downloads one.
|
|
172
|
+
- **An environment of its own.** The CLI gets only what it needs to run (paths, home
|
|
173
|
+
and temp folders, proxy and CA settings) and its own sign-in variables. toil's
|
|
174
|
+
`TOIL_*` variables, `GITHUB_TOKEN` and CI tokens never reach it. Not found is a plain
|
|
175
|
+
error naming the CLI and the fix. On Windows a `.cmd` shim can't be started by the
|
|
176
|
+
SDKs, so point at the `.exe`.
|
|
177
|
+
- **Read-only tools, one dossier.** The agent gets `owi_query`, `owi_get` and
|
|
178
|
+
`owi_history` over the cache, `proposal_fields` (a write command's input fields,
|
|
179
|
+
from toil's registry), and `toil mcp`'s read tools for live lookups, called through
|
|
180
|
+
toil's `execute()` with `readOnly: true`. The dossier is fixed to the one on screen.
|
|
181
|
+
There is no write tool, and each SDK's own tools (shell, files, web, plugins, other
|
|
182
|
+
MCP servers) are switched off.
|
|
183
|
+
- **Citations are checked.** Every answer cites the work items it used as links.
|
|
184
|
+
The server holds each id it names to what its tools returned, and flags any other
|
|
185
|
+
as unverified above the answer.
|
|
186
|
+
- **Writes are proposals.** A change the agent suggests comes back as a card with the
|
|
187
|
+
`toil … --allow-write` command line for you to run through toil's write gate. The
|
|
188
|
+
agent can't run it.
|
|
189
|
+
- **Codex takes tools only from an MCP server**, so for the length of one question
|
|
190
|
+
Toil UI serves them at `api/agent/mcp` on its own loopback port, behind a token made
|
|
191
|
+
for that question. The token reaches Codex in its environment, never on its command
|
|
192
|
+
line, and the endpoint refuses any request carrying a browser's `Origin`.
|
|
193
|
+
|
|
194
|
+
With no adapter chosen, the chat says so and names the three. `toil-ui --sample`
|
|
195
|
+
keeps the scripted agent, which answers its starter questions from the sample data.
|
|
196
|
+
|
|
197
|
+
## The lock on the door
|
|
198
|
+
|
|
199
|
+
Any program on the machine, or a web page using DNS rebinding, can reach a local
|
|
200
|
+
port, so the server lets in only the browser holding this launch's token:
|
|
201
|
+
|
|
202
|
+
- **The token.** A random token per start, in the URL it prints. The page trades it
|
|
203
|
+
for a session id, which it keeps in memory and sends as a header on every API
|
|
204
|
+
call. Nothing is kept in a cookie: a browser would send one to any other server
|
|
205
|
+
on `127.0.0.1`, whatever its port.
|
|
206
|
+
- **The Host header.** Only the exact `127.0.0.1:<port>` it printed is answered.
|
|
207
|
+
- **No CORS.** No `Access-Control-*` header is ever sent. Every POST also needs the
|
|
208
|
+
page's own `Origin`, a JSON body, and the session's CSRF token.
|
|
209
|
+
- **No network but toil's.** It talks to the hosts in your toil connections, and
|
|
210
|
+
nothing else, apart from a feedback report you send, which toil sends to Imagile. The agent CLI you choose talks to its own model endpoint.
|
|
211
|
+
|
|
212
|
+
## Settings
|
|
213
|
+
|
|
214
|
+
| Setting | Flag | Env var | Default |
|
|
215
|
+
|---|---|---|---|
|
|
216
|
+
| Bind address | `--host` | `TOIL_UI_HOST` | `127.0.0.1` (`::1` is the other choice) |
|
|
217
|
+
| Port | `--port` | `TOIL_UI_PORT` | `0`: the OS picks a free one |
|
|
218
|
+
| Base path | `--base-path` | `TOIL_UI_BASE_PATH` | `/` |
|
|
219
|
+
| Data folder | `--data-dir` | `TOIL_UI_DATA_DIR` | `~/.toil-ui` |
|
|
220
|
+
| Retention | `--retention-days` | `TOIL_UI_RETENTION_DAYS` | `30` (1 to 3650) |
|
|
221
|
+
|
|
222
|
+
A flag beats its env var. Any bind address other than loopback is refused in this
|
|
223
|
+
release. The data folder is Toil UI's own, apart from toil's `~/.toil/`, and holds
|
|
224
|
+
the cache. A `~` at the start of `TOIL_UI_DATA_DIR` means your home folder, on
|
|
225
|
+
Windows too.
|
|
226
|
+
|
|
227
|
+
## Not in this alpha
|
|
228
|
+
|
|
229
|
+
- **Serving other machines.** It is local only.
|
|
230
|
+
|
|
231
|
+
## The package
|
|
232
|
+
|
|
233
|
+
`@imagile-dev/toil-ui` ships the server (`dist/server/toil-ui.js`) and the built app
|
|
234
|
+
(`dist/app/`), and nothing else. It has no install scripts and no native addons,
|
|
235
|
+
spawns no program of its own (an agent SDK you install starts its CLI), and its
|
|
236
|
+
front end's framework is built in rather than installed. The agent SDKs are
|
|
237
|
+
optional peer dependencies: none is installed with it.
|
|
238
|
+
|
|
239
|
+
Apache-2.0. See `NOTICE` for what the app bundles.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.react-flow{--xy-edge-stroke-default:#b1b1b7;--xy-edge-stroke-width-default:1;--xy-edge-stroke-selected-default:#555;--xy-connectionline-stroke-default:#b1b1b7;--xy-connectionline-stroke-width-default:1;--xy-attribution-background-color-default:#ffffff80;--xy-minimap-background-color-default:#fff;--xy-minimap-mask-background-color-default:#f0f0f099;--xy-minimap-mask-stroke-color-default:transparent;--xy-minimap-mask-stroke-width-default:1;--xy-minimap-node-background-color-default:#e2e2e2;--xy-minimap-node-stroke-color-default:transparent;--xy-minimap-node-stroke-width-default:2;--xy-background-color-default:transparent;--xy-background-pattern-dots-color-default:#91919a;--xy-background-pattern-lines-color-default:#eee;--xy-background-pattern-cross-color-default:#e2e2e2;background-color:var(--xy-background-color,var(--xy-background-color-default));--xy-node-border-default:1px solid #bbb;--xy-node-border-selected-default:1px solid #555;--xy-handle-background-color-default:#333;--xy-selection-background-color-default:#9696b41a;--xy-selection-border-default:1px dotted #9b9b9bcc;--xy-resize-background-color-default:#3367d9;direction:ltr}.react-flow.dark{--xy-edge-stroke-default:#3e3e3e;--xy-edge-stroke-width-default:1;--xy-edge-stroke-selected-default:#727272;--xy-connectionline-stroke-default:#b1b1b7;--xy-connectionline-stroke-width-default:1;--xy-attribution-background-color-default:#96969640;--xy-minimap-background-color-default:#141414;--xy-minimap-mask-background-color-default:#3c3c3c99;--xy-minimap-mask-stroke-color-default:transparent;--xy-minimap-mask-stroke-width-default:1;--xy-minimap-node-background-color-default:#2b2b2b;--xy-minimap-node-stroke-color-default:transparent;--xy-minimap-node-stroke-width-default:2;--xy-background-color-default:#141414;--xy-background-pattern-dots-color-default:#555;--xy-background-pattern-lines-color-default:#333;--xy-background-pattern-cross-color-default:#333;--xy-node-color-default:#f8f8f8}.react-flow__background{background-color:var(--xy-background-color-props,var(--xy-background-color,var(--xy-background-color-default)));pointer-events:none;z-index:-1}.react-flow__container{width:100%;height:100%;position:absolute;top:0;left:0}.react-flow__pane{z-index:1;touch-action:none}.react-flow__pane.draggable{cursor:grab}.react-flow__pane.dragging{cursor:grabbing}.react-flow__pane.selection{cursor:pointer}.react-flow__viewport{transform-origin:0 0;z-index:2;pointer-events:none}.react-flow__renderer{z-index:4}.react-flow__selection{z-index:6}.react-flow__nodesselection-rect:focus,.react-flow__nodesselection-rect:focus-visible{outline:none}.react-flow__edge-path{stroke:var(--xy-edge-stroke,var(--xy-edge-stroke-default));stroke-width:var(--xy-edge-stroke-width,var(--xy-edge-stroke-width-default));fill:none}.react-flow__connection-path{stroke:var(--xy-connectionline-stroke,var(--xy-connectionline-stroke-default));stroke-width:var(--xy-connectionline-stroke-width,var(--xy-connectionline-stroke-width-default));fill:none}.react-flow .react-flow__edges{position:absolute}.react-flow .react-flow__edges svg{pointer-events:none;position:absolute;overflow:visible}.react-flow__edge{pointer-events:visibleStroke}.react-flow__edge.selectable{cursor:pointer}.react-flow__edge.animated path{stroke-dasharray:5;animation:.5s linear infinite dashdraw}.react-flow__edge.animated path.react-flow__edge-interaction{stroke-dasharray:none;animation:none}.react-flow__edge.inactive{pointer-events:none}.react-flow__edge.selected,.react-flow__edge:focus,.react-flow__edge:focus-visible{outline:none}.react-flow__edge.selected .react-flow__edge-path,.react-flow__edge.selectable:focus .react-flow__edge-path,.react-flow__edge.selectable:focus-visible .react-flow__edge-path{stroke:var(--xy-edge-stroke-selected,var(--xy-edge-stroke-selected-default))}.react-flow__edge-textwrapper{pointer-events:all}.react-flow__edge .react-flow__edge-text{pointer-events:none;-webkit-user-select:none;user-select:none}.react-flow__arrowhead polyline{stroke:var(--xy-edge-stroke,var(--xy-edge-stroke-default))}.react-flow__arrowhead polyline.arrowclosed{fill:var(--xy-edge-stroke,var(--xy-edge-stroke-default))}.react-flow__connection{pointer-events:none}.react-flow__connection .animated{stroke-dasharray:5;animation:.5s linear infinite dashdraw}svg.react-flow__connectionline{z-index:1001;position:absolute;overflow:visible}.react-flow__nodes{pointer-events:none;transform-origin:0 0}.react-flow__node{-webkit-user-select:none;user-select:none;pointer-events:all;transform-origin:0 0;box-sizing:border-box;cursor:default;position:absolute}.react-flow__node.selectable{cursor:pointer}.react-flow__node.draggable{cursor:grab;pointer-events:all}.react-flow__node.draggable.dragging{cursor:grabbing}.react-flow__nodesselection{z-index:3;transform-origin:0 0;pointer-events:none}.react-flow__nodesselection-rect{pointer-events:all;cursor:grab;position:absolute}.react-flow__handle{pointer-events:none;background-color:var(--xy-handle-background-color,var(--xy-handle-background-color-default));min-width:5px;min-height:5px;position:absolute}.react-flow__handle.connectingfrom{pointer-events:all}.react-flow__handle.connectionindicator{pointer-events:all;cursor:crosshair}.react-flow__handle-bottom{top:auto;bottom:0;left:50%;transform:translate(-50%,50%)}.react-flow__handle-top{top:0;left:50%;transform:translate(-50%,-50%)}.react-flow__handle-left{top:50%;left:0;transform:translate(-50%,-50%)}.react-flow__handle-right{top:50%;right:0;transform:translate(50%,-50%)}.react-flow__edgeupdater{cursor:move;pointer-events:all}.react-flow__pane.selection .react-flow__panel{pointer-events:none}.react-flow__panel{z-index:5;margin:15px;position:absolute}.react-flow__panel.top{top:0}.react-flow__panel.bottom{bottom:0}.react-flow__panel.top.center,.react-flow__panel.bottom.center{left:50%;transform:translate(-15px)translate(-50%)}.react-flow__panel.left{left:0}.react-flow__panel.right{right:0}.react-flow__panel.left.center,.react-flow__panel.right.center{top:50%;transform:translateY(-15px)translateY(-50%)}.react-flow__attribution{background:var(--xy-attribution-background-color,var(--xy-attribution-background-color-default));margin:0;padding:2px 3px;font-size:10px}.react-flow__attribution a{color:#999;text-decoration:none}@keyframes dashdraw{0%{stroke-dashoffset:10px}}.react-flow__edgelabel-renderer{pointer-events:none;-webkit-user-select:none;user-select:none;width:100%;height:100%;position:absolute;top:0;left:0}.react-flow__viewport-portal{-webkit-user-select:none;user-select:none;width:100%;height:100%;position:absolute;top:0;left:0}.react-flow__minimap{background:var(--xy-minimap-background-color-props,var(--xy-minimap-background-color,var(--xy-minimap-background-color-default)))}.react-flow__minimap-svg{display:block}.react-flow__minimap-mask{fill:var(--xy-minimap-mask-background-color-props,var(--xy-minimap-mask-background-color,var(--xy-minimap-mask-background-color-default)));stroke:var(--xy-minimap-mask-stroke-color-props,var(--xy-minimap-mask-stroke-color,var(--xy-minimap-mask-stroke-color-default)));stroke-width:var(--xy-minimap-mask-stroke-width-props,var(--xy-minimap-mask-stroke-width,var(--xy-minimap-mask-stroke-width-default)))}.react-flow__minimap-node{fill:var(--xy-minimap-node-background-color-props,var(--xy-minimap-node-background-color,var(--xy-minimap-node-background-color-default)));stroke:var(--xy-minimap-node-stroke-color-props,var(--xy-minimap-node-stroke-color,var(--xy-minimap-node-stroke-color-default)));stroke-width:var(--xy-minimap-node-stroke-width-props,var(--xy-minimap-node-stroke-width,var(--xy-minimap-node-stroke-width-default)))}.react-flow__background-pattern.dots{fill:var(--xy-background-pattern-color-props,var(--xy-background-pattern-color,var(--xy-background-pattern-dots-color-default)))}.react-flow__background-pattern.lines{stroke:var(--xy-background-pattern-color-props,var(--xy-background-pattern-color,var(--xy-background-pattern-lines-color-default)))}.react-flow__background-pattern.cross{stroke:var(--xy-background-pattern-color-props,var(--xy-background-pattern-color,var(--xy-background-pattern-cross-color-default)))}.react-flow__controls{flex-direction:column;display:flex}.react-flow__controls.horizontal{flex-direction:row}.react-flow__controls-button{justify-content:center;align-items:center;width:26px;height:26px;padding:4px;display:flex}.react-flow__controls-button svg{fill:currentColor;width:100%;max-width:12px;max-height:12px}.react-flow__node-input,.react-flow__node-default,.react-flow__node-output,.react-flow__node-group{border:var(--xy-node-border,var(--xy-node-border-default));color:var(--xy-node-color,var(--xy-node-color-default))}.react-flow__node-input.selected,.react-flow__node-input:focus,.react-flow__node-input:focus-visible,.react-flow__node-default.selected,.react-flow__node-default:focus,.react-flow__node-default:focus-visible,.react-flow__node-output.selected,.react-flow__node-output:focus,.react-flow__node-output:focus-visible,.react-flow__node-group.selected,.react-flow__node-group:focus,.react-flow__node-group:focus-visible{border:var(--xy-node-border-selected,var(--xy-node-border-selected-default));outline:none}.react-flow__nodesselection-rect,.react-flow__selection{background:var(--xy-selection-background-color,var(--xy-selection-background-color-default));border:var(--xy-selection-border,var(--xy-selection-border-default))}.react-flow__resize-control{position:absolute}.react-flow__resize-control.left,.react-flow__resize-control.right{cursor:ew-resize}.react-flow__resize-control.top,.react-flow__resize-control.bottom{cursor:ns-resize}.react-flow__resize-control.top.left,.react-flow__resize-control.bottom.right{cursor:nwse-resize}.react-flow__resize-control.bottom.left,.react-flow__resize-control.top.right{cursor:nesw-resize}.react-flow__resize-control.handle{background-color:var(--xy-resize-background-color,var(--xy-resize-background-color-default));border:1px solid #fff;border-radius:1px;width:5px;height:5px;translate:-50% -50%}.react-flow__resize-control.handle.left{top:50%;left:0}.react-flow__resize-control.handle.right{top:50%;left:100%}.react-flow__resize-control.handle.top{top:0;left:50%}.react-flow__resize-control.handle.bottom{top:100%;left:50%}.react-flow__resize-control.handle.top.left,.react-flow__resize-control.handle.bottom.left{left:0}.react-flow__resize-control.handle.top.right,.react-flow__resize-control.handle.bottom.right{left:100%}.react-flow__resize-control.line{border-color:var(--xy-resize-background-color,var(--xy-resize-background-color-default));border-style:solid;border-width:0}.react-flow__resize-control.line.left,.react-flow__resize-control.line.right{width:1px;height:100%;top:0;transform:translate(-50%)}.react-flow__resize-control.line.left{border-left-width:1px;left:0}.react-flow__resize-control.line.right{border-right-width:1px;left:100%}.react-flow__resize-control.line.top,.react-flow__resize-control.line.bottom{width:100%;height:1px;left:0;transform:translateY(-50%)}.react-flow__resize-control.line.top{border-top-width:1px;top:0}.react-flow__resize-control.line.bottom{border-bottom-width:1px;top:100%}
|