@imagile-dev/toil-ui 0.1.0-beta.4 → 0.1.0-beta.6
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/README.md +529 -180
- package/dist/app/assets/400-3Dshv1o0.css +1 -0
- package/dist/app/assets/400-BlzPh-5d.css +1 -0
- package/dist/app/assets/400-CPrO1MiG.css +1 -0
- package/dist/app/assets/400-CbHxiUkt.css +1 -0
- package/dist/app/assets/400-D153RTnK.css +1 -0
- package/dist/app/assets/600-B0bH0tPL.css +1 -0
- package/dist/app/assets/600-BC2hxnnO.css +1 -0
- package/dist/app/assets/600-BR9-_eiK.css +1 -0
- package/dist/app/assets/600-BsKsKkx5.css +1 -0
- package/dist/app/assets/600-Czj0FyAy.css +1 -0
- package/dist/app/assets/600-D452fNA9.css +1 -0
- package/dist/app/assets/600-D6SrDV1i.css +1 -0
- package/dist/app/assets/600-DBby7xF7.css +1 -0
- package/dist/app/assets/700-DlBBsyxq.css +1 -0
- package/dist/app/assets/700-Dr8Emwbw.css +1 -0
- package/dist/app/assets/Graph-CAQkpyYr.js +7 -0
- package/dist/app/assets/PowershellMan-DldYCOOP.js +1 -0
- package/dist/app/assets/gallery-447w4Nva.js +1 -0
- package/dist/app/assets/graph-CPXdI5ap.js +13 -0
- package/dist/app/assets/graph-CpctQRjW.css +1 -0
- package/dist/app/assets/index-CGVZr4kM.css +1 -0
- package/dist/app/assets/index-lUb0DGcI.js +732 -0
- package/dist/app/assets/jsx-runtime-DyZJNswf.js +1 -0
- package/dist/app/assets/latin-400-BVAlDo0s.css +1 -0
- package/dist/app/assets/latin-400-_vizA_-6.css +1 -0
- package/dist/app/assets/latin-600-BcF9gTYO.css +1 -0
- package/dist/app/assets/latin-600-Cv5fXBpv.css +1 -0
- package/dist/app/assets/latin-600-yBvtfTSt.css +1 -0
- package/dist/app/assets/latin-800-DN-4L033.css +1 -0
- package/dist/app/assets/sample-app-DEDGRcL1.js +27 -0
- package/dist/app/assets/series-B2reSWoM.svg +10 -0
- package/dist/app/assets/series-CRHwxbpo.svg +10 -0
- package/dist/app/assets/series-CppUGsOL.svg +10 -0
- package/dist/app/assets/series-DVzjwDhp.svg +10 -0
- package/dist/app/assets/series-zigaZBZX.svg +10 -0
- package/dist/app/assets/{source-serif-4-cyrillic-600-normal-DFnC3vAY.woff → source-serif-4-cyrillic-600-normal-CHh5eQWW.woff} +0 -0
- package/dist/app/assets/{source-serif-4-cyrillic-ext-600-normal-DiT2IGQm.woff → source-serif-4-cyrillic-ext-600-normal-h2VnbV3V.woff} +0 -0
- package/dist/app/assets/{source-serif-4-greek-600-normal-DhXQw1Kl.woff → source-serif-4-greek-600-normal-OkzgCkGB.woff} +0 -0
- package/dist/app/assets/{source-serif-4-latin-600-normal-DMD1h6_f.woff → source-serif-4-latin-600-normal-DeJomR3S.woff} +0 -0
- package/dist/app/assets/{source-serif-4-latin-ext-600-normal-C6NNqpJh.woff → source-serif-4-latin-ext-600-normal-B2fExS53.woff} +0 -0
- package/dist/app/assets/source-serif-4-latin-ext-600-normal-pa-C5Dkf.woff2 +0 -0
- package/dist/app/assets/source-serif-4-vietnamese-600-normal-B33FcZBi.woff2 +0 -0
- package/dist/app/assets/{source-serif-4-vietnamese-600-normal-B0WJbuqT.woff → source-serif-4-vietnamese-600-normal-CKUOBVO_.woff} +0 -0
- package/dist/app/assets/theme-BxDF9UoZ.css +1 -0
- package/dist/app/assets/theme-zHGs48Oo.css +1 -0
- package/dist/app/assets/unread-27QyAoLL.css +1 -0
- package/dist/app/assets/unread-Cpm8TUDq.js +4 -0
- package/dist/app/index.html +7 -2
- package/dist/server/toil-ui.js +21912 -10488
- package/package.json +19 -17
- package/dist/app/assets/Graph-8jUpxY5T.js +0 -7
- package/dist/app/assets/PowershellMan-D_GfPDDt.js +0 -1
- package/dist/app/assets/index-BJY6F1XS.js +0 -504
- package/dist/app/assets/index-BWejFOaT.css +0 -1
- package/dist/app/assets/press-start-2p-latin-400-normal-KLytu4cr.woff +0 -0
- package/dist/app/assets/press-start-2p-latin-400-normal-_wFEWmAB.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-vietnamese-600-normal-CznyfUKR.woff2 +0 -0
- package/dist/app/assets/theme-Bd9rCh2b.css +0 -1
- package/dist/app/assets/theme-hbyLw_lf.css +0 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ requests view for what is waiting on review, and a daily worklog of what happene
|
|
|
8
8
|
**Status: beta, local only.** It runs on your own machine, binds loopback, and
|
|
9
9
|
reads through toil with your own connections and Toil projects, read-only. Its
|
|
10
10
|
settings pages, and a Toil project's name and description edited in place, are the only
|
|
11
|
-
places it changes anything of toil's, and only toil's own connections and Toil projects. The worklog keeps its pages and the notes you add in its own
|
|
11
|
+
places it changes anything of toil's, and only toil's own connections and Toil projects. It changes a tracker only when you press for it: a card dropped on another Board column (a status change), **Add to the board and move**, and Classify's **Apply** (`categorize`), each through toil's own command behind the connection's `writes` setting. Classify choices and **Save diagram** write only toil's own files on this computer. The worklog keeps its pages and the notes you add in its own
|
|
12
12
|
data folder, and writes anywhere else only when you export a page. Its Feedback dialog sends a report to Imagile through
|
|
13
13
|
`toil feedback`, only when you approve it. It is a separate package from toil: installing toil
|
|
14
14
|
never installs it. toil's beta commitment to stable commands, flags and output doesn't
|
|
@@ -36,25 +36,21 @@ It prints one URL and keeps running until you press Ctrl+C:
|
|
|
36
36
|
|
|
37
37
|
```text
|
|
38
38
|
Toil UI <version> (beta, local only), on toil <version>
|
|
39
|
-
Syncing through toil, read-only, with your own connections and Toil projects.
|
|
39
|
+
Syncing through toil, read-only, with your own connections and Toil projects. It changes a tracker only when you press for it (a card dropped on another Board column, Add to the board and move, Classify's Apply), through toil's own command behind the connection's writes setting. Settings, Classify choices and Save diagram write only toil's own files. The worklog keeps its pages and your notes in its data folder, and writes anywhere else only when you export one. Feedback goes to Imagile only when you send it.
|
|
40
40
|
The cache is /home/you/.toil-ui/cache/toil-ui.db, kept 30 days after each sync; toil-ui wipe deletes it.
|
|
41
41
|
|
|
42
|
-
Open this URL in your browser. It
|
|
43
|
-
http://127.0.0.1:53117
|
|
42
|
+
Open this URL in your browser. It holds no secret: your browser is let in by a cookie signed with the key in the data folder, and anything running as you on this machine can reach Toil UI too:
|
|
43
|
+
http://127.0.0.1:53117/
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Open that URL.
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
restores, can carry the session while the same `toil-ui` is still running. Toil UI opens no browser itself.
|
|
46
|
+
Open that URL. There is nothing to paste and nothing stored by the page: the first
|
|
47
|
+
time your browser opens the page, the server sets a cookie, and the browser sends it
|
|
48
|
+
back with every call. Reload, bookmark, open a new tab or restart `toil-ui`, and it
|
|
49
|
+
still works. Toil UI opens no browser itself.
|
|
51
50
|
|
|
52
|
-
Why
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
cookie to every port on `127.0.0.1`, so any other local server would receive the
|
|
56
|
-
session. `sessionStorage` belongs to this exact origin (port included) and is never
|
|
57
|
-
sent anywhere. `localStorage` would outlive the tab, so it isn't used.
|
|
51
|
+
Why this and not a token in the URL: the maintainer chose a local-only tool with no
|
|
52
|
+
step for the person and nothing in `sessionStorage` (#561). What does the work
|
|
53
|
+
instead is in **The checks on the door**, below, with what they don't protect against.
|
|
58
54
|
|
|
59
55
|
`toil-ui --sample` serves the sample Toil projects and the scripted agent that
|
|
60
56
|
[the site's Toil UI page](https://imagile-dev.github.io/toil/ui/) runs on, with
|
|
@@ -66,16 +62,45 @@ Until you have a Toil project and it has synced once, the Toil projects view sho
|
|
|
66
62
|
checklist in place of the empty page:
|
|
67
63
|
|
|
68
64
|
1. **Connect a tracker** opens Settings, Connections at the add form. If an agent following the toil skill's `setup.md` already created the connection, you only enter its secret here, on its row.
|
|
69
|
-
2. **Create a Toil project** opens
|
|
65
|
+
2. **Create a Toil project** opens the New Toil project wizard (`#/new-project`, below).
|
|
70
66
|
3. **Sync** starts the first sync, as the Sync panel's Sync now does.
|
|
71
67
|
|
|
72
68
|
Each step ticks itself off from toil's own state: `toil connections list` for a
|
|
73
69
|
connection to Jira, Azure DevOps or GitHub (one made by env vars counts), `toil
|
|
74
|
-
projects list` for a Toil project, and the Sync panel for the sync. Beside the steps,
|
|
75
|
-
**Try the sample data** shows `npx @imagile-dev/toil-ui --sample` with a Copy
|
|
76
|
-
button, to restart Toil UI on the sample Toil projects. The checklist goes once the first
|
|
70
|
+
projects list` for a Toil project, and the Sync panel for the sync. Beside the steps, **Set it up step by step** opens the setup wizard (`#/setup`, below). The checklist goes once the first
|
|
77
71
|
sync finishes. Each step's (i) explains it and links to these docs.
|
|
78
72
|
|
|
73
|
+
## The setup wizard
|
|
74
|
+
|
|
75
|
+
For someone new to AI, toil and Toil UI, `#/setup` walks through setup one question a screen, with Back and one Next button, which stays disabled until the page is done (an optional page has a "Not now" choice), and a "Step 3 of 7" line. It opens from **Set it up step by step** on the first run, from **Set up toil, step by step** in the command palette, from the link under Settings' heading, and by its own address.
|
|
76
|
+
|
|
77
|
+
1. **Welcome** says what toil and Toil UI are, and that nothing in your tools changes without you.
|
|
78
|
+
2. **An AI agent (optional)** comes first, so it can explain the rest. It is the AI agent page's own Install dialog and Save, explained for someone who has never used one: what it is, that it only reads and suggests, that it uses the subscription you already have so Toil UI stores no key, and that it never sees your login. Choose "Not now" and every later step is what it always was, with one small line, "Set up an AI agent to get explanations here", that brings you back here and then returns you to where you were.
|
|
79
|
+
3. **Which tools do you use?** lists the areas toil can connect to, from the server's own registry: GitHub, Jira, Azure DevOps, Bitbucket, Confluence and SonarQube first, the rest under **More tools**. A tool you already have a connection to says so.
|
|
80
|
+
4. **Link your tools** takes each ticked tool in turn with the same form as Settings, Connections: the settings in text boxes, and the login in a masked box that goes to toil's own `connections login` path and the OS credential store, as it does in Settings. The wizard never keeps it, and no AI agent, guide or suggestion ever sees it. The new connection starts with changes off (writes off in toil's words), and the screen says so. **Test the link** runs `toil connections test`.
|
|
81
|
+
5. **Your Toil project** creates one (`projects init`, an optional repository with `projects add-repo`, then `projects link` for each tool set up) or links the tools to one you already have. When Jira is among the tools, an optional **Jira project key** field goes with it: inside the create panel after the folders, or above the Link button when linking an existing Toil project. The key goes on the Jira link as `--set project=KEY`; what leaving it empty means is in an (i) tooltip (no Jira issues are read unless the Toil project already names a Jira project). For an existing Toil project the step reads `projects show` first: if it names a Jira project it shows "Reads Jira project PAY" (or "Reads a Jira project per repository") instead of a field, since typing over a key is refused without `--replace` and would drop the Jira link; if the read fails it shows no field.
|
|
82
|
+
6. **Let toil learn your Jira fields (optional)** is Settings' Find the fields. When the Toil project names no Jira project, it also saves the key it sampled from (`projects link <toil-project> jira --set project=KEY`, never `--replace`), says so before the press, and lists the result as "Jira project key". A per-repository map counts as naming one, and nothing is saved if the Toil project could not be read.
|
|
83
|
+
7. **All set** says what was set up and offers **Sync now**.
|
|
84
|
+
|
|
85
|
+
### The guide
|
|
86
|
+
|
|
87
|
+
Once an AI agent is ready (installed, its program found, and chosen here or in Settings), the Tools, Link, Toil project and Jira fields steps show a guide beside the step: two columns from 1000px wide, and below the step behind **Ask the guide**, closed, on a phone or tablet. Each step offers starter questions ("Which scopes does my token need?", "Where do I find my Jira site name?", "Cloud or Data Center?", "What is a Toil project?", "What does Sprint mean here?") and a question box labelled **Ask a question (never paste a token here)**. The chat is kept as you move between steps.
|
|
88
|
+
|
|
89
|
+
It is a guide, not an operator. The server gives it its own prompt (`ui/server/agents/guide.ts`) and three read tools: `docs_list` and `docs_read`, which read toil's own skill pages for the tools you chose (the pages the MCP server serves as resources, embedded in the server), and `connection_scopes`, which says what a tool's token needs. Once a Toil project exists it also gets toil's live reads for it; it needs no sync and no Toil project before then. What it is told is built on the server from three places and no others: the wizard's whitelisted state (the step, the tools ticked, the one being linked, a Cloud or Data Center choice and the address the form composed, with no login or query in it, and the Toil project's name), `connections list` run read-only (name, tool, address, writes, and its token state (saved, from an environment variable, missing, or not needed for a connection that takes no secret, such as a SQLite file), never a value), and the docs. A change it suggests comes back as a card with the command it would type and **Run this**, which runs it through the same config call the wizard's own buttons use, after the page checks it again; only `connections add` (with plain `--set` settings, no login), `projects init`, `projects add-repo` and `projects link` are offered a button. Its answers are not in the worklog, which is about work.
|
|
90
|
+
|
|
91
|
+
**No secret reaches it.** The connection form reports only what it would send as settings (a form's `submission`, which holds no secret by construction), and the wizard whitelists `deployment` and the address from them. A message is checked before it is sent, three times over, by the same function (`looksLikeSecret`, `ui/src/guide.ts`: toil's own `checkSecret()` paste check on the message, each word and each pair, the usual credential prefixes such as `ghp_`, `github_pat_`, `ATATT`, `glpat-`, `xox` and `AKIA`, a `Bearer` header, a JWT or private key, an address with a login in it, `password:` and `token=` with a value, and one long key-shaped word): in the panel, in the page's client, and at the server's route, which refuses it before it reads another field, and again in the host before the connection list, the agent, the usage ledger or the worklog is touched. A refused message is cleared, never kept, logged, audited or echoed, and the notice says: "That looks like a token. Type it in the masked box in the step instead; the guide never needs it." Nothing is stored in the browser: closing the tab ends the chat.
|
|
92
|
+
|
|
93
|
+
The wizard keeps its progress in the page only; it adds no config key. Connections it saved stay saved if you close the tab. Every change is one of the commands in the allowlist Settings uses, so each is in toil's audit log as `toil-ui`.
|
|
94
|
+
|
|
95
|
+
## The New Toil project wizard
|
|
96
|
+
|
|
97
|
+
`#/new-project` is a separate, short wizard for the one job of making a Toil project, so nobody who already has their tools set up lands on "Step 5 of 7" of the first run. It looks and behaves like the setup wizard (a "Step 2 of 4" line, Back, one primary button that stays disabled with a plain reason until the page is done, and a **Not now** on each optional page) and has no AI agent guide. The **New Toil project** buttons (the Toil projects page, Settings, the first-run checklist), the command palette's **Create a Toil project**, and the old addresses `#/setup/project` and `#/settings/projects/+new` (which are rewritten to it) all open it.
|
|
98
|
+
|
|
99
|
+
1. **Name it**: a name (lowercase letters, digits and single hyphens, not already taken) and an optional description.
|
|
100
|
+
2. **Where does it live? (optional)**: folders or repository addresses, or **Not now**.
|
|
101
|
+
3. **Which tools does it use?**: your existing tool links, each tool's main one ticked, one per tool, or **Not now**. When a Jira link is ticked, an optional **Jira project key** field sits under the first ticked Jira row, with what leaving it empty means in an (i) tooltip.
|
|
102
|
+
4. **Create it**: a summary and one **Create `<name>`** button, which runs `projects init`, `projects add-repo` for each folder, then `projects link` for each tool (the Jira link carrying `--set project=KEY` when a key was typed), never with `--shared`, and says what it is doing as it goes. A folder that fails does not undo the Toil project: it is listed with a **Retry**. Then **Open `<name>`**, and **Name your Jira fields** when Jira was linked. With changes turned off the button stays disabled and says so. The wizard keeps its place in the page only, as the setup wizard does.
|
|
103
|
+
|
|
79
104
|
## What it reads
|
|
80
105
|
|
|
81
106
|
Each dashboard reads its Toil project the way `toil projects show` describes it: the
|
|
@@ -103,6 +128,8 @@ in-process through `@imagile-dev/toil/api`, read-only, and toil's audit log
|
|
|
103
128
|
records it with `via: "api"` and `caller: "toil-ui"`. A call that fails shows on
|
|
104
129
|
its own panel with toil's message and fix.
|
|
105
130
|
|
|
131
|
+
For Jira, `jira issue fields` runs first (it asks Jira nothing) and lists the custom fields the connection registers. Each search then sends `moreFields`, never `fields`: toil adds them to the standard search fields and the connection's registered custom fields, so those come back whether or not the list could be read. `moreFields` names what `mapOwi` reads that search leaves out (`JIRA_OWI_FIELDS`: description, resolution, due date, original estimate, parent, sub-tasks and links), what a split by version, component, parent, link or date reads, and the field each of the Toil project's `fields` pointers, `dimensions` and classify field names, by id once the connection registers it (`jiraMoreFields`, `ui/src/load.ts`). Search returns a registered field under its name, so each issue gets every registered field's value copied back under its id (`withFieldIds`) before mapping; a Toil project's override by id, the sprint history and acceptance criteria all resolve. Because the search's input changed, the first sync after upgrading reads each Jira project in full once.
|
|
132
|
+
|
|
106
133
|
Jira and Azure DevOps are read for their open items plus anything changed within
|
|
107
134
|
the read window: the retention period, but at least 6 weeks (42 days), so the
|
|
108
135
|
longest view stays whole. A closed item older than that isn't read, and so isn't
|
|
@@ -110,9 +137,14 @@ in any view.
|
|
|
110
137
|
|
|
111
138
|
## Plain words
|
|
112
139
|
|
|
113
|
-
Screens read in everyday words
|
|
140
|
+
Screens always read in everyday words: a pull request is a **code review**, an agent an **AI agent**, with toil's own term in the hover. There is no switch. Anything a person reads to act (a menu item, tab, button, label, heading, an error and its fix) is plain English and identical in every theme; a theme speaks only in ledes and explanations, loading text, empty-state sentences and its moments (**Words** in `docs/themes.md`). Facts, numbers, commands and errors read the same everywhere. Themed wording is on by default and themed agent voice is off until chosen.
|
|
141
|
+
|
|
142
|
+
The tabs read **Summary**, **Board**, **What blocks what** (Dependencies), **Code reviews**, **People**, **Stand-up** and **What happened** (Worklog); Analyze is **Get a briefing**, on the Summary. A panel's source reads "From Jira and GitHub", with each tool and how many reads it took one step in. **Settings → Appearance** has a **Font** control: the theme's own type first, then pairings made only of fonts already bundled (`docs/themes.md`, **Fonts**). Quoted titles, the tracker's words and a briefing's own sentences are never reworded.
|
|
114
143
|
|
|
115
|
-
|
|
144
|
+
## Plain copy: no terminal in the words
|
|
145
|
+
|
|
146
|
+
- **Toil UI never shows a terminal command, an environment variable name or a file path as copy** (the maintainer's decision, 2026-11-09). Its readers are product owners and managers, not developers. So no "Runs `toil …`" line, no `TOIL_*` name, no config-file location, no `--flag`, no "Saves: area github, baseUrl …" summary; a login says **Saved on this computer** or **Set outside Toil UI, so it can't be changed here**. Errors and their fixes stay honest (principle 4) but are worded in plain English, and an error toil itself worded is kept as toil said it. Where a thing can only be done in a terminal, the screen says Toil UI can't do it yet, rather than quoting the command.
|
|
147
|
+
- **The one exception is an approval card:** a proposed change shown before a person presses Run ("Proposed change, not applied", the Board's proposals, the AI agent's setup suggestions, an install awaiting its press) shows what will run, because that is what the person is approving.
|
|
116
148
|
|
|
117
149
|
## The Toil projects view
|
|
118
150
|
|
|
@@ -125,9 +157,14 @@ filled, plus `projects list` and `projects show` for the Toil projects themselve
|
|
|
125
157
|
pull requests wait on a review; the people with work in it, as avatars; its sources
|
|
126
158
|
as badges; when it was last synced; and how many work items and pull requests
|
|
127
159
|
changed since this browser last opened its dashboard.
|
|
128
|
-
- **
|
|
160
|
+
- **Unknown is not zero (principle 12):** a Toil project that has never synced has
|
|
161
|
+
read nothing, so its counts show a dash (`–`, spoken as "not read yet") instead of
|
|
162
|
+
`0`, points nobody read say "no points read" instead of 0 of 0 (#652), and the sprint and "since you last looked" lines stay off until a sync has
|
|
163
|
+
read something. Once it has synced, a `0` is a real count.
|
|
164
|
+
- **Card order:** the Toil project opened most recently in this browser, or, before
|
|
129
165
|
any was opened, the one with the most in motion (in progress, blocked and waiting on
|
|
130
|
-
review together),
|
|
166
|
+
review together), comes first unless the person set an order with a card's **Move earlier** /
|
|
167
|
+
**Move later** (kept in this browser). Every card is the same size. On a wide screen the grid goes
|
|
131
168
|
wider than the dashboards and fits more cards across; at 375px it is one column.
|
|
132
169
|
- **What this browser remembers:** when each dashboard was last opened, in
|
|
133
170
|
`localStorage`, never sent anywhere. Without it (a private window) the cards just
|
|
@@ -135,6 +172,19 @@ filled, plus `projects list` and `projects show` for the Toil projects themselve
|
|
|
135
172
|
- **A Toil project's top row** uses the same parts: the description beside the name, the
|
|
136
173
|
sources as badges, and the sprint's day (The Toil project page, below).
|
|
137
174
|
|
|
175
|
+
### Archiving a Toil project (#561)
|
|
176
|
+
|
|
177
|
+
A card's quiet "more" menu holds Archive, and so does the command palette (type
|
|
178
|
+
"archive") and each of your own Toil projects under Settings, Toil projects. It runs
|
|
179
|
+
`toil projects archive <toilProject>` on the settings pages' path, so the file is
|
|
180
|
+
changed by toil and nothing is deleted. One line under the header says what happened
|
|
181
|
+
and has an Undo. The archived ones leave the list, the switcher and the sync figures,
|
|
182
|
+
and wait under a closed "Archived (n)" at the bottom of the page, each with Unarchive
|
|
183
|
+
(`toil projects unarchive`), which the palette offers too. The list reads them with
|
|
184
|
+
`toil projects list --archived`; if that fails the disclosure is not drawn, because
|
|
185
|
+
unknown is not none. The preview changes nothing, so it shows the sample's archived
|
|
186
|
+
project and no controls.
|
|
187
|
+
|
|
138
188
|
### Renaming and describing a Toil project
|
|
139
189
|
|
|
140
190
|
The name and the description have a pencil beside them, on the card and in the
|
|
@@ -145,6 +195,12 @@ its audit log as `caller: "toil-ui"`. Escape cancels, and a refusal shows toil's
|
|
|
145
195
|
message and fix under the field. Only a Toil project in your own folder can be renamed or
|
|
146
196
|
described; a checked-in one is refused with the `toil projects import` fix.
|
|
147
197
|
|
|
198
|
+
A card's menu has **Edit**, which opens a **Name** and **Description** form with one **Save**: it makes one `toil projects describe` call carrying only what changed. The top row keeps the pencil and the inline field.
|
|
199
|
+
|
|
200
|
+
### Editing a Toil project
|
|
201
|
+
|
|
202
|
+
Each of your own Toil projects has an edit page at `#/settings/projects/<name>/<section>`, reached from the card menu's **Edit** or **Edit sources**, from Settings, Toil projects, the command palette, or by its address. Its sections are grouped: **Sources** (repositories and the tools linked), **Field names** (with **Find the fields**, which reads a Jira project's custom fields), **People**, **Work in progress limit** and **How Analyze briefs**. Each saves through toil's own `projects` commands on the settings pages' path, so the write gate and the audit log apply as they do anywhere else, and a link to a connection with writes on is refused here as it is over MCP.
|
|
203
|
+
|
|
148
204
|
A rename keeps everything Toil UI holds for the Toil project: the server moves its cache
|
|
149
205
|
(responses, items, history, sources, sync runs, notes and agent runs), its assignments
|
|
150
206
|
and its worklog pages to the new name once toil has renamed the file, so its
|
|
@@ -153,23 +209,28 @@ message, while a sync or an assignment of that Toil project is running, since bo
|
|
|
153
209
|
by name as they go. What can't be moved is said beside toil's result, and the next
|
|
154
210
|
sync reads the Toil project afresh under its new name.
|
|
155
211
|
|
|
212
|
+
## Switching Toil projects
|
|
213
|
+
|
|
214
|
+
The app's header carries a project picker right after the brand, before the views, on every page and in every theme. Its button names the Toil project you are in (**All Toil projects** on a page that belongs to none); its menu lists **All Toil projects** and each Toil project, with the current one checked. Picking one keeps the tab you are on (Code reviews stays Code reviews), and a page that is not a tab lands on the project's Summary. It is the header's way to the Toil projects page (the header has no "Toil projects" link of its own, only Settings), so it is drawn whenever there is at least one Toil project; with none, the brand goes home. On a phone the same list is the first thing in the header's Menu.
|
|
215
|
+
|
|
156
216
|
## The Toil project page
|
|
157
217
|
|
|
158
218
|
A Toil project opens on its **Overview**, the briefing, in a frame all of its pages share:
|
|
159
219
|
|
|
160
|
-
- **The top row:** on the Overview,
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
- **The tabs**, one address each: **Overview** (`#/project/<name>`), **Board**
|
|
220
|
+
- **The top row:** on the Overview, an **Architecture** link (`#/project/<name>/summary/diagram`, which says **Draw its architecture** and leads to the job, `#/project/<name>/job/diagram`, until a diagram is kept) opens the Toil project's saved C4 diagram (The architecture diagram, below); the job's steps that need a folder on disk (`util size`, `git log`, `deps scan`) are reported unchecked. Its name; the sprint and its day; its description, cut to one
|
|
221
|
+
line with the whole of it in its tooltip, its sources and a quiet **Edit** link at the end of that line (on a phone, a **Details** button beside the name opens them, the link with them); and the Ask bar, with the
|
|
222
|
+
**AI agents** button beside it (The agent, below). Moving to another Toil project is the picker in the app's header, right after the brand, on every page (see below).
|
|
223
|
+
- **The tabs**, one address each, one tab and one page: **Overview** (the Summary, `#/project/<name>`), **Board**
|
|
165
224
|
(`/board`, with how many of its cards need attention), **Dependencies**
|
|
166
|
-
(`/dependencies`), **Pull requests** (`/prs`), **People** (`/people`), **
|
|
167
|
-
(`/
|
|
168
|
-
|
|
169
|
-
page sits under Board
|
|
225
|
+
(`/dependencies`), **Pull requests** (`/prs`), **People** (`/people`), **Stand-up**
|
|
226
|
+
(`/standup`) and **Worklog** (`/worklog`). A page does not open with a title that repeats its tab: the tab is the
|
|
227
|
+
title, the page is named by it, and what the page is sits in the (i) at the end of the tabs. The Command Center (`/command-center`)
|
|
228
|
+
is the Board tab's **Readiness** view, and an item's page sits under Board. The charts and the earlier briefings are no tabs: they
|
|
229
|
+
are steps in from the Summary (`/summary/<chart>`, `/summary/briefings`), each with a breadcrumb ("Summary › Work mix") back,
|
|
230
|
+
and the old `/charts`, `/charts/<chart>`, `/analyses` and `/analyses/<id>` addresses are rewritten to them, so every address from before still opens. On a
|
|
170
231
|
narrow screen the tabs scroll sideways; the Agents button sits beside the Ask bar at
|
|
171
|
-
every width (a compact **AI** with its count on a phone, still named "AI
|
|
172
|
-
- **The Agents panel**, closed by default at every width: one **Agents** button (**AI
|
|
232
|
+
every width (a compact **AI** with its count on a phone, still named "AI agents"), so the tabs get the whole row.
|
|
233
|
+
- **The Agents panel**, closed by default at every width: one **Agents** button (**AI agents** in plain words)
|
|
173
234
|
beside the Ask bar, counting what waits on you (the tracker's inbox, proposals to approve and
|
|
174
235
|
questions to answer, and any assignment or proposal that failed, since a closed panel must not hide a failure). From 1200px wide it opens the panel beside every tab, and remembers
|
|
175
236
|
whether you left it open (in `localStorage`); below that it opens a drawer. The palette's
|
|
@@ -179,13 +240,13 @@ A Toil project opens on its **Overview**, the briefing, in a frame all of its pa
|
|
|
179
240
|
Toil project's three newest analyses, each linking to it (Assigning work to an agent, below). Each card's title is its link; how many run at once, for how long, and what the inbox is are in the heading's (i), and the tracker's raw label (`agent:refine`) is in the Start dialog.
|
|
180
241
|
While an item's drawer is open (`?item=<id>`, The briefing, below), it takes the
|
|
181
242
|
sidebar's column from 1200px wide, and covers the view from the right below that.
|
|
182
|
-
- **
|
|
243
|
+
- **Earlier briefings** (`/summary/briefings`, linked as "Earlier briefings (N)" under the briefing on the Summary; the Past briefings tab is gone) lists every Analyze kept for the Toil project, newest first: when it was made,
|
|
183
244
|
the adapter and model that wrote it, its one-line recommendation, and what changed
|
|
184
245
|
since the one before (items newly blocked or blocked by something new, blockers
|
|
185
246
|
cleared, points moved on an item or in the sprint, items newly cited or no longer
|
|
186
247
|
cited, a new recommendation). What changed is worked out by code, from a snapshot of
|
|
187
248
|
the Toil project's items each analysis keeps, never by asking the agent. **Open** reads one
|
|
188
|
-
again at its own address (`/
|
|
249
|
+
again at its own address (`/summary/briefings/<id>`), top-down like the chat, with its
|
|
189
250
|
suggested changes and what it used. The server keeps them in the cache (Sync and the
|
|
190
251
|
cache, below), so they outlast a reload and a restart; with `--sample`,
|
|
191
252
|
card-payments starts with two, kept in memory for the run.
|
|
@@ -196,7 +257,7 @@ A Toil project opens on its briefing: one column to read top to bottom, each par
|
|
|
196
257
|
further in, and each step one you choose (#494). The tab's top is the answer (#552):
|
|
197
258
|
|
|
198
259
|
- **The status sentence**, the biggest text on the tab: a word with a shape (On
|
|
199
|
-
track, At risk, Behind, No sprint, or No
|
|
260
|
+
track, At risk, Behind, No sprint, or No points read when no points were read for any story in the sprint) and the rest of the sentence ("Behind: 18 of
|
|
200
261
|
21 points are left, and 3 working days remain."), with an (i). That it is an estimate is the first line of the fold; "Too early in the sprint to judge a pace" stays on the page. One rule
|
|
201
262
|
picks the word (`ui/src/model/status.ts`): On track when the points left fit at
|
|
202
263
|
the pace so far, At risk when at least 75% of them would land or a red reason holds
|
|
@@ -209,7 +270,7 @@ further in, and each step one you choose (#494). The tab's top is the answer (#5
|
|
|
209
270
|
stories not ready to start take the place of an empty one, and an all-clear card
|
|
210
271
|
says so when nothing needs anyone; if a read failed, that card says which reads could not be read instead of an all-clear. A card's title is its one link, opening the item in
|
|
211
272
|
its drawer (or its page, as Customize says), with the ticket key in small print.
|
|
212
|
-
- **Outside the fold, too:** one compact line for each red reason no card already tells (it opens the reason in the fold), and
|
|
273
|
+
- **Outside the fold, too:** one compact line for each red reason no card already tells (it opens the reason in the fold), and two lines for what could not be read: "Couldn't check" for a check that did not run, and "Partly checked" for one that ran but could not test some items.
|
|
213
274
|
- **Show the full briefing**, closed until you open it, and remembered in this
|
|
214
275
|
browser: everything below, with Customize. The source and sprint line, any problem
|
|
215
276
|
with the briefing, and **Go to** stay in view outside it.
|
|
@@ -229,7 +290,10 @@ further in, and each step one you choose (#494). The tab's top is the answer (#5
|
|
|
229
290
|
code flagged that Analyze didn't mention, so nothing drops off the page unsaid. An
|
|
230
291
|
id Analyze named that isn't the Toil project's is shown in red.
|
|
231
292
|
4. **The numbers**, folded: burn-up, throughput, cycle time, aging work in progress
|
|
232
|
-
and pull request wait, each opening its full chart.
|
|
293
|
+
and pull request wait, each opening its full chart. Points are counted only where
|
|
294
|
+
they were read (#652): a sprint figure with none read is a dash, one with some
|
|
295
|
+
read says how many items it leaves out, and a burn-up with none read is an empty
|
|
296
|
+
panel whose action is **Name the points field**.
|
|
233
297
|
5. **Go to:** every other view, as well as its tab.
|
|
234
298
|
|
|
235
299
|
A row, or any item link on the briefing, opens the item's **drawer** at the page's
|
|
@@ -268,7 +332,9 @@ while the page is open, never for the one already there when it opened.
|
|
|
268
332
|
### The Dependencies tab
|
|
269
333
|
|
|
270
334
|
The Dependencies tab opens on the **blocker timeline**, a Gantt chart of every item that
|
|
271
|
-
blocks another or is blocked, on the current sprint's dates, then the dependency graph.
|
|
335
|
+
blocks another or is blocked, on the current sprint's dates, then the dependency graph. Under the drawing one short line
|
|
336
|
+
gives the sprint's dates and says that blocked time is estimated (it stays on the page, because it qualifies every bar);
|
|
337
|
+
how each part is estimated, and which way the graph's arrows run, are in an (i) beside each panel's heading.
|
|
272
338
|
|
|
273
339
|
- **Each item is a bar.** A solid segment is its time in progress, from its
|
|
274
340
|
transitions. A hatched, outlined segment is its time blocked, from its `blocks`
|
|
@@ -281,7 +347,8 @@ blocks another or is blocked, on the current sprint's dates, then the dependency
|
|
|
281
347
|
- **Arrows join each blocker to what waits on it**, pointing at the item that waits.
|
|
282
348
|
A dashed arrow is a wait that is over: the blocker is done. A dotted line marks today.
|
|
283
349
|
- **The critical chain** is the chain of open blockers holding the most points (the
|
|
284
|
-
longest chain when nothing on any chain has points
|
|
350
|
+
longest chain when nothing on any chain has points, and it says how many of its items
|
|
351
|
+
had no points read). Its rows carry a diamond and
|
|
285
352
|
its arrows are drawn heavy, and it is named above the chart. The briefing's
|
|
286
353
|
**Blocked** reason names the same items.
|
|
287
354
|
- **What is estimated is said, in the chart's note and on each table cell.** No tracker
|
|
@@ -305,11 +372,101 @@ The Board tab flags each card that needs attention, with a flag beside its statu
|
|
|
305
372
|
an edge in the warning colour: anything that needs action now or a look (Insights,
|
|
306
373
|
below), but not what is only worth knowing. **Needs attention only** narrows the board
|
|
307
374
|
to those cards, and the tab carries how many there are. Drag a card to another column,
|
|
308
|
-
or press M on it for its menu, to
|
|
309
|
-
the command the proposal shows, and the card stays where its tracker says. Under the board are its
|
|
375
|
+
or press M on it for its menu, to move it (a card that can't be moved can't be dragged, and shows the reason: an area with no status command). What a drop does is under **Board moves**, below. Under the board are its
|
|
310
376
|
stories with their pull requests, builds and deployments, then the builds and
|
|
311
377
|
deployments themselves.
|
|
312
378
|
|
|
379
|
+
### Board moves
|
|
380
|
+
|
|
381
|
+
A drop is your own act, so by default it makes the move. **Settings, General, Apply board moves when I drop a card** (on until you
|
|
382
|
+
turn it off, kept in this browser) decides: with it on, the card is in its new column at once, marked *Moving…*, and the server asks toil
|
|
383
|
+
to change the status. The page sends the Toil project, the item's id and the column, and nothing else (`POST api/board/move`, `ui/server/board.ts`):
|
|
384
|
+
the server checks the Toil project, the connection and the item through toil's reads, then runs one command as you,
|
|
385
|
+
`caller: "toil-ui"`, through `execute()`, so toil's audit log records it: `jira issue transition --to <intent>` for Jira and
|
|
386
|
+
`ado work-item transition --to <intent>` for Azure DevOps, with the column's intent (To do is `reopen`, In progress `start`, Done `done`).
|
|
387
|
+
toil resolves the intent against that item's own workflow, and refuses, listing the moves the item offers, unless exactly one fits.
|
|
388
|
+
|
|
389
|
+
A GitHub card moves one of two ways, depending on whether the Toil project names a GitHub project (a board). **On a board**, the card's column is its
|
|
390
|
+
Status option, which toil reads as To do, In progress or Done by its own table of the usual names (Todo, Backlog, In Progress, Done and a few more).
|
|
391
|
+
The server finds the card on the board (`github project items`), reads the project's Status options (`github project fields`), keeps the ones that
|
|
392
|
+
read as the column you dropped on, and, when exactly one does, runs `github project status --item <id> --to <option>`; with none or several it
|
|
393
|
+
proposes the move and names the options, because nothing here picks one for you. A pull request on the board moves the same way. A closed issue
|
|
394
|
+
stays in Done whatever its Status says, and GitHub's own project workflow closes an issue moved to Done, so dropping a closed issue on To do or In progress
|
|
395
|
+
does both steps: `github issue reopen`, then `github project status` (the Status option is chosen first, so nothing is reopened when it can't be),
|
|
396
|
+
and says "Reopened and moved". If the reopen works and the Status change doesn't, the message says exactly that. A move to Done says GitHub may close the
|
|
397
|
+
issue. Undo after a move to Done is just the reverse move. A closed pull request is not reopened by a drop: it stays blocked, with its reason.
|
|
398
|
+
**With no board**, a GitHub issue is open or closed: Done runs `github issue close`, and Done back to To do runs `github issue reopen`. The owner,
|
|
399
|
+
repository and number come from the card's own id, never from the page.
|
|
400
|
+
|
|
401
|
+
**When a GitHub card can't move, the screen says which of these it is, and what to do** (it was once one vague line, which left people guessing):
|
|
402
|
+
|
|
403
|
+
1. **The Toil project names no project board.** "GitHub issues are only open or closed, so In progress needs a project board. This Toil project
|
|
404
|
+
doesn't name one." The page knows this from what it loaded (`githubBoards`), so while a card is dragged the In progress column says
|
|
405
|
+
*Needs a project board to go here* (and the announcement says it), and a drop there is not sent anywhere. The next step is a link to the Toil
|
|
406
|
+
project's Sources, and, a step further in under **Show the command**, `toil projects link <name> github --add projects=<number>` with the number
|
|
407
|
+
left for you (the board is created on GitHub first). A pull request with no board says the same about itself.
|
|
408
|
+
2. **It names a board, but this issue isn't on it.** A proposal: "<key> isn't on the project board <title> (project N). Add it there, then move it."
|
|
409
|
+
with a link to the board on GitHub when toil could read its address (`github project list`), and, when the connection allows changes and exactly
|
|
410
|
+
one Status option reads as the column, **Add to the board and move**. That press is one call (`addToBoard`, the only thing a page may add to a
|
|
411
|
+
move, so a plain drop never adds anything): the server adds the issue (`github project add`), then sets the Status through the item id the add
|
|
412
|
+
returned (`github project status --item`), each its own gated write, after every refusal has been made. If the add works and the move doesn't, the
|
|
413
|
+
message says exactly that: it is on the board now. Under **Show the command**, the two commands in that order, by number. The button isn't offered
|
|
414
|
+
when the board belongs to another owner than the issue's, several boards are named, or no single option fits; the card says why.
|
|
415
|
+
3. **The board couldn't be read** (the token lacks the Projects permission, or the read failed). The notice says so in toil's own words, with its fix
|
|
416
|
+
and a link to the connection: never "isn't on the board", because a board nobody read says nothing about what is on it.
|
|
417
|
+
4. **On the board, but no single Status option maps to the column.** A proposal naming the options.
|
|
418
|
+
5. **A closed pull request dragged out of Done**, and a pull request with no board: a notice with what is wrong and the next step.
|
|
419
|
+
|
|
420
|
+
A move **no command could make** (cases 1 and 3, and these) is not a proposal: the card goes back to its column, no ghost is left in the target
|
|
421
|
+
column, and one notice (not a "proposed move" with nothing to apply) says what's wrong and what to do, until you dismiss it.
|
|
422
|
+
The connection's `writes` setting still decides, as it would typed by hand; a Toil project's connection you haven't adopted is refused by toil
|
|
423
|
+
(`WRITE_DISABLED`) and the page says so in toil's words.
|
|
424
|
+
|
|
425
|
+
On success a line says **Moved PAY-102 to In progress** (with the transition toil chose), with **Undo**, which makes the reverse move the same way.
|
|
426
|
+
If toil refuses or fails, the card goes back to its column and the message, toil's own with its fix, stays above the board until you dismiss it. A write
|
|
427
|
+
that timed out may still have been applied, and the message says to check the tracker.
|
|
428
|
+
|
|
429
|
+
When the move can't be made for you, nothing changes in the tracker and the drop becomes a **proposed move** under the board (the card stays where
|
|
430
|
+
its tracker says, with a dashed ghost in the target column that says only "Not applied yet." beside **Undo** and **How to apply**; in the sample it says "Sample data: this move isn't saved." with **Undo** alone, since nobody can apply a move there). The card says what would change, **one line on why it wasn't applied**, an **Apply**
|
|
431
|
+
button (**Add to the board and move**, for a card off its board) when a press can make it (the setting is off but the connection allows changes), and **Dismiss**; the command to run yourself, in PowerShell or
|
|
432
|
+
bash/zsh with **Copy command**, is a step further in under **Show the command**. Why it can be a proposal: the setting is off; the sample, which can
|
|
433
|
+
show a move and write none; a connection with `writes` off (the card says so and where to turn them on); a status that more than one transition
|
|
434
|
+
leads to, or none (toil's refusal, with the moves the workflow offers, is on the card: nothing is guessed); a card Toil UI can't move; a GitHub
|
|
435
|
+
project whose Status options give the column none or more than one (the card names them); a card that isn't on its board (with the two commands
|
|
436
|
+
that put it there and move it); a draft on a board, which has no issue to name; and a view with no server to ask. Nothing that has no command
|
|
437
|
+
at all is proposed: those are the notices above.
|
|
438
|
+
A drop in the column the card is already in, or onto another lane when the board is grouped, does nothing.
|
|
439
|
+
|
|
440
|
+
The board and **Ready to start?** share the charts' filter bar (without its period), so "Fix version: 2.4, Category: Keep
|
|
441
|
+
the lights on" narrows the cards, each column's count, the lanes and the tables under the board; the Unsure share on Work mix
|
|
442
|
+
opens the board filtered to the items nobody has categorised (`?category=none`). The filters live in the address and carry from one
|
|
443
|
+
board view to the other. **Group by** turns the board into swimlanes (`?group=parent:Epic`): one lane per value of the chosen
|
|
444
|
+
dimension over the same status columns, the epic first in the menu, then fix version, team, category, component, assignee and
|
|
445
|
+
sprint. The four biggest lanes show, the rest fold into **Other** until **Show all lanes** opens them, and the lane with no
|
|
446
|
+
value (No epic) comes last; people and squads are never folded and run in name order. Each lane has its count, the mix of its
|
|
447
|
+
categories as one bar, and a button that folds it; each keeps the column limits ("Show N more"). A card that holds several
|
|
448
|
+
values (two components) is in each lane. A lane is for looking, not for moving: dragging a card to another lane changes
|
|
449
|
+
nothing, and says so. A dimension the read never fetched is listed in the menu as "not read yet".
|
|
450
|
+
|
|
451
|
+
Each card shows its category as a small chip beside the status when it has one (an Unsure item shows none, to keep cards
|
|
452
|
+
quiet); hovering it gives the short form ("KTLO"), the definition and how it was decided. The same chip is in the item's header
|
|
453
|
+
and in the item drawer, display-only for now.
|
|
454
|
+
|
|
455
|
+
### Splitting the numbers
|
|
456
|
+
|
|
457
|
+
Three of the Summary's numbers can be split. In the full briefing's numbers, **Finished**, **Time to finish** and **Work getting
|
|
458
|
+
old** open a chart, and **Split by** cuts it by category, component, team, fix version or the epic: Finished as stacked columns
|
|
459
|
+
by week, Time to finish as a median with its 85th percentile for each value, Work getting old as the median and the 85th percentile
|
|
460
|
+
side by side. Unsplit, each chart is what it always was. Each segment opens the items behind it, and **Open the full chart** carries the
|
|
461
|
+
same split to Explore. A split by team is in name order, never sorted by speed.
|
|
462
|
+
### The architecture diagram
|
|
463
|
+
|
|
464
|
+
`#/project/<name>/summary/diagram`, and `/<view>` for one of its views, draws the Toil project's architecture as a C4 diagram. It is a page one step in from the Summary, not a tab: the breadcrumb at its top (Summary › Architecture) leads back, and the Summary's **Go to** row, the Architecture link in the top row and the command palette's **Architecture diagram of <Toil project>** lead in. It reads the diagram live from toil (`toil projects diagram show`, the file `~/.toil/diagrams/<name>.json`; the cache never holds one) and draws it with toil's own layout as SVG, with no drawing library. The views are one switch, each with its own address.
|
|
465
|
+
|
|
466
|
+
How sure the diagram is stays on the screen: an inferred box has a dashed outline and an inferred arrow is dotted, a legend counts what is observed and inferred (and not said, when anything is), with its explanation in an (i), and a line under the picture says when it was saved and its revision; where it is kept (the file, with Copy) and what was left out on purpose are one step in. The picture does not repeat the page's heading, fits the width it has (up to one and a half times its size, centred, and scrolling inside its own region on a narrow screen), and when toil's own layout check finds an arrow behind a box or a label over one, a line says so. What a box or an arrow was read from (or why it is believed) is one press in: boxes and arrows take the keyboard (Enter or Space), and the detail opens beside the picture, or below it on a narrow screen, as plain text, since a diagram holds no address. **List** says the same in text for a screen reader. A view past 100 boxes or 250 arrows (toil's own drawing limits) is not drawn, and the page says so. With no diagram the page offers **Draw its architecture**; a toil too old to have the command is told to update.
|
|
467
|
+
|
|
468
|
+
The **Diagram** job (`#/project/<name>/job/diagram`) ends in a **Save diagram** press, never in Mermaid pasted into the answer. The agent builds the model from what its tools return, marking each element and relationship observed (with its source) or inferred (with its reason), and checks it with `projects diagram check` until it passes. Toil UI keeps the model from the last check that passed, exactly as toil checked it, and the answer ends in a card with its counts and **Save diagram** (**Replace the saved diagram** when one is kept), which runs `toil projects diagram save` on the settings pages' path: a local write to your own folder, with no `--allow-write`, pressed by you. An answer whose run never passed a check says so and has nothing to save. With `--sample` nothing is saved: the card says so and links the sample's own diagram.
|
|
469
|
+
|
|
313
470
|
## Insights
|
|
314
471
|
|
|
315
472
|
The board's cards and its **Needs attention** flag and the flow charts mark
|
|
@@ -333,6 +490,24 @@ and the item view lists them all.
|
|
|
333
490
|
| No estimate | It has no estimate | worth knowing |
|
|
334
491
|
| Added mid-sprint | It joined the sprint after it started | worth knowing |
|
|
335
492
|
|
|
493
|
+
## Tables and rows
|
|
494
|
+
|
|
495
|
+
The pattern every table follows (`DataTable` in `src/components/layout.tsx`; the Waiting now table is the model):
|
|
496
|
+
|
|
497
|
+
- **Actions get their own column,** the narrow last one (`actions: true` on the column): a quiet icon button that opens a menu, named for its row (`aria-label="Actions for …"`). Never a bordered text button under each row's title.
|
|
498
|
+
- **One idea a cell.** A name and one badge, a state and one figure. Figures are compact (`32.6 d`, `326 · 8 files`); the sentence behind one is a `<details className="cell-more">` one press in. Nothing is dropped, only layered (principle 11); errors, source and verification stay on screen.
|
|
499
|
+
- **Numbers as small visuals where they have a shape:** a diff-style bar of five squares for additions and deletions, never colour alone (a stripe pattern and the numbers beside it), as one `role="img"` whose `aria-label` carries every figure. An unknown figure is a dash, not zero (principle 12).
|
|
500
|
+
- **Gutters:** every cell has room on its right (`1.5rem` in the queue), the actions column none, and stacked rows (under about 28rem) drop to label and value pairs. Check at 375, 768 and 1440px in Plain, Crate and Harvest.
|
|
501
|
+
|
|
502
|
+
## Forms and rows of controls
|
|
503
|
+
|
|
504
|
+
A label with its control is one row, and rows stacked in a card line up (the Settings, Theme card is the model, `.panel > .choice` in `src/views.css`):
|
|
505
|
+
|
|
506
|
+
- **One label column, one control width.** Stacked rows share a label column wide enough for the longest label and give their controls the same width, so the controls start at the same left edge and end at the same right one. Never let each row size itself to its own label.
|
|
507
|
+
- **A control that is a link is still a button.** A link that looks like one takes `btn`, which gives it the frame a `<button>` gets (`.btn:where(a)`); don't style a bare anchor and hope.
|
|
508
|
+
- **Narrow:** under about 30rem a row is the label above its control, full width.
|
|
509
|
+
- **Look at it, don't reason about it.** Screenshot every new or changed form at 375 and 1440px in Plain, Crate and Harvest; ragged edges, text with no frame and controls that don't line up don't show up in tests.
|
|
510
|
+
|
|
336
511
|
## Pull requests
|
|
337
512
|
|
|
338
513
|
Each Toil project has a **Pull requests** tab (`#/project/<name>/prs`), built from OWI 0.2
|
|
@@ -340,8 +515,9 @@ changes:
|
|
|
340
515
|
|
|
341
516
|
- **Waiting now:** the open pull requests, longest wait first, each with what it
|
|
342
517
|
waits on (review, changes, checks, merge, or a draft its author holds), since when
|
|
343
|
-
in working days
|
|
344
|
-
|
|
518
|
+
in working days (`32.6 d`, the sentence behind it one press in), who wrote it (the name, and an Agent or Bot badge that opens the signal that said so), the work items it names, and its size, XS to XL by changed lines.
|
|
519
|
+
- **Each panel's explanation** (what Waiting now sorts by, what a flag is, what the flow figures rest on, where suggestions come from)
|
|
520
|
+
is an (i) beside its heading; what qualifies a figure, such as the weeks it covers and what n counts, stays on the page.
|
|
345
521
|
- **Flags:** no first review in 2 working days, checks failing for over a day, a merge
|
|
346
522
|
conflict, no linked work item, a work item done while its pull request is open, and
|
|
347
523
|
a merged pull request whose item isn't done, each with what it rests on.
|
|
@@ -349,7 +525,7 @@ changes:
|
|
|
349
525
|
merge (approval to merge) times, review rounds, sizes and merges per week, over six
|
|
350
526
|
weeks, each split by people, agents and bots and each with its sample size and what
|
|
351
527
|
couldn't be measured.
|
|
352
|
-
- **Actions:** each open pull request has one **Actions** menu with **Review** (reads the pull request, its diff and checks, and drafts findings as comments you can post) and **Ship** (on a pull request a person wrote: drafts replies to its review; editing, the gate and pushing stay in your terminal). Each opens its own page, `#/project/<name>/job/review?target=<change id>` or `/job/ship?…`, which says what the job does and needs and has **Run**. The run goes through the Ask bar, so every write is a proposal card and the run is kept in the worklog. A job missing its code host's connection stays in the menu, dimmed, naming the connection to add. Ship stops after 3 finished rounds on one pull request; the next run is refused and says it needs a person (`needs-human`). The steps come from toil's workflow pages (`skills/toil/workflows/`).
|
|
528
|
+
- **Actions:** each open pull request has one **Actions** menu, a quiet `…` icon button in its own narrow last column (named `Actions for <repo> #<n>`; stacked rows put it at the row's top corner), with **Review** (reads the pull request, its diff and checks, and drafts findings as comments you can post) and **Ship** (on a pull request a person wrote: drafts replies to its review; editing, the gate and pushing stay in your terminal). Each opens its own page, `#/project/<name>/job/review?target=<change id>` or `/job/ship?…`, which says what the job does and needs and has **Run**. The run goes through the Ask bar, so every write is a proposal card and the run is kept in the worklog. A job missing its code host's connection stays in the menu, dimmed, naming the connection to add. Ship stops after 3 finished rounds on one pull request; the next run is refused and says it needs a person (`needs-human`). The steps come from toil's workflow pages (`skills/toil/workflows/`).
|
|
353
529
|
- **Suggested reviewers:** for an open pull request with nobody asked, the CODEOWNERS
|
|
354
530
|
of its paths and the earlier reviewers of the same files and folders, each as a
|
|
355
531
|
proposal with the `toil … --allow-write` line to ask them.
|
|
@@ -369,8 +545,13 @@ system (`toil projects person`, or **Settings, Toil projects**):
|
|
|
369
545
|
- **A card per person**, agents included, in name order: their work in progress by
|
|
370
546
|
status with how long each item has sat in it, their open pull requests and what
|
|
371
547
|
each waits on, the reviews waiting on them (oldest first), their blocked items and
|
|
372
|
-
what blocks each, and what they did in the last 14 days
|
|
373
|
-
|
|
548
|
+
what blocks each, and what they did in the last 14 days (three lines, then a **+N**
|
|
549
|
+
that opens the rest). A section shows only when it has something: the empty ones
|
|
550
|
+
are one muted line at the foot of the card naming them after a dash (`– Blocked · Reviews waiting`),
|
|
551
|
+
read aloud as "none", or "not read yet" for a part no sync read (a failed read, or no pull
|
|
552
|
+
requests read at all), shown apart from the others. The accounts behind a name are in the (i)
|
|
553
|
+
beside it. **On the board** opens their items on the Board tab, filtered to them.
|
|
554
|
+
The page's first line is the counts and the read time; what work in progress counts is in the tab's (i).
|
|
374
555
|
- **A team strip:** work in progress against the Toil project's `wipLimit` and who is over
|
|
375
556
|
it, the review queue, and the current sprint's unassigned items.
|
|
376
557
|
- **Agents:** a person with `kind: "agent"`, matched by the same signals as a pull
|
|
@@ -382,11 +563,121 @@ system (`toil projects person`, or **Settings, Toil projects**):
|
|
|
382
563
|
it; it is applied only when someone presses the button, and an email that fits more
|
|
383
564
|
than one candidate suggests nothing and says why. Accounts that only wrote bots'
|
|
384
565
|
pull requests are left out and counted.
|
|
566
|
+
- **Map** (#561) is on each such card: it opens a form in place to choose an existing
|
|
567
|
+
person or add a new one (a person or an agent), with a field for the identity in each
|
|
568
|
+
source the Toil project uses (GitHub, Jira, Azure DevOps, Bitbucket), the account's own
|
|
569
|
+
prefilled and a likely person from toil's matcher (`src/core/people-match.ts`) as the
|
|
570
|
+
starting choice. Save runs `toil projects person` through the same config path as
|
|
571
|
+
Settings; nothing is applied until it is pressed. **Save to this repository** (beside
|
|
572
|
+
the people, in the Map form once it has saved, and in Settings) runs `toil projects
|
|
573
|
+
people save`, which writes the people into the repository's `.toil/projects/<name>.json`
|
|
574
|
+
for any host (GitHub, Azure DevOps, Bitbucket); the (i) beside the button says which file changes, and
|
|
575
|
+
nothing is staged or committed.
|
|
385
576
|
|
|
386
577
|
It shows what is on each plate and never scores anyone: no ranking, no productivity
|
|
387
578
|
figure, no person-to-person comparison and no line or commit counts. Flow metrics
|
|
388
579
|
stay team-level, in the pull requests view.
|
|
389
580
|
|
|
581
|
+
### The mix of open work
|
|
582
|
+
|
|
583
|
+
Each card carries one bar: the mix of that person's open work, by category to start. It is one bar with no score, no percentage
|
|
584
|
+
beside the person and no ordering of people by it; cards stay in name order. One menu above the cards, "Show each person's work
|
|
585
|
+
by", changes the dimension for all of them (category, fix version, the epic or component); it is in the address
|
|
586
|
+
(`?mix=release`). Hovering a segment names the value and its count, and pressing it opens those items. A person with no open
|
|
587
|
+
work has no bar, and a dimension the read never fetched is a dash. When people have a team in the Toil project's `people`, the
|
|
588
|
+
cards sit under their team's heading, teams and people both in name order, with the team's headcount and work in progress.
|
|
589
|
+
|
|
590
|
+
## Charts
|
|
591
|
+
|
|
592
|
+
There is no Charts tab. The Summary carries **Where the work goes**: three items, **Work mix**, **Where we're working** and **Flow**, each its dashboard's own headline sentence and one small chart, the title a link to the full page (`/summary/mix`, `/summary/where`, `/summary/flow`). The Summary has no controls: splitting and filtering happen on the full page. An item whose data was not read is a dash with its reason, never 0. Six dashboards exist: those three, then **Releases** (`/summary/releases`), **Sprints** (`/summary/sprints`) and **Explore** (`/summary/explore`), which the Summary does not offer and which are reached by their own addresses, by typing their name in the command palette, and from the split dialogs' **Open the full chart**. Views your team saved open from the palette by name too. Every dashboard is a module in `ui/src/views/charts/`
|
|
593
|
+
that exports an `id`, a `title`, a `headline` and a `View`, and is added to one list, so a new one changes no other file.
|
|
594
|
+
|
|
595
|
+
Every figure comes from toil's pure pivot model (`src/core/insights/`), the same one `toil projects pivot` and the agent
|
|
596
|
+
use, so a number on a chart is the number an agent reads. Every chart says where its items came from and how far back, and
|
|
597
|
+
lists what it left out; "Show the figures" shows it as a table.
|
|
598
|
+
|
|
599
|
+
- **The filter bar** holds the period (this sprint, the last 30 or 90 days, this quarter, or two dates you pick) and any
|
|
600
|
+
filters, as chips. Add filter offers every dimension the data holds and then its values; a dimension nobody read is listed
|
|
601
|
+
as "not read yet". It lives in the address (`?release=2.4&category=ktlo&from=2026-09-14`), so Back undoes a chip and a copied link
|
|
602
|
+
shows the same chart. Opening or closing an item's drawer keeps it.
|
|
603
|
+
- **Every number is a door.** Clicking a segment, a figure on a release or a sentence about what changed opens a drawer that
|
|
604
|
+
lists the items behind it as a table you can sort, each row opening the item. The address says how to find the list
|
|
605
|
+
(`?items=`), not which items, so it stays short. Shift-click adds the segment as a filter.
|
|
606
|
+
- **The team is measured, never the person.** A split by assignee or team is in name order and never sorted by size.
|
|
607
|
+
- **Every chart has a menu** (the ☰ beside its title): **Ask about this chart** opens Ask with the chart's figures attached, **Copy for AI** puts the same figures on the clipboard as Markdown for any assistant, and **Export the figures** downloads them as a CSV file. The download is made by the browser, so it works in the preview too and writes nothing through Toil UI's server. Under each chart sit one or two suggested questions that open Ask with the question filled in. Dates in a chart's notes read as "16 Jul", never as ISO days.
|
|
608
|
+
|
|
609
|
+
### Work mix
|
|
610
|
+
|
|
611
|
+
Of the work that was finished in the period, how much was each category, as a trend by month. Split it by any dimension (it
|
|
612
|
+
becomes the category shares for each value), and count items, estimates or days in progress. Beside the chart it says how the
|
|
613
|
+
categories were decided (rules, labels on the items, your AI agent, people) and how much is still Unsure, which links to the Board.
|
|
614
|
+
A category reads as its plain name, "Keep the lights on"; its short form and definition are on hover. The Summary's **Work
|
|
615
|
+
mix** tile, in the numbers, shows the same mix for the last 90 days and opens this page.
|
|
616
|
+
|
|
617
|
+
### Releases
|
|
618
|
+
|
|
619
|
+
One section per release that is not out yet, and the latest one that is: how much is in it, how much is done, what was added
|
|
620
|
+
since it started, what is open past its date, and a burn-up toward its date with the scope line. "Added since it started" needs
|
|
621
|
+
the release's start date from the tracker; without one it is a dash that says so, never 0. The burn-up has "Done" and "Scope" in its legend and a thin rule at the due date.
|
|
622
|
+
|
|
623
|
+
### Sprints
|
|
624
|
+
|
|
625
|
+
Velocity first: "Done per sprint: 18 to 25 items over the last five sprints (median 20)", with points when estimates were read. The chart stacks each sprint's done work as committed (in the sprint when it started) and added (joined after it started), with what was carried over to a later sprint and what was not done. **Split by** switches the columns to category (work mix per sprint), planned or unplanned, or team. One line per sprint beneath says what happened to it, each figure a door. Committed and added need each item's sprint history; without it they are dashes.
|
|
626
|
+
|
|
627
|
+
### Where we're working
|
|
628
|
+
|
|
629
|
+
A heatmap of days in progress for each epic (or component, fix version, team, label family) by week, each row's category mix beside it, and two figures that open their items: how many epics had work this week against last, and the share of items with no epic above them. Without status history there are no days to count, so it says that and offers the sync, never a table of zeros.
|
|
630
|
+
|
|
631
|
+
### Flow
|
|
632
|
+
|
|
633
|
+
How many finish a week and how long they took, then throughput by any split; folded beneath are a cumulative flow diagram, cycle time with its 85th percentile, and the age of work in progress (each bar opens its items). A cumulative flow diagram and cycle time need status history.
|
|
634
|
+
|
|
635
|
+
### Explore
|
|
636
|
+
|
|
637
|
+
Pick a measure, a split, an across and filters; the chart's form follows the data (columns over time, stacked bars, a heatmap for two wide dimensions, one bar per value with no across), with small multiples when a split has more than four values. The whole view is in the address, so a link shows the same chart. The Split and Across menus offer every dimension the data holds, including the parent levels it has, label families (a prefix three labels share) and the fields your Toil project names, greyed "not read yet" when unread. **Save this view** keeps the view in the Toil project (`projects view set`, the same local write the Settings pages make, with the name and title you type); a saved view opens from the command palette by its name. In the preview, which changes nothing, the button says so. Removing a saved view is a delete and stays on the command line.
|
|
638
|
+
|
|
639
|
+
## Sort work into categories
|
|
640
|
+
|
|
641
|
+
The Board's third view, beside **Board** and **Ready to start?** (`#/project/<name>/board/classify`). It lists the items that need
|
|
642
|
+
a person: the **unsure** ones, and the ones where a rule or a signal and a label or field already on the item disagree. Each item is one line: its source, key and
|
|
643
|
+
title (cut short, whole on hover), the choices as one segmented control ("Keep the lights on", "Feature", "Unsure"), and a quiet (i) with
|
|
644
|
+
the reason it is here ("Its parent SHOP-12 is Feature"). The reason is never printed on every row; a short tag shows only where it says
|
|
645
|
+
something ("14 follow" on an epic whose tasks follow its answer, "label and rules disagree"). **Pressing a choice is the answer**, with no
|
|
646
|
+
Confirm: **K**, **F** and **U** answer on a row (**1** to **9** for any other scheme), the arrow keys move between rows, and focus stays on
|
|
647
|
+
the next row. A suggestion (the AI agent's, or the rules' where they disagree with a label) is marked on its category with a small badge:
|
|
648
|
+
pressing the marked one accepts it (so does **Enter** on the row), pressing another overrules it. Pressing a category chip anywhere else (an item's page, its drawer, a row in an items drawer) opens the same choice in
|
|
649
|
+
a small form with an optional reason; a board card's ☰ menu has **Change its category…**.
|
|
650
|
+
|
|
651
|
+
- **A choice is saved in your own record on this computer** (`toil classify correct`), at once, and never touches the tracker. Choosing the
|
|
652
|
+
category an item already has is saved too, as agreement. A line under the tabs says what changed ("SHOP-6 is Feature. Undo") and **Undo** records the item
|
|
653
|
+
back where it stood ("Changed back") and puts an unanswered item back in the list: the record only ever adds.
|
|
654
|
+
- **Ask your AI agent** gives the agent toil's own question for the unsure items, with no tool to change anything. Its answers come
|
|
655
|
+
back as marks on the choices, each with an AI badge and its reason in the row's (i) (with **Not this** to dismiss it), and you accept them one at a time
|
|
656
|
+
or all at once. Every answer is checked against
|
|
657
|
+
the scheme before it is shown. Accepting one is your word, saved in your own record exactly as a choice is (with "Accepted the AI agent's
|
|
658
|
+
suggestion" and the agent's reason as the reason, and the same **Undo**), so the item stays answered after you apply it, and **Accept all**
|
|
659
|
+
saves one per suggestion.
|
|
660
|
+
- **Apply** gathers what is decided into one card per tracker connection and shows every change first, as a table a line an item (item, title, category, and the label and field from and to, folded after ten with
|
|
661
|
+
**Show all**), with the one command toil runs. One press runs the tracker's own `categorize` through toil's write rules, so the connection
|
|
662
|
+
must have changes switched on; the card says when it doesn't. Each item's result is reported, and pressing again changes nothing. Then the verdicts
|
|
663
|
+
are recorded. In the sample nothing can be written, and the card says so.
|
|
664
|
+
|
|
665
|
+
### How it's doing
|
|
666
|
+
|
|
667
|
+
Folded at the top of the view: how often people agreed with the answers they checked, which source they overrule most ("a label such as security
|
|
668
|
+
or dependencies was overruled 3 of 8 times, all to Feature"), and how many corrections have come in since the categories were last improved. A
|
|
669
|
+
figure nobody has read yet is a dash, "not read yet", never 0%. With ten corrections or more, **Improve with your AI agent** asks your agent for a
|
|
670
|
+
sharper version of the categories from your corrections, tries it on corrections it was not shown, and lists what would change beside the score before
|
|
671
|
+
and after. A version that scores worse is shown as worse. **Use this version** saves it as a new revision, which is a person's decision and only a press.
|
|
672
|
+
|
|
673
|
+
### The Classification editor
|
|
674
|
+
|
|
675
|
+
On a Toil project's edit page, **Classification** shows which categories the Toil project sorts by ("Keep the lights on / Feature, 2 rules, signals on,
|
|
676
|
+
revision 3", kept as your own copy, shared in the repository, or built in) and opens into steps: pick other categories and the field each tracker keeps
|
|
677
|
+
the category in, and edit the categories themselves: names, definitions, labels, guidance, examples, rules and the built-in signals. Each rule says how many of
|
|
678
|
+
the items already read it would catch. Save stays off until toil's own check accepts the draft, with each problem named where it is; saving makes a new
|
|
679
|
+
revision, and a built-in scheme is saved as your own copy.
|
|
680
|
+
|
|
390
681
|
## Readiness and the Command Center
|
|
391
682
|
|
|
392
683
|
Before a work item goes to an agent, Toil UI checks whether it is ready for one. The
|
|
@@ -442,22 +733,25 @@ A page has:
|
|
|
442
733
|
|
|
443
734
|
- **Work items** that changed status (from, to, who and when), were added to or
|
|
444
735
|
dropped from a sprint, got a new blocker or had one cleared, and each sprint that
|
|
445
|
-
ended, with how many of its items and points were done
|
|
736
|
+
ended, with how many of its items and points were done (and how many had no points
|
|
737
|
+
read; with none read, the points are left out).
|
|
446
738
|
- **Pull requests** opened, reviewed (approved, changes requested, commented), merged
|
|
447
739
|
or declined.
|
|
448
740
|
- **Builds and deployments** that failed or recovered (deployments from OpenShift,
|
|
449
741
|
whose state a sync can see change): a build is recovered when a
|
|
450
742
|
passing run follows a failing one of the same pull request or pipeline.
|
|
451
743
|
- **Agent runs:** each question an agent adapter answers in the chat, when it
|
|
452
|
-
started and ended,
|
|
453
|
-
|
|
454
|
-
cited, and its proposals, each
|
|
455
|
-
with whether toil's audit log (`toil audit list`) shows a person ran that write on
|
|
744
|
+
started and ended, whether it finished, failed or was stopped, what it cited,
|
|
745
|
+
and its proposals, each with whether toil's audit log (`toil audit list`) shows a person ran that write on
|
|
456
746
|
the same item afterwards. Each run's transcript is kept beside the pages and shown
|
|
457
747
|
under the run, labelled as the agent's.
|
|
458
748
|
- **Notes** a person added that day, on today's page.
|
|
459
749
|
- **Sources:** each source's syncs that day.
|
|
460
750
|
|
|
751
|
+
A section with nothing in it is not drawn: the empty ones are one muted line naming them after a dash, read
|
|
752
|
+
aloud as "none", or "not read yet" (with **Sync now**) for a section a sync decides on a day none has read.
|
|
753
|
+
The calendar's footnote and what Export does are in an (i) beside the month and the Export heading.
|
|
754
|
+
|
|
461
755
|
Every line links to its item, pull request, build or transcript, where the source has a
|
|
462
756
|
page for it. Two kinds of fact
|
|
463
757
|
come in differently. Status and sprint changes, pull requests, reviews and builds
|
|
@@ -492,38 +786,28 @@ folder as its workspace, which writes a new file only and never into toil's own
|
|
|
492
786
|
config. Publishing an exported page is a proposal: `toil confluence page create
|
|
493
787
|
--body-file <file> --markdown` in the Toil project's Confluence space, or `toil github issue
|
|
494
788
|
create --body-file <file>` in its repository, for you to run through toil's write gate.
|
|
495
|
-
Toil UI posts nothing. With sample data, notes and export are off.
|
|
789
|
+
Toil UI posts nothing. With sample data, notes and export are off, and the page says so once.
|
|
496
790
|
|
|
497
791
|
### Stand-up
|
|
498
792
|
|
|
499
|
-
**Stand-up since the last working day
|
|
500
|
-
|
|
793
|
+
**Stand-up since the last working day** leads the Summary too: a compact **Stand-up** card right under the
|
|
794
|
+
headline answer and what needs attention shows the same report for the default range ("Yesterday" or "Since
|
|
795
|
+
Friday"), a team line, the few rows that matter most (unanswered questions, then blocked, done, in progress) and **Open the full stand-up**. With no sync behind it the card
|
|
796
|
+
shows `–` and "Not read yet" with **Sync now**, never "nothing happened". The Summary's **Go to** row and the
|
|
797
|
+
command palette (**Open the stand-up**) open it as well. The page (`#/project/<name>/standup`) reshapes the worklog for a meeting: since the last
|
|
501
798
|
working day through today (Friday through Monday on a Monday), or any range of up to 31
|
|
502
|
-
days you pick (`#/project/<name>/
|
|
799
|
+
days you pick (`#/project/<name>/standup/<from>/<to>`, or `/<day>` for one), and each day's page has a
|
|
503
800
|
**Stand-up for this day**. It is a fold of those days' pages by code, with no model, so the
|
|
504
801
|
same days always give the same report.
|
|
505
802
|
|
|
506
|
-
- **
|
|
507
|
-
|
|
508
|
-
- **Then each person, agents included,**
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
reviewed the pull request. A pull request a Toil project agent wrote goes under the agent.
|
|
515
|
-
- **People** come from the Toil project's `people`, so one person's Jira, Azure DevOps and
|
|
516
|
-
GitHub accounts land under one name. An account the Toil project doesn't map gets its own
|
|
517
|
-
card, named with its area and id; the People view suggests where it belongs.
|
|
518
|
-
- **What the worklog can't vouch for** in the range is said at the top. Review waits, the
|
|
519
|
-
sprint and Next aren't on any worklog page, so they are as of the latest sync, and the
|
|
520
|
-
report says which.
|
|
521
|
-
- **Every line links** to its item, pull request or build, and is numbered (F1, F2, ...).
|
|
522
|
-
|
|
523
|
-
It copies as **Markdown** (for Slack, Teams or a wiki) or **plain text**, line for line as
|
|
524
|
-
shown. **Export** writes the Markdown through toil's file service, as a page's export does,
|
|
525
|
-
to `standup-<toilProject>-<from>-to-<to>.md`, and publishing it to Confluence or GitHub is a
|
|
526
|
-
proposal for you to run.
|
|
803
|
+
- **No title, one source line.** The page has no heading of its own; one line says where it came from ("From the worklog, as of the sync at 13 Oct 07:55 UTC") and which trackers' comments were read, and the (i) holds the rest. One row of controls: a menu of days (since the last working day, today, last 7 days, this sprint, or custom dates), which apply at once, and **Copy text**.
|
|
804
|
+
- **The team in one line:** the sprint ("Sprint 26: day 7 of 10, 7 of 25 done"), then scope changes and builds that broke or recovered, each chip one line cut to its box (the full text on hover), folded after three.
|
|
805
|
+
- **Then each person, agents included,** as a small block: a small person (an agent has its own shape) and the name, then five rows in a fixed order, **Done** (items moved into a done status, pull requests merged or closed), **In progress**, **Blocked** (a new blocker, a failed build of their pull request, a pull request waiting on review for 2 working days or more), **Next** (current-sprint items assigned to them and not started) and **Comments**. Each row is a few chips (key and a short title; the full text on hover), folded after three with "+N". An empty row is a `–` (read aloud as "none", or "not read yet" where nothing was read). A person with nothing at all is one line. People sit in two or three columns on a wide screen.
|
|
806
|
+
- **Comments are the reminder.** A person's comments in the days, and, first and marked with a "?" and "no reply, N d", every question they asked that nobody else has answered since, however old. Jira's comments come with the search (`comment` is one of the fields it asks for, so no extra requests), kept as OWI's optional `comments`; Toil UI does not read pull request or other trackers' comments yet, and the source line says so.
|
|
807
|
+
- **People** come from the Toil project's `people`, so one person's Jira, Azure DevOps and GitHub accounts land under one name. An account the Toil project doesn't map gets its own block, named with its area and id; the People view suggests where it belongs.
|
|
808
|
+
- **What the worklog can't vouch for** in the range is one folded "Coverage" line. Review waits, the sprint and Next aren't on any worklog page, so they are as of the latest sync.
|
|
809
|
+
|
|
810
|
+
**Copy text** is the whole stand-up as short plain text: a team line, then one line per person ("A. Chen — In progress: SHOP-119 Size guide (To Do → In Progress). Next: SHOP-131. Comments: SHOP-125 "Do we need a migration…" (1 day, no reply)"). **Export as a Markdown file**, folded at the bottom, writes the full Markdown through toil's file service, as a page's export does, to `standup-<toilProject>-<from>-to-<to>.md`, and publishing it to Confluence or GitHub is a proposal for you to run.
|
|
527
811
|
|
|
528
812
|
**Write it up** is optional: it asks the agent for a short narrative of the same report,
|
|
529
813
|
in the theme's voice when that is on. The agent reads the report through its
|
|
@@ -545,17 +829,25 @@ running those commands through `@imagile-dev/toil/api`, never by editing a file:
|
|
|
545
829
|
CLI's words: a line break (or, for a token, a space) in the middle is
|
|
546
830
|
refused, and quotes or a `Bearer ` / `token ` prefix ask Remove it or Keep
|
|
547
831
|
it before anything is saved.
|
|
832
|
+
On a Confluence Cloud connection, where a Jira Cloud connection on the same
|
|
833
|
+
site holds a token, the add and Update login forms ask **Which API token?**:
|
|
834
|
+
**A token of its own** or **Reuse <jira>'s token**, which hides the token box
|
|
835
|
+
and stores nothing. The add form starts on reuse; the login form starts on
|
|
836
|
+
the connection's own token when it has one. The page answers toil's
|
|
837
|
+
`borrow:apiToken` question either way.
|
|
548
838
|
Turning writes on asks you to type the connection's name, as the CLI does. A
|
|
549
839
|
connection made by `TOIL_*` env vars alone is shown read-only, with where it
|
|
550
840
|
came from.
|
|
551
841
|
- **Toil projects:** create one, add a repository, link an area, name a field, and
|
|
552
842
|
show and check any of them. A Toil project's name and description are edited in place
|
|
553
|
-
on its card and dashboard, through `toil projects describe`. A link to a connection with writes on is refused
|
|
843
|
+
on its card and dashboard, through `toil projects describe`. The list has **New Toil project** (`#/new-project`) and an edit page for each (`#/settings/projects/<name>/<section>`: Sources, Field names, People, Work in progress limit, How Analyze briefs). A link to a connection with writes on is refused
|
|
554
844
|
here, as over MCP: make it on the CLI.
|
|
555
|
-
- **
|
|
556
|
-
|
|
845
|
+
- **Board moves:** the one setting here that is Toil UI's own and not toil's, **Apply board moves when I drop a card**, kept in this
|
|
846
|
+
browser and on by default (see **Board moves** under the board). It changes nothing by itself; it decides whether a drop on the Board asks toil to change a status.
|
|
847
|
+
- **Bounds and time limit:** toil has no command for these, so they are under
|
|
848
|
+
Settings, General, **Advanced**, shown read-only.
|
|
557
849
|
- **Usage:** how toil is used on this machine, from `toil audit stats`, which
|
|
558
|
-
reads only toil's local audit log
|
|
850
|
+
reads only toil's local audit log. It opens on a one-line summary of calls, failures and changes, without Toil UI's own background calls; behind **More detail** are calls per day, the split between Toil UI, the
|
|
559
851
|
CLI and MCP, the commands used most, the ones that fail most with their top
|
|
560
852
|
error code and its usual fix (and, on request, their recent failures from
|
|
561
853
|
`toil audit list`), and the commands nothing called. It needs a toil with
|
|
@@ -573,12 +865,12 @@ An **(i)** beside a term explains it in a sentence or two when you hover or focu
|
|
|
573
865
|
it, and pressing it opens the same words with a **Read more** link to the section
|
|
574
866
|
of these docs that says the rest. A **pencil** beside a configurable value (a
|
|
575
867
|
connection, a Toil project's sources, people, field names or work-in-progress limit,
|
|
576
|
-
the agent,
|
|
868
|
+
the agent, the Codex rates) opens the settings page where it's set, at that value; it
|
|
577
869
|
only navigates. **Help** in the header is a menu with the docs for the view you're on
|
|
578
870
|
and **What's new** (below).
|
|
579
871
|
|
|
580
|
-
Where a screen uses an AI term (tokens and the context window under
|
|
581
|
-
model, harness and MCP under
|
|
872
|
+
Where a screen uses an AI term (tokens and the context window under Usage,
|
|
873
|
+
model, harness and MCP under AI agent, sandbox and permission mode in the Assign
|
|
582
874
|
dialog's modes, session and system prompt in Renew all stale, hallucination in the
|
|
583
875
|
chat's **About these answers**), its (i) popover also gives each term's first
|
|
584
876
|
sentence from Context Overflow's glossary, with **Read more on Context Overflow**.
|
|
@@ -588,6 +880,19 @@ Help's menu then has **Learn**: four of Context Overflow's modules, by task.
|
|
|
588
880
|
Context Overflow and every glossary line is gone, and Help keeps the view's docs and
|
|
589
881
|
What's new.
|
|
590
882
|
|
|
883
|
+
### Icons
|
|
884
|
+
|
|
885
|
+
Every icon is an inline SVG from one set, `ui/src/components/icons.tsx`: a few hand-drawn
|
|
886
|
+
strokes on a 24 unit grid in `currentColor`, the same 1.5px on screen at any size, and
|
|
887
|
+
`aria-hidden` (the button or the word beside it carries the name). No theme's font draws
|
|
888
|
+
one, so an icon looks the same in every theme and a theme can only recolour it. There is
|
|
889
|
+
one (i), `InfoTip` in `ui/src/components/help.tsx`, which `Help`, the chat's **About these
|
|
890
|
+
answers** and a connection form's field notes all use: hover or focus shows a tooltip,
|
|
891
|
+
a press opens the popover, Escape closes it. To add an icon, add its paths to `PATHS` in
|
|
892
|
+
`icons.tsx` and export a component for it; `ui/test/icons.test.tsx` holds it to the rules
|
|
893
|
+
and fails if a letter or a unicode character (`i`, `?`, `✕`, `✓`) is drawn as an icon
|
|
894
|
+
again. Never a font glyph, an icon font, an image file or a package.
|
|
895
|
+
|
|
591
896
|
Read more, Help, Learn and What's new's changelog links open in a new tab, and are the
|
|
592
897
|
only places the app links out to: nothing is fetched until you follow one.
|
|
593
898
|
[Help and edit links](https://imagile-dev.github.io/toil/docs/ui-help/) has the rule
|
|
@@ -599,7 +904,7 @@ Every empty panel offers the one action that fills it, under one short line, wit
|
|
|
599
904
|
explanation in its (i): **Link a pipeline** and **Add an environment** (pencils to
|
|
600
905
|
Toil project setup at the Toil project's sources) on the Board tab's builds and deployments, **Add
|
|
601
906
|
a repository** for pull requests, **Add a person** on the People tab, **Analyze now**
|
|
602
|
-
for an empty
|
|
907
|
+
for an empty list of earlier briefings, **Show every item** for a Command Center filter that hides
|
|
603
908
|
everything, and **Sync now** in the local app wherever only a newer read of the tracker
|
|
604
909
|
fills the panel (the sprint, the burn-up, links between items). The site preview can't
|
|
605
910
|
sync, so it offers Toil project setup there instead. A test fails on any empty panel with
|
|
@@ -624,10 +929,10 @@ use the arrow keys to move, **Enter** to open and **Escape** to close. It's hidd
|
|
|
624
929
|
until you call it up.
|
|
625
930
|
|
|
626
931
|
- **Jump** to a Toil project, any of a Toil project's tabs (Overview, Board, Dependencies,
|
|
627
|
-
Pull requests, People, Worklog,
|
|
932
|
+
Pull requests, People, Stand-up, Worklog), a chart or the earlier briefings (typed by name), a saved analysis, a settings page, or a
|
|
628
933
|
theme.
|
|
629
|
-
- **Run** Sync now (where Toil UI keeps a cache),
|
|
630
|
-
focuses the Ask bar), Analyze, **Review a pull request**, **Ship: answer a review** and **Diagram <Toil project>** (each opens its job's page), **Open the Agents panel** (**Open the AI
|
|
934
|
+
- **Run** Sync now (where Toil UI keeps a cache), and on a Toil project's page Ask (it
|
|
935
|
+
focuses the Ask bar), Analyze, **Review a pull request**, **Ship: answer a review** and **Diagram <Toil project>** (each opens its job's page) and **Architecture diagram of <Toil project>** (the saved picture), **Open the Agents panel** (**Open the AI agents panel** in plain words), the agent that answers this chat, and Assign the
|
|
631
936
|
item you were on to an agent: the board card that had focus, or the item whose
|
|
632
937
|
page is open.
|
|
633
938
|
- Matching is fuzzy and ignores case: `pay12` finds `PAY-12`, and each word you
|
|
@@ -665,8 +970,8 @@ request: the kind, a title, the details and your email. It sends through
|
|
|
665
970
|
agree to the report on screen and no other.
|
|
666
971
|
- **Only what you typed.** toil adds its version and commit, nothing else: no
|
|
667
972
|
Toil project, connection, host or cached data.
|
|
668
|
-
- **The same
|
|
669
|
-
Origin and
|
|
973
|
+
- **The same checks as Settings.** `api/feedback` needs the cookie, the page's own
|
|
974
|
+
Host and Origin and a JSON body, takes the four fields and nothing else, and runs
|
|
670
975
|
`toil feedback` and no other command. Your tick becomes the yes to the command's
|
|
671
976
|
own consent question. With sample data it sends nothing. With a toil that has no
|
|
672
977
|
`feedback` command (0.1.0-alpha.2), the dialog says so and points at the site's
|
|
@@ -680,6 +985,7 @@ dashboards make, for every Toil project, and stores the answers. The work items
|
|
|
680
985
|
through toil's Open Work Item mapping, with their status changes and the pull
|
|
681
986
|
requests, builds and deployments that name them.
|
|
682
987
|
|
|
988
|
+
- **Nothing moves while it runs.** A running sync shows as a small card over the lower corner of the window (along the bottom edge on a phone), with the theme's loader inside it, never in the page itself, so the page you are reading stays where it is.
|
|
683
989
|
- **Incremental.** After the first sync, Jira and Azure DevOps searches, and a
|
|
684
990
|
GitHub repository's issues, ask only for what changed since the last good sync (`updatedSince`, five minutes early in
|
|
685
991
|
case the clocks disagree), and the GitHub board marks the issues whose
|
|
@@ -719,7 +1025,7 @@ requests, builds and deployments that name them.
|
|
|
719
1025
|
floor of 6 weeks (see What it reads). An analysis goes once
|
|
720
1026
|
it is older than the retention period, and with its Toil project when toil no longer
|
|
721
1027
|
has it.
|
|
722
|
-
- **Wiping it.** **Wipe the cache
|
|
1028
|
+
- **Wiping it.** **Wipe the cache**, under Settings, General, **Advanced**, deletes it after asking
|
|
723
1029
|
first. `toil-ui wipe` does the same from a terminal, once `toil-ui` has
|
|
724
1030
|
stopped: a running Toil UI holds `toil-ui.lock` in the data folder, and the
|
|
725
1031
|
command refuses while it does. Your trackers are never touched. The next sync fetches everything again.
|
|
@@ -729,8 +1035,7 @@ requests, builds and deployments that name them.
|
|
|
729
1035
|
exist. So is an item closed longer ago than the read window. A GitHub issue
|
|
730
1036
|
stays until the retention period ends or you wipe the cache.
|
|
731
1037
|
|
|
732
|
-
The page can run only the reads the dashboards make: `projects list` and `
|
|
733
|
-
show`, and each area's search, history, pull request, build and deployment reads.
|
|
1038
|
+
The page can run only the reads the dashboards make: `projects list`, `projects show` and `jira issue fields` (which asks Jira nothing), and each area's search, history, pull request, build and deployment reads.
|
|
734
1039
|
Any other command is refused before it reaches toil, and a change to a tracker is
|
|
735
1040
|
never made from the page. The worklog's own calls are made by the server, never named
|
|
736
1041
|
by the page: `toil audit list`, read-only, to see whether a proposal was applied, and
|
|
@@ -745,7 +1050,7 @@ conversation stays, for the rest of the Toil project's pages, until you reload.
|
|
|
745
1050
|
|
|
746
1051
|
- **The guided start** (#552) is what the chat shows before the first question:
|
|
747
1052
|
"What would you like to know about {name}?", then nine plain questions in four groups
|
|
748
|
-
(How are we doing? What's in the way? Backlog. For others), beside **Before you ask**. What each is good for is its hover; the one line on the page is that "Who might need help?" never ranks anyone. The dialog's title is the project's name. You can still type your own, except with no AI
|
|
1053
|
+
(How are we doing? What's in the way? Backlog. For others), beside **Before you ask**. What each is good for is its hover; the one line on the page is that "Who might need help?" never ranks anyone. The dialog's title is the project's name. You can still type your own, except with no AI agent set up, when the questions are off and the notice links to **Settings → AI agent**. Pressing a question asks its text
|
|
749
1054
|
through the same path as typing it; after the first answer the same questions are the
|
|
750
1055
|
**Suggestions** menu. The questions are `src/guided-questions.ts`, not the server's
|
|
751
1056
|
starters, which still back `api/agent/starters`.
|
|
@@ -770,12 +1075,12 @@ conversation stays, for the rest of the Toil project's pages, until you reload.
|
|
|
770
1075
|
question on the server and keeps what had arrived. Claude and Copilot stream as they
|
|
771
1076
|
write; Codex's SDK hands over its text a message at a time, so with Codex the status
|
|
772
1077
|
line is what moves between messages.
|
|
773
|
-
- **The wording follows the theme
|
|
774
|
-
|
|
775
|
-
|
|
1078
|
+
- **The wording follows the theme only where nothing depends on it**: with themed wording on, the bar's welcome and note are in each game
|
|
1079
|
+
theme's voice and Plain stays neutral. The placeholder and the status line's source words read the same plain text in every theme, and so
|
|
1080
|
+
do the starter questions.
|
|
776
1081
|
- **Analyze** briefs the Toil project in one press (#494). It is the guided start's first
|
|
777
1082
|
question, "Give me the full briefing", and still the command palette's Get a briefing and the
|
|
778
|
-
|
|
1083
|
+
Summary's Get a briefing button; the Ask bar has no button of its own for it. Its question comes from toil,
|
|
779
1084
|
`toil projects analyze prompt <toilProject> --host toil-ui`: the standard method with
|
|
780
1085
|
the Toil project's own lenses and focus (Tuning Analyze, above). It answers with a
|
|
781
1086
|
briefing block, which the server lifts out of the answer and checks, every id in it
|
|
@@ -786,7 +1091,7 @@ conversation stays, for the rest of the Toil project's pages, until you reload.
|
|
|
786
1091
|
open it. An answer with no briefing block is shown as it came, and says so. With a
|
|
787
1092
|
toil that has no `projects analyze prompt`, Analyze asks Toil UI's own question
|
|
788
1093
|
instead, and the answer warns that it did. Each whole Analyze is kept in the
|
|
789
|
-
Toil project's
|
|
1094
|
+
Toil project's earlier briefings, and the answer links to it.
|
|
790
1095
|
- **Citations are links in the text**: in every answer, each `[[id]]` is an ordinary link
|
|
791
1096
|
(a short source name such as ADO or GH, the item's key and a cut title) to its page (a
|
|
792
1097
|
pull request to its host). Hovering or focusing one shows the whole title, its source and
|
|
@@ -806,7 +1111,7 @@ conversation stays, for the rest of the Toil project's pages, until you reload.
|
|
|
806
1111
|
ordinary question, records the agent it was asked of, in `<data folder>/toil-project-agents.json` (an adapter name per
|
|
807
1112
|
Toil project name, Toil UI's own state, never in the Toil project file). The next time the chat
|
|
808
1113
|
opens on that Toil project it starts on that agent if it can still answer, else on the
|
|
809
|
-
default from Settings,
|
|
1114
|
+
default from Settings, AI agent (Claude, GitHub Copilot or Codex), else the first agent
|
|
810
1115
|
that is ready, else as before, with the server trying the default and saying why it
|
|
811
1116
|
can't. A few words beside **Answered by** say which: "last used on this Toil project",
|
|
812
1117
|
"your default", "your default can't run", "the first one ready" or
|
|
@@ -825,16 +1130,16 @@ dependency that is loaded only when it answers:
|
|
|
825
1130
|
| GitHub Copilot | `@github/copilot-sdk` | `copilot` (the Copilot CLI) | your Copilot seat, through the CLI |
|
|
826
1131
|
| Codex | `@openai/codex-sdk` | `codex` (the Codex CLI) | the CLI's ChatGPT sign-in or its own API key setup |
|
|
827
1132
|
|
|
828
|
-
Choose the default under **Settings,
|
|
1133
|
+
Choose the default under **Settings, AI agent**: the adapter, each adapter's model
|
|
829
1134
|
(empty for its CLI's default), the CLI's path (empty to use the one on `PATH`) and,
|
|
830
1135
|
for Claude, the endpoint. The choice is kept in `<data folder>/agent.json`, never in
|
|
831
1136
|
toil's config, and has no field for a key: each SDK signs in the way its CLI does.
|
|
832
1137
|
|
|
833
1138
|
### Installing an adapter's SDK
|
|
834
1139
|
|
|
835
|
-
**Settings,
|
|
836
|
-
|
|
837
|
-
reason shown), and an **Install** button on each
|
|
1140
|
+
**Settings, AI agent** opens on the steps to get going and each
|
|
1141
|
+
AI agent with its state (Ready, Not set up yet in a calm tone, or Needs one more step with the
|
|
1142
|
+
reason shown), and an **Install** button on each AI agent that isn't installed. Whether its SDK
|
|
838
1143
|
is installed and at which version against the one Toil UI was tested with, which CLI it would
|
|
839
1144
|
start, and anything worth knowing, are one step in under **Details for whoever sets it up**;
|
|
840
1145
|
models, the CLI path and the endpoint are behind **Advanced**. A missing SDK has an **Install** button, which shows the one
|
|
@@ -845,14 +1150,14 @@ npm install --global --prefix <the prefix Toil UI is installed in> --ignore-scri
|
|
|
845
1150
|
```
|
|
846
1151
|
|
|
847
1152
|
Pressing **Install** runs it through the npm that came with your Node, with no shell and
|
|
848
|
-
your own npm config, so your organization's registry and proxy apply. npm's output
|
|
1153
|
+
your own npm config, so your organization's registry and proxy apply. If the install fails, Toil UI offers a registry helper: on a press, it writes one `registry=<url>` line to the user npmrc (`ui/server/agents/npmrc.ts`) and you try again. The Copilot CLI's package installs along with its SDK (`docs/decisions/561-ai-helper-installs.md`). npm's output
|
|
849
1154
|
streams into the dialog, and Toil UI then loads the SDK to prove it installed; a
|
|
850
1155
|
failure shows npm's own message and the fix. **Copy command** is beside it, for a
|
|
851
1156
|
machine where you'd rather run it yourself. This is the one thing Toil UI runs npm
|
|
852
1157
|
for (docs/decisions/343-ask-up-front.md).
|
|
853
1158
|
|
|
854
1159
|
- **Only the tested versions**: `@anthropic-ai/claude-agent-sdk@0.3.289` with
|
|
855
|
-
`zod@4.6.
|
|
1160
|
+
`zod@4.6.7`, `@github/copilot-sdk@1.0.16` and `@openai/codex-sdk@0.160.0`, exactly
|
|
856
1161
|
(`ui/server/agents/tested.ts`). Nothing else is ever named, and `--before` holds
|
|
857
1162
|
everything npm resolves, the SDK's own dependencies included, to releases at least
|
|
858
1163
|
14 days old.
|
|
@@ -925,34 +1230,22 @@ for (docs/decisions/343-ask-up-front.md).
|
|
|
925
1230
|
be on the same drive. `toil-ui wipe` deletes this home with the cache, along with
|
|
926
1231
|
Codex's record of Toil UI's questions, and leaves your own `auth.json` alone.
|
|
927
1232
|
|
|
928
|
-
- **Your own instructions.** Under **Settings,
|
|
1233
|
+
- **Your own instructions.** Under **Settings, AI agent**, general instructions (for
|
|
929
1234
|
example "answer in British English") and a custom voice, each up to 4,000
|
|
930
1235
|
characters, kept in `agent.json` beside the adapter. They come after the rules in
|
|
931
1236
|
the prompt, and the rules win: they can't change the citations, the figures, the
|
|
932
1237
|
proposals or what the tools can do. **Show the full prompt** shows exactly what
|
|
933
1238
|
the agent is sent.
|
|
934
1239
|
|
|
935
|
-
With no adapter chosen, the chat says in plain words that no AI
|
|
936
|
-
an engineer sets one up (Settings,
|
|
1240
|
+
With no adapter chosen, the chat says in plain words that no AI agent is set up and where
|
|
1241
|
+
an engineer sets one up (Settings, AI agent), with the three adapters and their packages one
|
|
937
1242
|
step in, behind **Details for whoever sets it up**; its switcher can still
|
|
938
|
-
choose an installed one for that chat. The notice goes as soon as
|
|
939
|
-
reads the
|
|
940
|
-
reload.
|
|
1243
|
+
choose an installed one for that chat. The notice goes as soon as an AI agent can answer: the chat
|
|
1244
|
+
reads the AI agents again whenever the page moves, so installing on the Settings page needs no
|
|
1245
|
+
reload. An AI agent that is installed but can't start yet says so instead, with the reason one step
|
|
941
1246
|
in. `toil-ui --sample` keeps the scripted agent,
|
|
942
1247
|
which answers its starter questions, Analyze and the workflow jobs from the sample data (a job's answer says nothing was read and lists every check as unchecked).
|
|
943
1248
|
|
|
944
|
-
### Not ticketed yet
|
|
945
|
-
|
|
946
|
-
When you ask the chat for work that names no ticket (not a question, which ends in `?` or
|
|
947
|
-
opens with what, why, how and the like, and no key such as `PAY-12` or `#42`), a **Not ticketed yet** banner lists up to three of the
|
|
948
|
-
Toil project's open items likeliest to cover it, scored as `toil util owi similar` scores
|
|
949
|
-
them, each with why. Attach the work to one by naming its key in your branch and
|
|
950
|
-
commits, which writes nothing, or press **Ticket this** for proposals: a sub-task
|
|
951
|
-
under each match, and a new ticket on the Toil project's tracker. They are proposal cards
|
|
952
|
-
like the chat's others, with the command line to run through toil's write gate, and
|
|
953
|
-
nothing is created until you run one. With no match, it says there is no likely
|
|
954
|
-
ticket and offers only a new one. It asks once per chat, and **Not now** hides it.
|
|
955
|
-
|
|
956
1249
|
### What the agent's models used
|
|
957
1250
|
|
|
958
1251
|
Each SDK reports what a question used, and Toil UI keeps that report, one record per
|
|
@@ -967,29 +1260,27 @@ called):
|
|
|
967
1260
|
|
|
968
1261
|
- **Under each answer**, one line in its folded line, "about $0.04 of usage (estimate)", or "(not billed on your plan)" on a Claude plan. The fold opens to one line per model: `2.1k in · 380 out · 14k cached · cache
|
|
969
1262
|
write not reported · ~$0.012 (SDK estimate)`. A figure the SDK didn't report reads
|
|
970
|
-
"not reported", never 0.
|
|
1263
|
+
"not reported", never 0. When the saved Codex rates can't be read, a Codex answer says so in the open.
|
|
971
1264
|
- **In the chat's footer**, from the second answer (one answer's usage is the chat's), the chat's running total, split by model, and how full
|
|
972
1265
|
the last answer's context got, where the SDK says (Claude and Copilot; Codex's SDK
|
|
973
1266
|
doesn't). On a phone the chat's header is one line, "Answered by … · Change".
|
|
974
|
-
- **Settings,
|
|
1267
|
+
- **Settings, Usage**, under its **More detail** (beside the count of toil's own commands): the last
|
|
975
1268
|
30 days by day, adapter, model and Toil project, the chats that used the most, and an
|
|
976
1269
|
**Export as CSV** download made in the page.
|
|
977
|
-
- **One adding-up rule**, `addUp` in `src/model-usage.ts`, read by the server's
|
|
1270
|
+
- **One adding-up rule**, `addUp` in `src/model-usage.ts`, read by the server's ledger,
|
|
978
1271
|
the footer, the heading and Settings: reports with one id are one report, merged to
|
|
979
1272
|
the highest of each figure (a running total), and different ids are summed.
|
|
980
1273
|
- **The ledger** is the cache's `usage` table, apart from everything a sync writes: a
|
|
981
1274
|
sync's cleanup or a Toil project leaving never lowers a total. It follows the cache's
|
|
982
1275
|
retention, `toil-ui wipe` clears it, and it is never sent anywhere.
|
|
983
1276
|
|
|
984
|
-
**
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
refused, naming the setting, and while the file can't be read the agent answers
|
|
992
|
-
nothing, so a typo can never turn a cap off. A cap counts only what the SDK reports:
|
|
1277
|
+
**Codex rates** are optional, under Settings, Usage, inside **More detail** (a link to them,
|
|
1278
|
+
`#/settings/usage/rates`, opens it and focuses their heading): the Codex SDK reports
|
|
1279
|
+
tokens and no dollar figure, so with your input, cached input and output rates, in
|
|
1280
|
+
dollars per million tokens, Toil UI computes one for each Codex answer from then on,
|
|
1281
|
+
labelled as computed from your rates. They live in `<data folder>/usage.json`. A value
|
|
1282
|
+
that doesn't parse is refused, naming the setting, and while the file can't be read a
|
|
1283
|
+
Codex answer says why it has no dollar figure. The figures are what the SDK reports:
|
|
993
1284
|
the vendor's own bill is the authority.
|
|
994
1285
|
|
|
995
1286
|
## Assigning work to an agent
|
|
@@ -1037,9 +1328,8 @@ you apply it.
|
|
|
1037
1328
|
item that tells the agent to do anything else stops the run, marked `needs you`.
|
|
1038
1329
|
- **Limits.** One assignment runs at a time and each has 20 minutes, both changeable
|
|
1039
1330
|
in the sidebar's **Limits** (1 to 3 at once, 1 to 240 minutes), kept in
|
|
1040
|
-
`<data folder>/assignments.json`.
|
|
1041
|
-
|
|
1042
|
-
stops a run cleanly, saying which.
|
|
1331
|
+
`<data folder>/assignments.json`. The time limit stops a run cleanly, saying so,
|
|
1332
|
+
and an assignment's usage counts as one chat under **Settings, Usage**.
|
|
1043
1333
|
- **The transcript** keeps the prompts, every tool call, the agent's text, the
|
|
1044
1334
|
commands and file changes Codex reports, and each proposal and what came of it.
|
|
1045
1335
|
Each assignment also records what it started on: the toil and Toil UI versions, the
|
|
@@ -1053,7 +1343,7 @@ you apply it.
|
|
|
1053
1343
|
## Stale sessions
|
|
1054
1344
|
|
|
1055
1345
|
An agent works from the instructions it got when it started. Upgrade toil, edit the
|
|
1056
|
-
Toil project or change your instructions under **Settings,
|
|
1346
|
+
Toil project or change your instructions under **Settings, AI agent**, and the chats and
|
|
1057
1347
|
assignments already going are still on the old ones. Toil UI records what each one
|
|
1058
1348
|
started on, says which have gone stale and why, and renews them on request.
|
|
1059
1349
|
|
|
@@ -1076,7 +1366,7 @@ started on, says which have gone stale and why, and renews them on request.
|
|
|
1076
1366
|
agent's card in the People view. A done assignment is closed and isn't marked.
|
|
1077
1367
|
- **Renew.** On the chat, **Renew** in the focused view records what it starts on now;
|
|
1078
1368
|
the conversation stays, and the next question carries it as every question does. The
|
|
1079
|
-
chat's usage total carries on, so renewing never resets
|
|
1369
|
+
chat's usage total carries on, so renewing never resets it. On a stale assignment
|
|
1080
1370
|
that has failed, **Renew** queues a fresh one on the same item, mode, adapter and
|
|
1081
1371
|
repository, whose prompt carries what the old run left, fenced as data; the old one
|
|
1082
1372
|
stays readable, marked as renewed. Renew never interrupts a turn: a chat that is
|
|
@@ -1096,9 +1386,8 @@ Toil UI tells you when an agent's state changes, and stays quiet otherwise. A to
|
|
|
1096
1386
|
call, its progress, or a state that didn't change never notifies.
|
|
1097
1387
|
|
|
1098
1388
|
- **What notifies:** an assignment reaching **needs you** (with why: "asked a
|
|
1099
|
-
question", "3 proposals to review"), **done** or **failed**,
|
|
1100
|
-
|
|
1101
|
-
run going from queued to working says nothing, and neither does your own Stop.
|
|
1389
|
+
question", "3 proposals to review"), **done** or **failed**, and a chat or
|
|
1390
|
+
assignment gone **stale** (Stale sessions, above). A run going from queued to working says nothing, and neither does your own Stop.
|
|
1102
1391
|
- **Once, together.** Changes within four seconds become one notice: "2 agents need
|
|
1103
1392
|
you", each line linking to its assignment. A change undone inside those seconds,
|
|
1104
1393
|
such as a question answered elsewhere, sends nothing.
|
|
@@ -1108,12 +1397,12 @@ call, its progress, or a state that didn't change never notifies.
|
|
|
1108
1397
|
computer: nothing leaves the machine. The browser is asked for permission only when
|
|
1109
1398
|
you turn that on, never before.
|
|
1110
1399
|
- **Settings**, under **Settings, General**, kept in this browser: a switch for each
|
|
1111
|
-
kind (**needs you**, **failed**
|
|
1400
|
+
kind (**needs you**, **failed** on, **done** off, **stale** on, by
|
|
1112
1401
|
default), **only for agents I started** (the chats in this browser and the
|
|
1113
1402
|
assignments assigned, started or renewed here), and quiet hours, which hold every
|
|
1114
1403
|
notice while the title still counts.
|
|
1115
1404
|
- **Plain words.** Notices read the same in every theme: the theme's wording stays in
|
|
1116
|
-
the views.
|
|
1405
|
+
the views' flavour text.
|
|
1117
1406
|
- **Where it listens.** The server's `api/assignments/events?since=latest` stream,
|
|
1118
1407
|
which carries what a notice says with each event, and a minute's read of the
|
|
1119
1408
|
Toil project on screen for sessions gone stale.
|
|
@@ -1122,7 +1411,7 @@ call, its progress, or a state that didn't change never notifies.
|
|
|
1122
1411
|
|
|
1123
1412
|
The **bell** in the header (beside **Menu** on a narrow screen) counts the unread and
|
|
1124
1413
|
opens the last 50 things worth telling you, newest first: each change a notice carried
|
|
1125
|
-
(needs you, done, failed,
|
|
1414
|
+
(needs you, done, failed, gone stale), each sync's result, from
|
|
1126
1415
|
the Sync panel, with the Toil project that failed, and when each happened. Every entry links
|
|
1127
1416
|
to what it's about: the assignment, the Toil project, or the Toil projects view. **Mark all read**
|
|
1128
1417
|
clears the count and keeps the entries. The bell keeps a change that quiet hours held
|
|
@@ -1135,8 +1424,8 @@ the worklog's facts, never from the bell.
|
|
|
1135
1424
|
|
|
1136
1425
|
Eight built-in themes: Plain, Crate (the default), Harvest, Starship, Realm, Sprawl,
|
|
1137
1426
|
Frontier and Overworld. Pick
|
|
1138
|
-
one from the header, or under **Settings,
|
|
1139
|
-
it goes,
|
|
1427
|
+
one from the header, or under **Settings, Appearance**, where two checkboxes say how far
|
|
1428
|
+
it goes, wording on and the agent voice off by default (#552, #561):
|
|
1140
1429
|
|
|
1141
1430
|
- **Themed wording:** the theme's own lede, eyebrows, dashboard notes, empty
|
|
1142
1431
|
states and loading lines, and its names for a sprint, a board or an epic beside
|
|
@@ -1147,19 +1436,16 @@ it goes, both off by default (#552):
|
|
|
1147
1436
|
dungeon master in Realm, a laconic netrunner in Sprawl, a dry telegraph operator
|
|
1148
1437
|
in Frontier, an old sage in a cave in Overworld. It changes phrasing only.
|
|
1149
1438
|
|
|
1150
|
-
Every theme has a light and a dark scheme. **
|
|
1439
|
+
Every theme has a light and a dark scheme. **Light or dark**, in Settings, Appearance or the
|
|
1151
1440
|
command palette, picks one; System, the default, follows your operating system.
|
|
1152
1441
|
|
|
1153
|
-
|
|
1154
|
-
theme on its own: off, that theme's particles are gone entirely, while its other
|
|
1155
|
-
motion keeps following **Reduce motion and effects** (and the operating system's
|
|
1156
|
-
reduced-motion setting, which stops everything).
|
|
1442
|
+
**Motion**, one select under Settings, Appearance, is Full, Subtle or Off: Off is what reduced motion was, and Subtle also turns the theme's particles off. The operating system's reduced-motion setting stops everything.
|
|
1157
1443
|
|
|
1158
1444
|
Crate, Harvest, Starship, Realm, Sprawl, Frontier and Overworld also have **theme moments**: a launch splash while the first read
|
|
1159
1445
|
runs, their own loading screens with the real progress and a rotating line of their own,
|
|
1160
1446
|
an entrance as a Toil project opens, a transition between its tabs, and a short moment when a
|
|
1161
1447
|
sync brings an item done, a build passed or failed, a blocker cleared, a pull request
|
|
1162
|
-
merged, or a sprint's end. **
|
|
1448
|
+
merged, or a sprint's end. **Motion**, under Settings, Appearance, plays them in full,
|
|
1163
1449
|
subtly or not at all, and is off whenever reduced motion is asked for. Every loading
|
|
1164
1450
|
screen also carries a **toil tip**, one line with a Read more link, which **Toil tips on
|
|
1165
1451
|
loading screens** turns off. Waits under 300 ms show no loading screen at all.
|
|
@@ -1175,19 +1461,47 @@ left in the data folder by an earlier alpha is not read, and Toil UI says so whe
|
|
|
1175
1461
|
starts. [Themes](https://imagile-dev.github.io/toil/docs/themes/) has the whole
|
|
1176
1462
|
story, the composed prompt included.
|
|
1177
1463
|
|
|
1178
|
-
## The
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
-
|
|
1464
|
+
## The checks on the door
|
|
1465
|
+
|
|
1466
|
+
The server binds loopback only (`127.0.0.1` or `::1`; any other `--host` is refused).
|
|
1467
|
+
A web page open in your browser can still send requests to a port on `127.0.0.1`, by
|
|
1468
|
+
posting a form or by rebinding its own domain to loopback, so every request passes
|
|
1469
|
+
these checks, before a route runs:
|
|
1470
|
+
|
|
1471
|
+
- **A cookie.** The first time `toil-ui` runs it makes 32 random bytes in
|
|
1472
|
+
`machine-secret` in its data folder (`~/.toil-ui/`), mode 0600 on macOS and Linux, and
|
|
1473
|
+
reads the same file on every later start. It never leaves the machine and is never
|
|
1474
|
+
printed, logged or sent. When a browser navigates to the page itself
|
|
1475
|
+
(`Sec-Fetch-Dest: document`, `Sec-Fetch-Site` none or same-origin), the server sets
|
|
1476
|
+
the `toil-ui` cookie: a random id, the time, and an HMAC-SHA256 of both with the
|
|
1477
|
+
secret; `HttpOnly` (no script can read it), `SameSite=Strict`, 30 days. It can't be
|
|
1478
|
+
`Secure`, which a browser won't keep over plain `http`. Every API call needs a valid
|
|
1479
|
+
one, compared in constant time. A page on another site can't have it sent with a
|
|
1480
|
+
request, and a cross-site navigation is refused the cookie.
|
|
1481
|
+
- **The peer and the Host header.** The connection must come from loopback, and the
|
|
1482
|
+
`Host` must be `127.0.0.1:<port>`, `localhost:<port>` or `[::1]:<port>`.
|
|
1483
|
+
- **Origin and Fetch Metadata.** An API call whose `Origin` isn't this server's own, or
|
|
1484
|
+
whose `Sec-Fetch-Site` isn't `same-origin`, is refused, and a POST must be
|
|
1485
|
+
`application/json`, which a plain cross-site form cannot send. With the cookie's
|
|
1486
|
+
`SameSite=Strict`, that is why there is no CSRF header.
|
|
1487
|
+
- **No CORS.** No `Access-Control-*` header is ever sent and `OPTIONS` is refused.
|
|
1488
|
+
|
|
1489
|
+
A program that isn't a browser gets the cookie the way a browser does: `GET /` from
|
|
1490
|
+
this machine with `Sec-Fetch-Dest: document` and `Sec-Fetch-Site: none`, then send the
|
|
1491
|
+
`toil-ui=…` value from `Set-Cookie` back in `Cookie` (`ui/scripts/smoke.mjs` does).
|
|
1492
|
+
|
|
1493
|
+
What this does not do: **any program running on this machine as you can read
|
|
1494
|
+
`machine-secret`, or ask for the page as a browser would and get a cookie.** On a
|
|
1495
|
+
shared machine, another account can reach the port too, unless the operating system
|
|
1496
|
+
restricts loopback between users; the secret file itself stays yours. Cookies are not
|
|
1497
|
+
scoped to a port, so another local web server on `127.0.0.1` is sent this cookie
|
|
1498
|
+
too. On Windows the file takes the permissions of your profile folder (restricting it
|
|
1499
|
+
would need `icacls`, a program toil doesn't add). The server runs toil with your own
|
|
1500
|
+
connections, so run `toil-ui` only where you would run a database client. Writes still
|
|
1501
|
+
need the connection's `writes` setting and the Settings page's own confirmations, and
|
|
1502
|
+
secrets are still entered only in Settings, going to the OS credential store.
|
|
1503
|
+
|
|
1504
|
+
**No network but toil's.** It talks to the hosts in your toil connections, and
|
|
1191
1505
|
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.
|
|
1192
1506
|
|
|
1193
1507
|
## Run against a real repository
|
|
@@ -1229,21 +1543,21 @@ GitHub CLI signed in (`gh auth login`), or `TOIL_GITHUB_TOKEN` set in the shell.
|
|
|
1229
1543
|
`--home <dir>` uses another folder.
|
|
1230
1544
|
- **Ask with Codex.** Install the SDK in the clone without saving it
|
|
1231
1545
|
(`npm install --no-save --ignore-scripts @openai/codex-sdk@0.160.0`), then choose
|
|
1232
|
-
Codex under **Settings,
|
|
1546
|
+
Codex under **Settings, AI agent**. The script points `CODEX_HOME` at your real
|
|
1233
1547
|
`~/.codex`, which is where Toil UI finds the `auth.json` it links into its own
|
|
1234
1548
|
Codex home.
|
|
1235
1549
|
- **Ask with GitHub Copilot, on a cheap model.** Install `@github/copilot-sdk@1.0.16`
|
|
1236
|
-
the same way (or press **Install** under **Settings,
|
|
1550
|
+
the same way (or press **Install** under **Settings, AI agent**). The Copilot CLI found
|
|
1237
1551
|
its own sign-in from the scratch home in our runs; if it says it isn't signed in, run
|
|
1238
1552
|
`copilot` once on its own. Then pick the model: Copilot lists the models your
|
|
1239
1553
|
account can use, each with its premium-request multiplier (`/model` in the CLI, or
|
|
1240
1554
|
the SDK's `listModels()`). Choose the lowest, ideally one at 0×; otherwise the
|
|
1241
1555
|
cheapest multiplier, such as `mai-code-1.1-flash` at 0.25×, never a premium model.
|
|
1242
|
-
Type its id as Copilot's model under **Settings,
|
|
1556
|
+
Type its id as Copilot's model under **Settings, AI agent**, and check the model each
|
|
1243
1557
|
answer names and the premium requests under it.
|
|
1244
1558
|
- **Ask with Claude, on Haiku.** Install `@anthropic-ai/claude-agent-sdk@0.3.289` and
|
|
1245
|
-
`zod@4.6.
|
|
1246
|
-
model under **Settings,
|
|
1559
|
+
`zod@4.6.7` the same way, and type `haiku` (or `claude-haiku-5-5`) as Claude's
|
|
1560
|
+
model under **Settings, AI agent**; empty would be Claude Code's own default, which
|
|
1247
1561
|
may be Opus. Claude Code keeps its sign-in in `~/.claude`, which the scratch home
|
|
1248
1562
|
hides, and refreshing it from there would rewrite your credentials file, so the
|
|
1249
1563
|
script only reads it: a `CLAUDE_CODE_OAUTH_TOKEN` or `ANTHROPIC_API_KEY` in the
|
|
@@ -1265,6 +1579,9 @@ One command checks Toil UI the way a reviewer would, and writes what it found to
|
|
|
1265
1579
|
`ui/.verify/report.md` with screenshots beside it (git ignores the folder). Run it
|
|
1266
1580
|
from the root or from `ui/`, and paste the report's table into the PR.
|
|
1267
1581
|
|
|
1582
|
+
Toil UI's unit tests run in Node by default; a test file that renders needs
|
|
1583
|
+
`// @vitest-environment jsdom` as its first line.
|
|
1584
|
+
|
|
1268
1585
|
```bash
|
|
1269
1586
|
npm run verify:ui # build, sample data, real data
|
|
1270
1587
|
npm run verify:ui -- --ask # and one Codex question
|
|
@@ -1276,15 +1593,30 @@ npm run verify:ui -- --no-build --starter standup
|
|
|
1276
1593
|
`.scratch/toil`, which Toil UI runs on, as `dev-real.mjs` does (above). The report's
|
|
1277
1594
|
header and its **Toil** row name that toil: its version, the commit it was built
|
|
1278
1595
|
at, and whether `src/` had uncommitted changes. The run fails if Toil UI didn't
|
|
1279
|
-
resolve `@imagile-dev/toil/api` to it. It also
|
|
1596
|
+
resolve `@imagile-dev/toil/api` to it. It also checks that the toil `npm ci`
|
|
1280
1597
|
installs is the one `ui/package.json` pins (`npm run check:lockfile -w ui`), which
|
|
1281
|
-
is what the published package runs on.
|
|
1598
|
+
is what the published package runs on. Right after a release, until its lockfile PR
|
|
1599
|
+
merges, that check passes with a warning naming the previous toil, and the
|
|
1600
|
+
**Pinned toil** row carries it.
|
|
1282
1601
|
- **Sample data:** `toil-ui --sample` in a throwaway home, every view through the
|
|
1283
1602
|
layout check (`scripts/layout-check.mjs`) in every theme and scheme at 375, 768 and
|
|
1284
1603
|
1440px. On each Toil project's dashboard it also drags a board card to the next column
|
|
1285
1604
|
with real input, a mouse and at 375px a finger, and fails when the card doesn't
|
|
1286
1605
|
follow the pointer or the dropped move doesn't show in the target column. It needs
|
|
1287
|
-
only a browser, so it runs anywhere, CI included.
|
|
1606
|
+
only a browser, so it runs anywhere, CI included. It never waits on a fixed sleep: it
|
|
1607
|
+
waits for each view's heading and fonts, then for the layout to hold still with no
|
|
1608
|
+
finite animation running, and each state it opens waits for its own end (its dialog
|
|
1609
|
+
shown with no loading placeholder, a busy button free again). A layout still changing
|
|
1610
|
+
3s after a step fails the run, naming the step. Theme schemes
|
|
1611
|
+
run side by side, one Chrome per core; `LAYOUT_WORKERS` changes that, though more than
|
|
1612
|
+
the core count starves the states that wait on a streamed answer. The smoke
|
|
1613
|
+
(`npm run smoke -w ui`) runs the same layout check, and CI splits it into eight jobs
|
|
1614
|
+
(`npm run smoke -w ui -- --shard 3/8`): a unit is one theme scheme on one view, and
|
|
1615
|
+
shard k checks every unit whose count modulo 8 is k - 1, so a new theme or view lands
|
|
1616
|
+
in a shard without a list to edit. Each shard still runs the smoke's install,
|
|
1617
|
+
security, live and wipe checks. `verify:ui` is never sharded, and without `--shard`
|
|
1618
|
+
the smoke checks everything, as it does locally and in the daily Windows and macOS
|
|
1619
|
+
run.
|
|
1288
1620
|
- **First run:** `toil-ui` on an empty home, with no connections, no Toil projects and no
|
|
1289
1621
|
`TOIL_*` variable from your shell, through the same check: its Toil projects view must
|
|
1290
1622
|
show the three-step checklist, and the palette and the shortcuts sheet open over it.
|
|
@@ -1304,14 +1636,15 @@ npm run verify:ui -- --no-build --starter standup
|
|
|
1304
1636
|
(#395): that Analyze was kept with its briefing (a recommendation, and its first
|
|
1305
1637
|
three reasons as the history's issues); then it changes the Toil project's WIP limit in the scratch home (`toil projects
|
|
1306
1638
|
wip-limit --replace`), asks Analyze again, checks the history lists both, newest
|
|
1307
|
-
first, the second compared with the first, and puts the Overview, the
|
|
1639
|
+
first, the second compared with the first, and puts the Overview, the earlier briefings
|
|
1308
1640
|
and the second analysis opened through the layout check, shot. It needs the Codex CLI signed in and the
|
|
1309
1641
|
SDK installed in the clone (above). `--adapter copilot` or `--adapter claude` asks that
|
|
1310
1642
|
adapter instead, held to the same checks (Codex is the reference; its MCP check is
|
|
1311
1643
|
skipped), and `--model <id>` sets its model and fails the run when an answer or a
|
|
1312
1644
|
usage record names another one, so a cheap-model run can't quietly use a dear one. Each adapter's full live run, every agent feature on the sandbox, is
|
|
1313
1645
|
recorded in `ui/docs/live-runs/`.
|
|
1314
|
-
- **What fails it:** any layout problem in any theme,
|
|
1646
|
+
- **What fails it:** any layout problem in any theme, a layout still changing 3s after
|
|
1647
|
+
a step, and any axe violation at WCAG
|
|
1315
1648
|
2.2 AA in Plain and Crate. Axe findings in the other themes are listed in the report
|
|
1316
1649
|
and never fail it. Screenshots are of Plain and Crate.
|
|
1317
1650
|
- **It stops** every server and browser it started, and exits 1 on any problem.
|
|
@@ -1340,6 +1673,9 @@ gh repo create <owner>/toil-sandbox --private --add-readme
|
|
|
1340
1673
|
node ui/scripts/seed-sandbox.mjs --owner <owner> --repo toil-sandbox
|
|
1341
1674
|
```
|
|
1342
1675
|
|
|
1676
|
+
`.claude/skills/sandboxes/demo-reset.md` turns the three sandboxes into a recording-ready week (Sprint 44,
|
|
1677
|
+
demo code, agent-ready items); `npm run verify:ui` works on either state.
|
|
1678
|
+
|
|
1343
1679
|
The seed writes through the GitHub CLI's own login, never through toil, and is
|
|
1344
1680
|
safe to run again: what exists is found by name or title and left alone. To start
|
|
1345
1681
|
over, delete the repository (`gh repo delete <owner>/toil-sandbox`, which needs the
|
|
@@ -1347,6 +1683,19 @@ over, delete the repository (`gh repo delete <owner>/toil-sandbox`, which needs
|
|
|
1347
1683
|
board, which needs the `project` scope on the token, and no deployments, which
|
|
1348
1684
|
toil's `github` area doesn't read.
|
|
1349
1685
|
|
|
1686
|
+
The sandbox also holds seven issues for work classification (a dependency bump, a
|
|
1687
|
+
security patch, an upgrade, audit paperwork, one already labelled `feature`, one whose
|
|
1688
|
+
title misleads the built-in signals, and one nothing settles), so a live
|
|
1689
|
+
`toil classify run` has something to tell apart. A Jira test project gets the same
|
|
1690
|
+
seven from `ui/scripts/jira-seed.mjs`, which writes through toil's own
|
|
1691
|
+
`jira issue create --allow-write`, names the project on the command line, and leaves
|
|
1692
|
+
alone any issue that already carries its `seed:<key>` label:
|
|
1693
|
+
|
|
1694
|
+
```bash
|
|
1695
|
+
node ui/scripts/jira-seed.mjs --project <key> --dry-run # what it would create; sends no write
|
|
1696
|
+
node ui/scripts/jira-seed.mjs --project <key> # creates what's missing
|
|
1697
|
+
```
|
|
1698
|
+
|
|
1350
1699
|
### An Azure DevOps Services board
|
|
1351
1700
|
|
|
1352
1701
|
`--source ado` runs the same way against an Azure DevOps Services project, through
|
|
@@ -1398,7 +1747,7 @@ difference, leaving out what the server assigns.
|
|
|
1398
1747
|
toil ado work-item iterations --project "<project>" > board.jsonl
|
|
1399
1748
|
toil ado work-item get-many <ids…> >> board.jsonl
|
|
1400
1749
|
toil ado work-item history <id> >> board.jsonl # once for each id
|
|
1401
|
-
toil util owi map board.jsonl > mapped.json
|
|
1750
|
+
toil util owi map --input-file board.jsonl > mapped.json
|
|
1402
1751
|
node ui/scripts/ado-seed/compare.mjs mapped.json --project "<project>" --backdated
|
|
1403
1752
|
```
|
|
1404
1753
|
|