@thermai/flightdeck-cli 0.1.0-pilot.6 → 0.1.0-pilot.8

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.
Files changed (3) hide show
  1. package/README.md +74 -17
  2. package/dist/index.js +1886 -40
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -15,8 +15,8 @@ versioned GitHub Release workflow, not merely by merging a version change. The
15
15
  installation command below follows the published `next` channel without
16
16
  tracking an unpublished candidate version.
17
17
  Proprietary terms in `LICENSE` permit redistribution of unchanged official
18
- releases. Internal service qualification is still in progress; package
19
- availability does not open partner onboarding.
18
+ releases. Service access still requires an invitation, configured credits and
19
+ the agreed pilot limits; installing the package alone does not grant access.
20
20
 
21
21
  **`0.1.0-pilot.3`** was published through GitHub Actions on 8 September 2026,
22
22
  including complete log pagination and concise authentication errors. Its
@@ -28,17 +28,46 @@ requires a backend advertising `X-Flightdeck-Accounting: credits-v1`. Upgrade
28
28
  with the install command below before accessing account/job data. An incompatible
29
29
  backend is rejected before job submission; login and credential revocation do not require
30
30
  the accounting contract. See the
31
- [operator rollout checklist](../docs/runbooks/customer-credits-rollout.md).
31
+ operator rollout checklist (`flightdeck-ops/runbooks/customer-credits-rollout.md`).
32
32
 
33
33
  **`0.1.0-pilot.5`**, published on 21 September 2026, fixes result downloads redirected to signed object
34
34
  storage ([#157](https://github.com/ThermAI-Group/thermai_flightdeck/issues/157))
35
35
  and includes the merged GPU-recovery status display. Downloads validate the
36
36
  accounting contract on Flightdeck's response, then fetch the authorized storage
37
37
  object without forwarding the CLI credential. Anonymous Node 22 installation
38
- and a live result download passed; `next` selects this version. Upgrade from
38
+ and a live result download passed. Upgrade from
39
39
  pilot.4 before downloading results. Future releases still require an approved
40
40
  versioned GitHub Release; merging alone does not publish.
41
41
 
42
+ **`0.1.0-pilot.6`**, published on 21 September 2026, adds
43
+ offline-first logout and explicit suspension messages. Release CI, registry
44
+ integrity and anonymous Node 22 installation passed; grouped live acceptance
45
+ was confirmed by the operator on 24 September. These are historical pilot.6
46
+ results, not pilot.7 publication evidence. This update does not modify the
47
+ README inside the already-published immutable tarball.
48
+
49
+ **`0.1.0-pilot.7`**, published on 1 October 2026, adds the read-only
50
+ `flightdeck atc` terminal view (alias `tui`), flight details/events/logs, name
51
+ filtering and local sbatch-array tracking from
52
+ [PR #206](https://github.com/ThermAI-Group/thermai_flightdeck/pull/206).
53
+ Downloads/cancellation inside ATC remain deferred to #205; stale
54
+ fallback-status indication is tracked in #207.
55
+
56
+ **`0.1.0-pilot.8`** adds `flightdeck admin flights` for organisation and
57
+ platform administrators ([PR #281](https://github.com/ThermAI-Group/thermai_flightdeck/pull/281)).
58
+ It needs a credential approved through `flightdeck login --admin`; existing
59
+ credentials keep working for every other command, so administrators run
60
+ `flightdeck logout` then `flightdeck login --admin` only when they want the
61
+ admin view. `flightdeck login` now defaults the credential name to
62
+ `flightdeck-cli@<hostname>` so a second machine no longer collides (#254), and
63
+ `flightdeck sbatch` prints a runnable status hint with the submitted flight ID
64
+ and labels the job ID on the ATC hint (#257, #259). The required backend is
65
+ already deployed; there are no new runtime dependencies. Publication requires the
66
+ approved `cli-v0.1.0-pilot.8` GitHub prerelease and a successful release workflow.
67
+ After publication, use the generated `@next` command below, or pin
68
+ `@thermai/flightdeck-cli@0.1.0-pilot.8`, and confirm `flightdeck --version`
69
+ reports `0.1.0-pilot.8`.
70
+
42
71
  Members and organization administrators receive whole-credit balances,
43
72
  estimates and actual customer charges, without provider-cost information.
44
73
  Platform administrators retain their authorized monetary API fields. Credits
@@ -77,7 +106,11 @@ permissions. Never share that file or include it in a workload bundle. Use
77
106
  `flightdeck logout` to remove the local login and attempt server revocation.
78
107
  Portal credential management can revoke an individual workstation as well.
79
108
 
80
- `--name` labels a credential, not a local account profile. There is one saved
109
+ `--name` labels a credential, not a local account profile. It defaults to
110
+ `flightdeck-cli@<short hostname>`, which is shown on the approval page, in
111
+ credential lists, and in the audit history; pass `--name` to choose another
112
+ label. Active credential names must be unique per account, so machines that
113
+ share a short hostname need distinct `--name` values. There is one saved
81
114
  login per OS user. If already logged in, use `whoami` to inspect it; `login`
82
115
  refuses to replace it. Use a separate OS user to preserve an operator's working
83
116
  credential, or explicitly choose logout/re-login on the same workstation.
@@ -85,14 +118,14 @@ Logging out removes the saved credential; it does not delete the account or its
85
118
  roles. A later login creates a new credential. Check the separate revocation
86
119
  result: other copies may remain valid if server revocation was not confirmed.
87
120
 
88
- The next CLI release also explains `account_suspended`, `membership_suspended`
121
+ Pilot.6 explains `account_suspended`, `membership_suspended`
89
122
  and `organization_suspended` denials during device login and authenticated
90
123
  commands. Contact your organization administrator; organization suspension may
91
124
  need ThermAI support. These are access restrictions, not a missing local login
92
125
  or a request for additional credential scopes. Other 403 responses retain
93
126
  generic permissions guidance. Commands still exit nonzero and do not print
94
- server-supplied messages or stack traces. Published pilot.5 does **not** yet
95
- include these messages; merging the change does not publish a CLI release.
127
+ server-supplied messages or stack traces. Older pilot.5 installations need an
128
+ explicit upgrade to receive these messages.
96
129
 
97
130
  ## Pilot quick-start
98
131
 
@@ -100,7 +133,7 @@ Before live use, your ThermAI operator must provision your organization/account,
100
133
  provide a single-use portal invitation, and approve your policy and credit.
101
134
  Activate through the portal, then follow the installation/login commands above.
102
135
  Confirm the expected account with `whoami` and the available credit with
103
- `balance`. The internal proving run comes before partner invitations.
136
+ `balance`. ThermAI will guide the first partner submission under the agreed limits.
104
137
 
105
138
  For a **local-only** readiness check, save the following as `readiness.sbatch`
106
139
  in a new empty directory. Run the dry run from that directory; no account,
@@ -138,7 +171,7 @@ the current directory. Never include credentials or private workstation files.
138
171
 
139
172
  ## Workload commands
140
173
 
141
- After internal qualification and explicit policy/credit approval:
174
+ After your account's policy/credit setup and agreed first-run approval:
142
175
 
143
176
  ```sh
144
177
  flightdeck sbatch workload.sbatch
@@ -155,7 +188,8 @@ supports a subset of single-node Slurm directives, not an arbitrary HPC cluster.
155
188
  Workload images must satisfy the Flightdeck runner contract.
156
189
 
157
190
  An array prints a separate Flightdeck ID for each accepted task. Record them
158
- all: inspect, download and cancel each flight individually. Partial submission
191
+ all: inspect, download and cancel each flight individually (`flightdeck atc
192
+ <job-id>` shows them together). Partial submission
159
193
  can leave accepted flights running even if the command exits unsuccessfully;
160
194
  do not blindly resubmit the whole array. Choose a fresh download directory for
161
195
  each flight: downloads use filename basenames and refuse to overwrite existing
@@ -196,13 +230,37 @@ partial read. Older `0.1.0-pilot.2` installations do not contain this fix;
196
230
  merging source alone neither replaces that immutable package nor publishes a
197
231
  new version. Older non-following clients still need upgrading for full paging.
198
232
 
233
+ ### Watching flights live
234
+
235
+ `flightdeck atc` (alias `flightdeck tui`) opens a read-only, full-screen view in
236
+ the current terminal. Arrow keys select, Enter shows a flight's details and
237
+ events, `l` opens its logs (scroll, `f` to follow), `r` refreshes, Esc goes back
238
+ and `q` quits. It never cancels, submits or downloads anything.
239
+
240
+ ```sh
241
+ flightdeck atc # your recent flights (last 50)
242
+ flightdeck atc <flight-id> # one flight
243
+ flightdeck atc <job-id> # an sbatch array submitted from this machine
244
+ flightdeck atc --name 'molsim*' # flights whose name matches, among your last 200
245
+ flightdeck atc --demo # a simulated array; no account or credits needed
246
+ ```
247
+
248
+ `flightdeck sbatch` records each array's flight IDs under
249
+ `~/.flightdeck/batches/` and ends with `Watch live: flightdeck atc <job-id>`;
250
+ that job ID is the one to pass. It is a local sbatch job ID, not a flight ID:
251
+ `status`, `logs`, `outputs`, `download` and `cancel` take the `fl-…` flight
252
+ IDs printed for each task. The record exists only on the machine that
253
+ submitted it (if it could not be written, sbatch says so; use `--name`). Name
254
+ patterns are case-sensitive. Leaving the view does not stop any job. In
255
+ scripts, keep using `status` and `logs`.
256
+
199
257
  ### Error handling and support
200
258
 
201
259
  The CLI exits with status 1 on command failure. Expected authentication,
202
260
  network and HTTP failures have concise diagnostics instead of a Node stack.
203
261
  An already-configured login leaves the saved credential unchanged.
204
262
 
205
- **Next-release logout behavior (#143):** remove the local file first, then make
263
+ **Pilot.6 logout behavior (#143):** remove the local file first, then make
206
264
  one best-effort server revocation request with a three-second deadline, including
207
265
  the response body. Offline, suspended, failed or malformed API responses cannot
208
266
  retain or restore the local login. Local success exits 0; a warning separately
@@ -213,11 +271,10 @@ Missing local login is a successful no-op; malformed config is removed without
213
271
  trusting its contents for a request. No credential recovery/retry file is saved.
214
272
  `logout --local` removes only the local copy and makes no network request.
215
273
 
216
- This change is not in the published `0.1.0-pilot.5` package. Until the next
217
- approved release, use `flightdeck logout --local` if ordinary logout is blocked;
218
- it does not revoke remote access. A new backend release is also needed to permit
219
- a valid named credential to revoke itself while its account or organization is
220
- suspended. These changes do not permit ordinary access under suspension.
274
+ Older pilot.5 does not include this change; use `flightdeck logout --local`
275
+ as a local-removal workaround before upgrading. It does not revoke remote
276
+ access. The current production backend permits narrowly authenticated
277
+ self-revocation under suspension; ordinary access remains blocked.
221
278
 
222
279
  For unexpected faults, `flightdeck --debug <command>` adds allowlisted error
223
280
  types/codes and bundled CLI line locations, not raw stacks or error bodies.