recess-cli 3.10.0 → 3.11.0

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/dist/help.js CHANGED
@@ -13,8 +13,10 @@ Usage:
13
13
  [--node <node-id>] [--confirm]
14
14
  recess [--json] mastery unlink <link-id> [--confirm]
15
15
  recess [--json] --version
16
- recess [--json] help [noun] [verb]
17
- recess [--json] agent-context
16
+ recess [--json] help [noun] [verb] [--all]
17
+ recess [--json] agent-context [noun] [verb] [--full]
18
+ recess [--json] confirm <operation-key>
19
+ [--confirm-destructive-changes --destructive-change-token TOKEN]
18
20
  recess [--json] setup [--skill-only]
19
21
  recess [--json] doctor
20
22
  recess [--json] update [--confirm]
@@ -59,7 +61,7 @@ Usage:
59
61
  recess [--json] users tier preview <kid-id> --tier social|academics|lite|complete|platform
60
62
  [--slots N]
61
63
  recess [--json] users tier set <kid-id> --tier social|academics|lite|complete|platform
62
- [--slots N] --expected-updated-at <iso> [--allow-strand] [--confirm]
64
+ [--slots N] [--expected-updated-at <iso>] [--allow-strand] [--confirm]
63
65
  recess [--json] guides create --email <email> --first-name TEXT
64
66
  [--last-name TEXT] [--no-invite] [--confirm]
65
67
  recess [--json] guides invite --user <user-id> [--confirm]
@@ -74,6 +76,7 @@ Usage:
74
76
  recess [--json] students upload-map-scores --student <kid-id>
75
77
  --file </path/to/map-report.pdf> [--confirm]
76
78
  recess [--json] students issue-email --student <kid-id> [--confirm]
79
+ recess [--json] students notes add --student <kid-id> --text TEXT [--confirm]
77
80
  recess [--json] chat-logs list --student <user-id> [--limit 100] [--cursor <cursor>]
78
81
  recess [--json] chat-logs get <conversation-id>
79
82
  recess [--json] chat-logs by-todo <todo-id>
@@ -95,7 +98,7 @@ Usage:
95
98
  recess [--json] billing resume --subscription <id> [--confirm]
96
99
  recess [--json] invoices refund --invoice <id> --line-item <id>
97
100
  --method refund|credit|tokens [--full | --amount-cents N]
98
- [--who-pays guide|recess] [--reason TEXT] [--confirm]
101
+ [--who-pays guide|recess] [--refund-reason TEXT] [--confirm]
99
102
  recess [--json] apps init <dir> [--for-todo <todo-id>] [--force]
100
103
  recess [--json] apps scaffold [--for-todo <todo-id>]
101
104
  recess [--json] apps preview [dir] [--port N]
@@ -120,14 +123,14 @@ Usage:
120
123
  recess [--json] applications disposition <application-id>
121
124
  --data-file <disposition.json> [--confirm]
122
125
  recess [--json] applications qualify <application-id>
123
- --quality QUALIFIED|NEEDS_NURTURE|UNKNOWN --reason TEXT [--confirm]
126
+ --quality QUALIFIED|NEEDS_NURTURE|UNKNOWN [--override-reason TEXT] [--confirm]
124
127
  recess [--json] applications update-contact <application-id>
125
128
  --data-file <contact.json> [--confirm]
126
129
  recess [--json] applications claim-email|claim-link <application-id>
127
130
  --intent-key <uuid> [--supersede] [--confirm]
128
131
  recess [--json] applications revoke-claim <application-id> [--confirm]
129
132
  recess [--json] applications link-family <application-id> --family <family-id> [--confirm]
130
- recess [--json] applications close <application-id> --reason TEXT [--confirm]
133
+ recess [--json] applications close <application-id> [--close-reason TEXT] [--confirm]
131
134
  recess [--json] applications add-call-note <application-id>
132
135
  --data-file <call-note.json> [--confirm]
133
136
  recess [--json] applications edit-call-note <application-id>
@@ -154,17 +157,17 @@ Usage:
154
157
  recess [--json] billing extend-trial --subscription <id>
155
158
  --trial-end ISO_DATE [--confirm]
156
159
  recess [--json] billing cancel-subscription --subscription <id>
157
- [--immediate] [--reason TEXT] [--restore] [--confirm]
160
+ [--immediate] [--cancel-reason TEXT] [--restore] [--confirm]
158
161
  recess [--json] payout payruns list [--status A,B] [--schedule <id>]
159
162
  recess [--json] payout recipients list [--search <name>] [--user <id>] [--id <id>] [--include-archived]
160
163
  [--limit 20] [--cursor <id>]
161
164
  recess [--json] payout invoices list [--payrun <id>] [--recipient <account-id>]
162
165
  [--user <id>] [--status A,B] (at least one filter)
163
- recess [--json] payout recipients archive <account-id> [--zero-balance] [--confirm]
166
+ recess [--json] payout recipients archive <account-id> [--zero-balance [--zero-balance-reason TEXT]] [--confirm]
164
167
  recess [--json] payout recipients unarchive <account-id> [--confirm]
165
- recess [--json] payout recipients remove-schedule <account-id> --schedule <id> [--zero-balance] [--confirm]
168
+ recess [--json] payout recipients remove-schedule <account-id> --schedule <id> [--zero-balance [--zero-balance-reason TEXT]] [--confirm]
166
169
  recess [--json] payout recipients add-schedule <account-id> --schedule <id> [--confirm]
167
- recess [--json] payout payruns remove-account <payrun-id> --recipient <account-id> [--zero-balance] [--confirm]
170
+ recess [--json] payout payruns remove-account <payrun-id> --recipient <account-id> [--zero-balance [--zero-balance-reason TEXT]] [--confirm]
168
171
  recess [--json] payout invoices get <invoice-id>
169
172
  recess [--json] payout invoices set-status <invoice-id>
170
173
  --status IN_REVIEW|OPEN|PAID|CANCELED [--send-email] [--confirm]
@@ -177,8 +180,9 @@ Usage:
177
180
  recess [--json] channels list [<query>...] [--type <channel-type>] [--audience KID|PARENT]
178
181
  [--status ACTIVE|HIDDEN|ARCHIVED] [--limit 1..200]
179
182
  recess [--json] channels create --name TEXT [--type <channel-type>]
180
- [--audience KID|PARENT|NONE] [--description TEXT] [--image <path>] [--no-join] [--confirm]
183
+ [--audience KID|PARENT|NONE] [--description TEXT] [--image <path>] [--no-join] [--staff-only] [--confirm]
181
184
  recess [--json] channels set-image <channel-id> [path] [--clear] [--confirm]
185
+ recess [--json] channels staff-only <channel-id> on|off [--confirm]
182
186
  recess [--json] channels join <channel-id> [--confirm]
183
187
  recess [--json] channels members list <channel-id> [--include-left]
184
188
  recess [--json] channels members add <channel-id> <user-id...> [--role MEMBER|MODERATOR|ADMIN] [--confirm]
@@ -186,11 +190,11 @@ Usage:
186
190
  recess [--json] channels members remove <channel-id> <user-id...> [--confirm]
187
191
  recess [--json] tuition-plans generate --parent TEXT --student TEXT [--dob YYYY-MM-DD]
188
192
  --state XX --start YYYY-MM-DD --annual DOLLARS --enrollment direct|partner-school
189
- [--partner-school <slug|id>] [--state-funding] [--elective-price DOLLARS]
193
+ [--partner-school <slug|id>] [--force-direct] [--state-funding] [--elective-price DOLLARS]
190
194
  [--one-on-one-price DOLLARS] [--one-on-one-sessions N] [--end YYYY-MM-DD]
191
195
  [--terms full-year,school-year,custom] [--payments upfront,installments]
192
196
  [--note TEXT]... [--bill-date upfront|N=YYYY-MM-DD]... [--even-installments]
193
- [--pdf <path>] [--open]
197
+ [--esa-award-unknown [--esa-scenarios DOLLARS,...]] [--pdf <path>] [--open]
194
198
  recess [--json] tuition-plans states
195
199
  recess [--json] cohorts get <cohort-id> [--events-tab ACTIVE|ENDED|CANCELED|ARCHIVED]
196
200
  recess [--json] cohorts schedule get <cohort-id>
@@ -208,7 +212,7 @@ Usage:
208
212
  recess [--json] events list --date YYYY-MM-DD [--timezone <iana>] [--search TEXT]
209
213
  recess [--json] events take-attendance <event-id> --attended <id,id,...>
210
214
  [--absent <id,id,...>] [--excused <id,id,...>] [--confirm]
211
- recess [--json] events cancel <event-id> --reason TEXT [--confirm]
215
+ recess [--json] events cancel <event-id> --message TEXT [--confirm]
212
216
  recess [--json] events set-status <event-id> --status ACTIVE|ENDED|CANCELED [--confirm]
213
217
  recess [--json] events reschedule --cohort <id> --event <event-id>
214
218
  --starts-at "YYYY-MM-DDTHH:MM" [--timezone <iana>] [--length-mins N] [--confirm]
@@ -287,7 +291,7 @@ Usage:
287
291
  --family <family-id> --attended true|false [--confirm]
288
292
  recess [--json] onboarding meeting-reschedule <meeting-id>
289
293
  --starts-at <iso> [--note TEXT] [--confirm]
290
- recess [--json] onboarding meeting-cancel <meeting-id> --reason TEXT [--confirm]
294
+ recess [--json] onboarding meeting-cancel <meeting-id> --message TEXT [--confirm]
291
295
  recess [--json] onboarding set-intake <family-id> --session <id>
292
296
  --data <json> [--expected-updated-at <iso>] [--confirm]
293
297
  recess [--json] onboarding extract <family-id> --session <id>
@@ -397,7 +401,7 @@ Usage:
397
401
  recess [--json] goal-templates get <template-id|slug> [--spec-only]
398
402
  recess [--json] goal-templates policy <template-id|slug>
399
403
  recess [--json] goal-templates set-policy <template-id|slug> --recipe KEY
400
- [--target-modules N] [--required-modules N|all] --expected-version N
404
+ [--target-modules N] [--required-modules N|all] [--expected-version N]
401
405
  [--confirm --approval-token TOKEN]
402
406
  recess [--json] goal-templates migrate-policy <template-id|slug> --students ID,ID
403
407
  [--confirm --approval-token TOKEN]
@@ -422,16 +426,16 @@ Usage:
422
426
  recess [--json] goal-templates validate-spec --file <path/template.json>
423
427
  recess [--json] goal-templates create --file <path/template.json>
424
428
  [--coin-amount N] [--confirm]
425
- recess [--json] goal-templates patch-spec <template-id|slug> --expected-version N
429
+ recess [--json] goal-templates patch-spec <template-id|slug> [--expected-version N]
426
430
  --patches-file <path/patches.json> [--confirm --approval-token TOKEN]
427
431
  [--confirm-destructive-changes --destructive-change-token TOKEN]
428
- recess [--json] goal-templates set-metadata <template-id> --expected-version N
432
+ recess [--json] goal-templates set-metadata <template-id> [--expected-version N]
429
433
  [--title TEXT] [--description TEXT] [--emoji X] [--category TEXT] [--tags A,B]
430
434
  [--image-url URL] [--coin-amount N] [--sort-order N] [--is-starter true|false]
431
435
  [--setup-audience KID_FRIENDLY|PARENT_SETUP] [--kind SIMPLE|BLUEPRINT]
432
436
  [--visibility PUBLIC|PRIVATE|STAFF_ONLY] [--target-platform ANY|MOBILE|DESKTOP]
433
437
  [--agent-instructions-file <path>] [--output-template-file <path>] [--confirm]
434
- recess [--json] goal-templates delete <template-id> --expected-version N [--confirm]
438
+ recess [--json] goal-templates delete <template-id> [--expected-version N] [--confirm]
435
439
  recess [--json] goal-templates generate-image <template-id|slug>
436
440
  [--prompt TEXT] [--confirm]
437
441
  recess [--json] goal-templates snapshot-files <template-id> [--path P]
@@ -439,8 +443,10 @@ Usage:
439
443
  (--source-goal <goal-id> | --source-draft <draft-slug> --student <goal-owner-id>
440
444
  | --source-dir <local-checkout>)
441
445
  [--dry-run] [--confirm --approval-token TOKEN]
442
- recess [--json] goal-templates apply <template-id> --answers-file <path>
443
- [--dry-run] [--confirm --approval-token TOKEN]
446
+ recess [--json] goal-templates answers-template <template-id|slug>
447
+ [--student <kid-id-or-name>]
448
+ recess [--json] goal-templates apply <template-id> [--student <kid-id-or-name>]
449
+ [--answers-file <path>] [--dry-run] [--confirm --approval-token TOKEN]
444
450
  recess [--json] goal-templates apply-starter <template-id> --student <kid-id>
445
451
  [--answers-file <path>] [--confirm]
446
452
  recess [--json] goals list --student <kid-id> [--query <text>] [--include-archived]
@@ -492,7 +498,7 @@ Usage:
492
498
  recess [--json] memories log --student <kid-id> --date YYYY-MM-DD
493
499
  recess [--json] rocky get --student <kid-id>
494
500
  recess [--json] rocky set --student <kid-id> --patch-file <path/patch.json>
495
- --expected-updated-at ISO|none [--confirm]
501
+ [--expected-updated-at ISO|none] [--confirm]
496
502
  recess [--json] tutor-templates list [--q TEXT] [--subject TEXT] [--grade N]
497
503
  recess [--json] tutor-templates get <slug>
498
504
  recess [--json] tutor-templates assign <slug> [--student <kid-id>] [--confirm]
@@ -512,7 +518,7 @@ Usage:
512
518
  recess [--json] goals files list --student <goal-owner-id> --goal <goal-id>
513
519
  recess [--json] goals files read --student <goal-owner-id> --goal <goal-id> --path P
514
520
  recess [--json] goals files init --student <goal-owner-id> --draft <draft-slug>
515
- --output-dir <local-dir>
521
+ --output-dir <local-dir> [--scaffold [--title TEXT] [--modules N]]
516
522
  recess [--json] goals files checkout --student <goal-owner-id>
517
523
  (--goal <goal-id> | --draft <draft-slug>)
518
524
  --output-dir <local-dir>
@@ -557,8 +563,11 @@ converted back, so "validate-spec" against the same file until it passes, then
557
563
  "create". "create" runs a real server-side validation before its gate, so the
558
564
  preview shows the handler/goalShape/step keys the SERVER resolved. "apply" runs
559
565
  the backend's own dryRun before the gate and previews the per-student outcome.
560
- "set-metadata" and "delete" require --expected-version (from "get"); a stale one
561
- 409s STALE_WRITE and writes nothing. The spec is unreachable from "set-metadata"
566
+ "set-metadata", "delete", "patch-spec" and "set-policy" take an optional
567
+ --expected-version; omitted, the current version is read and pinned into the
568
+ preview, so a change before confirm is refused. A stale one 409s STALE_WRITE.
569
+ --student on goal, todo, goal-file and template-apply commands takes an ID or an
570
+ exact roster name. "answers-template" prints a fillable answers file for "apply". The spec is unreachable from "set-metadata"
562
571
  by design — an existing spec is edited only through the guarded /ai patch path.
563
572
 
564
573
  School-onboarding workflow notes: "onboarding family" is the one-screen view
@@ -637,8 +646,8 @@ current token at confirm time and warns that post-preview edits are unprotected.
637
646
  server-side.
638
647
 
639
648
  Class-ops notes: "events cancel" notifies families (chat + parent email blast +
640
- credit notes + Slack); "events set-status --status CANCELED" is a silent status
641
- change. Reschedule times are cohort-local wall-clock (zoneless).
649
+ credit notes + Slack) with its --message text verbatim (--reason stays in the
650
+ audit log); "events set-status --status CANCELED" is a silent status change. Reschedule times are cohort-local wall-clock (zoneless).
642
651
 
643
652
  Channel notes: channel types are COMMUNITY (default), SYSTEM_GENERATED,
644
653
  COHORT_PARENT, DIRECT_MESSAGE, GROUP_MESSAGE, COURSE_REQUEST, RECESS_EVENT,
@@ -649,7 +658,9 @@ and COHORT_PARENT to PARENT (--audience NONE clears it). Non-community types
649
658
  created here stand alone: nothing links them to a cohort, event, challenge, or
650
659
  course. "members add" also rejoins past members and applies --role to everyone
651
660
  named; kids are refused from PARENT-audience and COHORT_PARENT channels.
652
- "members remove" is soft (sets leftAt) and posts a LEFT notice. Images
661
+ "members remove" is soft (sets leftAt) and posts a LEFT notice. Staff-only
662
+ channels (--staff-only, staff-only on|off) let only staff send: admins, guides,
663
+ program staff, moderators, and channel admins/moderators. Images
653
664
  (--image, set-image) are .png/.jpg/.gif/.webp, 10MB max.
654
665
 
655
666
  Family address notes: "families set-addresses --file" takes a JSON array of
@@ -663,13 +674,16 @@ Tuition-plan notes: "generate" computes a Recess Academy tuition plan (nothing i
663
674
  stored): a 180-instructional-day term at --annual (tuition net of Recess aid) and
664
675
  a term through the state's typical school-year end. Each is paid in full upfront
665
676
  (5% off, per /school/tuition) or quarterly; Florida is instead cash upfront or
666
- monthly in arrears (Step Up pays only in arrears). --state-funding (family pays
677
+ monthly (invoiced mid-month, due at month end, the final payment due on the last
678
+ day of school; Step Up pays only in arrears), in fixed monthly amounts
679
+ only: --annual in Florida must be 8000, 9000, 11000, 14500, or 18000. --state-funding (family pays
667
680
  with ESA funds) makes quarters follow the state's ESA funding dates where Recess
668
681
  has them (AZ). It returns the /admin/tuition-plans web URL (--open opens it)
669
682
  and, with --pdf, writes the letterhead PDF to that path. "states" lists the
670
683
  supported states and their year-end dates. --enrollment partner-school
671
- (with --partner-school, e.g. wonder-ed) marks the plan an estimate: the partner
672
- school of record makes the final determination. Add-on prices default to
684
+ (with --partner-school, e.g. wonder-ed) names the partner as the school of record
685
+ and says tuition payments go to it, on the tuition page and the signing page. Florida students enroll through a
686
+ partner institution: a direct Florida plan is refused unless --force-direct. Add-on prices default to
673
687
  $160/month per extra elective and $400 per 4 tutoring sessions; --elective-price,
674
688
  --one-on-one-price, and --one-on-one-sessions override them on this sheet.
675
689
  --end YYYY-MM-DD adds a custom term through that date (priced by school days).
@@ -681,6 +695,19 @@ moves an invoice date: upfront=YYYY-MM-DD for pay in full, N=YYYY-MM-DD for
681
695
  installment N in every term; due dates follow and dates must stay in order.
682
696
  --even-installments splits each installment plan evenly in whole dollars (any
683
697
  remainder on the first payment) instead of pricing each by its school days.
698
+ --esa-award-unknown is for a family with no ESA award yet: --annual is their
699
+ income-based price with no award, and the sheet opens with two pages (PDF pages
700
+ 1-2) before any price: who pays tuition (the award first, then Recess aid, then
701
+ the family) with the aid ground rules, then a chart of example awards. The
702
+ examples and wording follow the state: Arizona charts $7,300 (universal ESA),
703
+ $14,000, and $34,000; Florida says "scholarship" and charts $8,000, $10,000,
704
+ and $23,000; other states chart their typical award where one is on file.
705
+ --esa-scenarios replaces the examples (up to
706
+ six, comma-separated). Tuition is not final until the award is confirmed, so the
707
+ tuition page lists installments on the ESA funding quarters (no pay in full): a
708
+ start too late for approval (~30 days) to land in its quarter bills that quarter
709
+ now with no award; every other payment shows "up to" its no-award amount. The
710
+ agreement adds a clause that the plan is re-issued once the award is confirmed.
684
711
 
685
712
  Payout notes: amounts are integer cents. "payout items add" without --date
686
713
  defaults the item date to the penultimate day of the invoice's cycle (its
@@ -703,13 +730,420 @@ server when the served bundle's minCliVersion allows — an older binary keeps t
703
730
  bundled copy, and an unreachable server is not an error. "doctor" reports whether
704
731
  a newer skill exists and names the command; it never writes.
705
732
 
706
- Writes preview and exit 2 unless --confirm is supplied after explicit human approval.
707
- Every preview includes an operationKey; confirmed writes must echo it with
708
- --operation-key so an interrupted invocation can be retried without duplicating the write.
733
+ Writes preview and exit 2 until confirmed after explicit human approval. Every
734
+ preview includes an operationKey. Simplest confirm: "recess confirm <operation-key>"
735
+ replays the stored preview. Equivalently, rerun the same command with --confirm
736
+ --operation-key KEY; either way an interrupted invocation can be retried without
737
+ duplicating the write.
738
+ Output is a JSON envelope by default when stdout is not a terminal or
739
+ RECESS_CLI_JSON=1; --json forces it, --pretty (or --no-json) forces human output.
709
740
  Environment overrides: RECESS_CLI_API_ORIGIN, RECESS_CLI_WEB_ORIGIN,
710
741
  RECESS_CLI_OAUTH_CLIENT_ID, RECESS_CLI_COOKIE, RECESS_CLI_CONFIG,
711
742
  RECESS_CLI_PROFILE, RECESS_CLI_FEEDBACK_ENDPOINT.
712
743
 
713
- Every command that calls the Recess API, except auth commands, requires
714
- --reason TEXT: a non-empty human-readable purpose of at most 1024 characters.`;
744
+ --reason TEXT is the audit-log purpose (non-empty, at most 1024 characters) and
745
+ is never sent to families. Writes require it; reads default it to
746
+ "Read: <command>". Family- or record-facing text has its own flag (--message,
747
+ --refund-reason, --cancel-reason, --override-reason, --close-reason,
748
+ --zero-balance-reason).`;
749
+ /**
750
+ * One line per command path: what it does / when to reach for it. Shown under
751
+ * the usage in `help` and as `summary` in `agent-context`. Keyed by the exact
752
+ * command path (`buildCommandSchema` splits `a|b` variants into two paths).
753
+ */
754
+ export const COMMAND_SUMMARIES = {
755
+ "mastery graphs": "List mastery graphs, optionally for one domain.",
756
+ "mastery get": "Read a mastery graph (seed, draft, or release).",
757
+ "mastery edit": "Edit a mastery graph from a JSON file or an LLM instruction into a draft.",
758
+ "mastery publish": "Publish a draft as the active release (CAS on the current release).",
759
+ "mastery delete-draft": "Delete an unpublished mastery-graph draft.",
760
+ "mastery archive": "Archive a mastery-graph release.",
761
+ "mastery links": "List content linked to a mastery graph (or one node).",
762
+ "mastery link": "Link an applet or goal to a mastery-graph node.",
763
+ "mastery unlink": "Remove a mastery-graph content link.",
764
+ "--version": "Print the CLI and bundled skill versions.",
765
+ help: "Show usage, summaries, and notes for a noun (--all: every command).",
766
+ "agent-context": "Machine-readable command catalog for agents (compact; --full for every flag).",
767
+ confirm: "Execute a previewed write by replaying its stored preview (simplest confirm path).",
768
+ setup: "Install the CLI's agent skill (and upgrade it from the server).",
769
+ doctor: "Check config, session, and skill freshness; never writes.",
770
+ update: "Update the recess CLI to the latest release.",
771
+ "profile list": "List saved API/web origin profiles.",
772
+ "profile show": "Show one saved profile.",
773
+ "profile save": "Save a named profile of API/web origins.",
774
+ "profile use": "Make a saved profile the active one.",
775
+ "profile delete": "Delete a saved profile.",
776
+ "jobs list": "List locally recorded write operations (by operation key).",
777
+ "jobs get": "Show one recorded write operation and its result.",
778
+ "jobs prune": "Delete old local operation records.",
779
+ "feedback list": "List feedback you have submitted about the CLI.",
780
+ "feedback submit": "Send feedback about the CLI to the Recess team.",
781
+ "auth login": "Sign in through the browser (loopback flow).",
782
+ "auth request": "Headless sign-in: print an approval URL a signed-in human opens.",
783
+ "auth poll": "Collect the session after an auth request is approved.",
784
+ "auth status": "Show the current session's user, role, and CLI scope.",
785
+ "auth logout": "Sign out and delete the stored session.",
786
+ "users search": "Find users by name, email, or id.",
787
+ "users get": "Read a user's account, family, roles, and flags.",
788
+ "users school complete-action": "Mark a school-enrollment action done.",
789
+ "users school status": "Show a kid's school-enrollment status and actions.",
790
+ "users school history": "List a kid's school-enrollment history.",
791
+ "users school withdraw": "Withdraw a kid from school enrollment.",
792
+ "users school restore": "Restore a withdrawn kid's school enrollment.",
793
+ "users enrollment history": "List a kid's enrollment-entity changes.",
794
+ "users enrollment set-partner-school-cc": "Set or clear the CC email for a partner school.",
795
+ "users enrollment list-partner-schools": "List partner schools.",
796
+ "users enrollment set": "Set which entity a kid is enrolled through (program/school/partner).",
797
+ "users phone get": "Read a user's phone number and verification.",
798
+ "users phone set": "Set a user's phone number (stored E.164, unverified).",
799
+ "users phone clear": "Remove a user's phone number.",
800
+ "users lock": "Lock a kid's account (with their family's guardians).",
801
+ "users unlock": "Unlock a kid's account with their guardians; rerun = Refresh Unlock.",
802
+ "users disable": "Soft-disable an account or whole family (reversible; refuses live billing).",
803
+ "users restore": "Restore a disabled account to a named role.",
804
+ "users tier list-tiers": "List membership tiers and their slots.",
805
+ "users tier get": "Show a kid's membership tier and slots.",
806
+ "users tier preview": "Preview the effect of a tier change (no write).",
807
+ "users tier set": "Change a kid's membership tier and slots.",
808
+ "guides create": "Create a guide account (and send the invite).",
809
+ "guides invite": "Re-send a guide's account invite.",
810
+ "guardians invite": "Add a guardian to a family (and send the invite).",
811
+ "students texts get": "Show a kid's parent SMS summary settings.",
812
+ "students texts set": "Change a kid's SMS summary switch or send hour.",
813
+ "students texts set-guardian": "Change one adult's SMS frequency, focus, or on/off.",
814
+ "students upload-map-scores": "Upload a NWEA MAP score report PDF for a kid.",
815
+ "students issue-email": "Issue a Recess email address for a kid.",
816
+ "students notes add": "Add a staff-visible guide note to a kid's profile (Rocky reads it).",
817
+ "chat-logs list": "List a student's AI chat conversations.",
818
+ "chat-logs get": "Read one AI chat conversation.",
819
+ "chat-logs by-todo": "Read the AI chat conversations behind a todo.",
820
+ "rooms transcripts search": "Search live-room meeting transcripts.",
821
+ "rooms transcripts get": "Read one meeting transcript (optionally a breakout).",
822
+ "students list": "List the kids you can manage.",
823
+ "students today": "Show a kid's day: todos, XP, and schedule.",
824
+ "students schedule": "Show a kid's upcoming schedule.",
825
+ "students todos": "List a student's todos for a date (or recent), with statuses.",
826
+ "students analysis": "Read the learning analysis for a completed todo.",
827
+ "students xp-history": "Show a kid's XP history over a range.",
828
+ "enrollments list": "List a user's enrollments.",
829
+ "subscriptions list": "List a family's Stripe subscriptions.",
830
+ "invoices list": "List a subscription's invoices.",
831
+ "billing pause": "Pause a subscription's billing (optionally until a date).",
832
+ "billing resume": "Resume a paused subscription's billing.",
833
+ "invoices refund": "Refund or credit an invoice line item.",
834
+ "apps init": "Scaffold a Studio app project in a local directory.",
835
+ "apps scaffold": "Fetch the Studio app scaffold (optionally for a todo).",
836
+ "apps preview": "Preview a Studio app locally.",
837
+ "apps primitives list": "List shared Studio app primitives.",
838
+ "apps primitives publish": "Publish a shared Studio app primitive.",
839
+ "apps standards": "Search learning standards for a Studio app.",
840
+ "apps list": "List your Studio app projects.",
841
+ "apps pull": "Download a Studio app project into a directory.",
842
+ "apps validate": "Upload a Studio app and run a dry build.",
843
+ "apps publish": "Build and publish a Studio app (optionally assign it to a kid).",
844
+ "apps assign": "Assign a published Studio app to a kid as a todo.",
845
+ "apps status": "Check a Studio build's status.",
846
+ "applications list": "List enrollment applications with filters.",
847
+ "applications get": "Read one enrollment application.",
848
+ "applications quotes": "List an application's tuition quotes.",
849
+ "applications meetings": "List an application's meetings.",
850
+ "applications call-notes": "List an application's call notes.",
851
+ "applications create": "Create an enrollment application from JSON.",
852
+ "applications disposition": "Set an application's disposition from JSON.",
853
+ "applications qualify": "Set an application's lead quality.",
854
+ "applications update-contact": "Update an application's contact details.",
855
+ "applications claim-email": "Email the family a link to claim the application.",
856
+ "applications claim-link": "Mint a claim link for the application.",
857
+ "applications revoke-claim": "Revoke an outstanding application claim.",
858
+ "applications link-family": "Link an application to an existing family.",
859
+ "applications close": "Close an application with a reason.",
860
+ "applications add-call-note": "Add a call note to an application.",
861
+ "applications edit-call-note": "Edit an application's call note.",
862
+ "applications enroll": "Enroll an application's kids from an accepted quote.",
863
+ "quotes get": "Read one tuition quote.",
864
+ "quotes preview": "Price a quote from JSON without saving it.",
865
+ "quotes create": "Create a tuition quote from JSON.",
866
+ "quotes update": "Replace a tuition quote's contents from JSON.",
867
+ "quotes send": "Send a quote to the family.",
868
+ "quotes accept": "Mark a quote accepted.",
869
+ "quotes decline": "Mark a quote declined.",
870
+ "cohorts search": "Find cohorts by name.",
871
+ "enrollments create": "Enroll a kid in a cohort (creates billing).",
872
+ "enrollments register-cohort": "Register an existing enrollment's kid into a cohort.",
873
+ "enrollments unregister-cohort": "Remove a kid from a cohort.",
874
+ "enrollments get-for-subscription": "Find the enrollment behind a subscription.",
875
+ "billing extend-trial": "Move a subscription's trial end date.",
876
+ "billing cancel-subscription": "Cancel a subscription (at period end or --immediate); --restore undoes.",
877
+ "payout payruns list": "List payout runs.",
878
+ "payout recipients list": "List payout recipients.",
879
+ "payout invoices list": "List payout invoices (needs a filter).",
880
+ "payout recipients archive": "Archive a payout recipient.",
881
+ "payout recipients unarchive": "Unarchive a payout recipient.",
882
+ "payout recipients remove-schedule": "Remove a recipient from a payout schedule.",
883
+ "payout recipients add-schedule": "Add a recipient to a payout schedule.",
884
+ "payout payruns remove-account": "Remove a recipient from a payout run.",
885
+ "payout invoices get": "Read one payout invoice and its items.",
886
+ "payout invoices set-status": "Change a payout invoice's status.",
887
+ "payout items add": "Add a line item to a payout invoice (cents).",
888
+ "payout items edit": "Edit a payout line item.",
889
+ "payout items delete": "Delete a payout line item.",
890
+ "families set-addresses": "Replace family mailing addresses from JSON.",
891
+ "channels list": "List community channels with filters.",
892
+ "channels create": "Create a community channel.",
893
+ "channels set-image": "Set or clear a channel's image.",
894
+ "channels join": "Join a channel yourself.",
895
+ "channels members list": "List a channel's members.",
896
+ "channels members add": "Add (or rejoin) members to a channel.",
897
+ "channels members set-role": "Change channel members' roles.",
898
+ "channels members remove": "Remove members from a channel (soft).",
899
+ "tuition-plans generate": "Compute a tuition plan sheet (web URL, optional PDF); stores nothing.",
900
+ "tuition-plans states": "List states supported by tuition plans.",
901
+ "cohorts get": "Read a cohort and its events.",
902
+ "cohorts schedule get": "Read a cohort's recurring schedule.",
903
+ "cohorts schedule set": "Change a cohort's recurring schedule from a date.",
904
+ "cohorts schedule changes": "List a cohort's schedule changes.",
905
+ "cohorts schedule change": "Read one cohort schedule change.",
906
+ "cohorts parent-emails": "List parent emails for a cohort.",
907
+ "cohorts end": "End a cohort (optionally cancel its subscriptions).",
908
+ "cohorts pause-billing": "Pause billing for every enrollment in a cohort.",
909
+ "cohorts resume-billing": "Resume billing for a cohort.",
910
+ "cohorts email": "Email a cohort's parents (and guides).",
911
+ "feed post": "Post a message to users' feeds (optionally email).",
912
+ "events get": "Read one class event.",
913
+ "events list": "List class events on a date.",
914
+ "events take-attendance": "Record attendance for an event.",
915
+ "events cancel": "Cancel an event AND notify families (chat, email, Slack).",
916
+ "events set-status": "Silently change an event's status (no notifications).",
917
+ "events reschedule": "Move one cohort event to a new start time.",
918
+ "events add": "Add a one-off event to a cohort.",
919
+ "registrations approve": "Approve a cohort registration request.",
920
+ "registrations deny": "Deny a kid's cohort registration.",
921
+ "request get": "Raw authenticated GET of any API path (read-only escape hatch).",
922
+ "onboarding status": "Show a family's onboarding stage and trackers.",
923
+ "onboarding queue": "List families waiting on onboarding actions.",
924
+ "onboarding kids": "List onboarding kids by funnel stage.",
925
+ "onboarding rearm-kid-first-run": "Make a kid see the first-run onboarding again.",
926
+ "onboarding timeline": "Show a family's onboarding event timeline.",
927
+ "onboarding readiness": "Show a family's readiness checklist.",
928
+ "onboarding family": "One-screen family view: status, readiness, next action.",
929
+ "onboarding next": "The family's next action plus the exact commands to do it.",
930
+ "onboarding doctor": "Explain who sees school onboarding and why (flags, gates).",
931
+ "onboarding starter-coverage": "Pre-flip gate: are starter goals covered?",
932
+ "onboarding backfill-trackers": "Census of tracker backfill; --apply stamps it.",
933
+ "onboarding active-tutors": "List a family's active tutors.",
934
+ "onboarding meetings": "List a family's onboarding meetings.",
935
+ "onboarding cohort-options": "List cohorts a family's kid can join.",
936
+ "onboarding comms": "List onboarding emails/texts sent or queued.",
937
+ "onboarding lifecycle-prompts": "List lifecycle prompt settings.",
938
+ "onboarding orientation-sessions": "List orientation sessions.",
939
+ "onboarding ixl-preview": "Preview IXL provisioning for a kid.",
940
+ "onboarding intake-session": "Read the family's in-progress intake session.",
941
+ "onboarding reviews": "List a family's intake reviews.",
942
+ "onboarding review": "Read one intake review session.",
943
+ "onboarding intake-session-create": "Create a blank intake session.",
944
+ "onboarding set-stage": "Move a family's onboarding stage.",
945
+ "onboarding set-account-state": "Set a family's account state (pause/boot).",
946
+ "onboarding set-primary-tutor": "Set or clear a family's primary tutor.",
947
+ "onboarding attest": "Attest (or revoke) an onboarding condition.",
948
+ "onboarding clear-for-cohort": "Clear a family for cohort registration.",
949
+ "onboarding register-cohort": "Register a family's kid in a cohort.",
950
+ "onboarding set-kid-grade": "Set or clear a kid's grade.",
951
+ "onboarding seed-feed": "Seed a kid's feed interests from the family intake.",
952
+ "onboarding generate-summaries": "Generate a family's narrative summaries (LLM).",
953
+ "onboarding provision-math-academy": "Create a Math Academy account for a kid.",
954
+ "onboarding link-math-academy": "Link a kid to an existing Math Academy student.",
955
+ "onboarding provision-ixl": "Provision an IXL account for a kid.",
956
+ "onboarding remove-ixl": "Remove a kid's IXL account link.",
957
+ "onboarding ixl-sync": "Preview the IXL roster sync; --apply uploads the full roster.",
958
+ "onboarding contracts": "List enrollment contracts.",
959
+ "onboarding send-contract": "Send a kid's enrollment contract for signature.",
960
+ "onboarding send-comms": "Send one onboarding email/text by kind.",
961
+ "onboarding send-welcome": "Send the family welcome email.",
962
+ "onboarding send-payment-email": "Send the family payment email.",
963
+ "onboarding send-recommendations": "Email course recommendations to a family.",
964
+ "onboarding set-lifecycle-prompt": "Change a lifecycle prompt's settings.",
965
+ "onboarding override-lifecycle-prompt": "Delay, skip, or clear a lifecycle prompt for one family.",
966
+ "onboarding orientation-create": "Create an orientation session.",
967
+ "onboarding orientation-set-status": "Cancel or complete an orientation session.",
968
+ "onboarding orientation-attendance": "Record a family's orientation attendance.",
969
+ "onboarding meeting-reschedule": "Reschedule an onboarding meeting.",
970
+ "onboarding meeting-cancel": "Cancel an onboarding meeting; --message is emailed to the family.",
971
+ "onboarding set-intake": "Write intake-session data (JSON, CAS-protected).",
972
+ "onboarding extract": "Extract intake data from a transcript (LLM, ~30s).",
973
+ "onboarding mark-reviewed": "Mark an intake session reviewed.",
974
+ "onboarding pairing-code": "Mint a device pairing code for a kid.",
975
+ "school list": "List partner schools/institutions.",
976
+ "school families": "List a school's families.",
977
+ "school family-search": "Search a school's families.",
978
+ "school convert": "Convert a family to a school's membership.",
979
+ "school revert": "Revert a family's school conversion.",
980
+ "school start-memberships": "Start school memberships for kids.",
981
+ "school resolve-payment": "Waive or cancel a school payment.",
982
+ "school close-reconciliation": "Close a school payment reconciliation.",
983
+ "school codes list": "List a school's invite codes.",
984
+ "school codes get": "Read one school invite code.",
985
+ "school codes create": "Create school invite codes.",
986
+ "school codes set-kids": "Set a code's preconfigured kid roster.",
987
+ "school codes replace": "Replace a school invite with new contents.",
988
+ "school codes resend": "Re-send a school invite.",
989
+ "school codes revoke": "Revoke a school invite code.",
990
+ "school create": "Create a school (credit grant spends real money).",
991
+ "school update": "Update a school (money levers are exact-ADMIN).",
992
+ "school representatives list": "List a school's representatives.",
993
+ "school representatives search": "Find users to make school representatives.",
994
+ "school representatives add": "Make a user a school representative.",
995
+ "school representatives remove": "Remove a school representative.",
996
+ "school credit-transactions": "List a school's credit transactions.",
997
+ "school kid-slots": "Override a kid's school slot counts.",
998
+ "school partner-family": "Attach or detach a family to a PARTNER program.",
999
+ "school logo-upload": "Upload a school logo image.",
1000
+ "village models list": "List Village voxel models.",
1001
+ "village models upload": "Upload a .glb model to the Village.",
1002
+ "village models publish": "Publish a Village model to the store library.",
1003
+ "village models archive": "Archive a Village model.",
1004
+ "village models place": "Place a model in a Village world.",
1005
+ "village models move": "Move a placed Village model.",
1006
+ "village models remove": "Remove a placed Village model.",
1007
+ "village render": "Render a top-down view of a Village region.",
1008
+ "village library search": "Search the Village model library.",
1009
+ "village library get": "Read one Village library model.",
1010
+ "village objects list": "List objects in a Village region.",
1011
+ "village objects get": "Read one Village object.",
1012
+ "village build cmd '<command-json>'": "Run one Village build command (inline JSON).",
1013
+ "village build cmd": "Run one Village build command.",
1014
+ "village worlds export": "Export a Village world bundle.",
1015
+ "village worlds import": "Import a Village world bundle.",
1016
+ "village worlds promote": "Promote a mirror/archive world to live.",
1017
+ "village events": "List event templates and their Village rooms.",
1018
+ "village link-event": "Link (or unlink) an event template to a Village room.",
1019
+ "store-items list": "List Village store items.",
1020
+ "store-items set-status": "Change a Village store item's status.",
1021
+ "db query": "Run a read-only SQL query against the API's database.",
1022
+ "db access list": "List users with db query access.",
1023
+ "db access grant": "Grant a user db query access.",
1024
+ "db access revoke": "Revoke a user's db query access.",
1025
+ "content-library search": "Search the curated content-library gems.",
1026
+ "content-library status": "Show a gem's admission status.",
1027
+ "content-library set-stage": "Move gems to a review/polishing/live/archived stage.",
1028
+ "content-library submit": "Submit URLs as content-library gems.",
1029
+ "skills guardian list": "List authoring skills for guardians/guides.",
1030
+ "skills guardian get": "Read an authoring skill (load before authoring).",
1031
+ "skills admin list": "List admin-only tutor skills.",
1032
+ "skills admin get": "Read an admin-only tutor skill.",
1033
+ "goal-templates list": "List goal templates you can see.",
1034
+ "goal-templates get": "Read a goal template (or just its spec).",
1035
+ "goal-templates policy": "Read a template's live goal policy.",
1036
+ "goal-templates set-policy": "Set a template's goal policy recipe.",
1037
+ "goal-templates migrate-policy": "Migrate students' goals to the template policy.",
1038
+ "goal-templates student-policy": "Edit one student's goal policy.",
1039
+ "goal-templates retire-assignments": "Retire a goal's open assignments.",
1040
+ "goal-templates curriculum backlog": "Show goals' curriculum backlog.",
1041
+ "goal-templates curriculum preview": "Preview a curriculum version upgrade.",
1042
+ "goal-templates curriculum validate-resolutions": "Validate curriculum-upgrade conflict resolutions.",
1043
+ "goal-templates curriculum apply": "Apply a curriculum version to goals.",
1044
+ "goal-templates curriculum reverse": "Reverse a curriculum upgrade on goals.",
1045
+ "goal-templates curriculum status": "Check a curriculum job's status.",
1046
+ "goal-templates curriculum retry": "Retry a failed curriculum job.",
1047
+ "goal-templates versions": "List a template's version history.",
1048
+ "goal-templates validate-spec": "Validate a template file (no write).",
1049
+ "goal-templates create": "Create a goal template from a file.",
1050
+ "goal-templates patch-spec": "Patch a template's setup-workflow spec (own PRIVATE ones for guardians).",
1051
+ "goal-templates set-metadata": "Edit a template's title, art, tags, visibility (own PRIVATE ones for guardians).",
1052
+ "goal-templates delete": "Delete a goal template (own PRIVATE ones for guardians).",
1053
+ "goal-templates generate-image": "Generate a template's cover art.",
1054
+ "goal-templates snapshot-files": "List or read a template's snapshot files.",
1055
+ "goal-templates capture-snapshot": "Capture a goal/draft/checkout into a template snapshot.",
1056
+ "goal-templates answers-template": "Print a fillable answers file for a template's wizard.",
1057
+ "goal-templates apply": "Apply a template for a student from answers.",
1058
+ "goal-templates apply-starter": "Apply a starter template for a kid.",
1059
+ "goals list": "List a kid's goals.",
1060
+ "goals create": "Create a goal (or materialize a draft checkout).",
1061
+ "goals edit": "Patch a goal's fields.",
1062
+ "goals delete": "Delete a goal (soft).",
1063
+ "goals restore": "Restore a deleted goal.",
1064
+ "goals complete": "Mark a goal complete.",
1065
+ "goals undo-completion": "Reopen a completed goal.",
1066
+ "goals archive": "Archive a goal.",
1067
+ "goals unarchive": "Unarchive a goal.",
1068
+ "goals move-module": "Reorder a module in a goal's queue.",
1069
+ "goals queue get": "Read a goal's module queue.",
1070
+ "goals queue set": "Replace a goal's module queue from JSON.",
1071
+ "todos create": "Create a todo for a kid.",
1072
+ "todos edit": "Patch a todo's fields.",
1073
+ "todos complete": "Complete a todo with XP.",
1074
+ "todos delete": "Delete a todo (soft).",
1075
+ "todos restore": "Restore a deleted todo.",
1076
+ "todos generate-learning-analysis": "Generate a todo's learning analysis (LLM).",
1077
+ "todos generate-applet": "Generate a practice applet todo from a todo.",
1078
+ "memories files": "List a kid's memory files.",
1079
+ "memories read": "Read one kid memory file.",
1080
+ "memories edit": "Edit a kid memory file (publication disabled).",
1081
+ "memories history": "List a memory file's revisions.",
1082
+ "memories revision": "Read one memory file revision.",
1083
+ "memories restore": "Restore a memory file revision (publication disabled).",
1084
+ "memories context": "Read the memory context Rocky sees for a kid.",
1085
+ "memories log": "Read a kid's memory log for a date.",
1086
+ "rocky get": "Read a kid's Rocky personality settings.",
1087
+ "rocky set": "Patch a kid's Rocky personality settings.",
1088
+ "tutor-templates list": "List tutor templates.",
1089
+ "tutor-templates get": "Read one tutor template.",
1090
+ "tutor-templates assign": "Assign a tutor template to a kid.",
1091
+ "tutor-templates unassign": "Unassign a tutor template from a kid.",
1092
+ "tutor-templates create": "Create a tutor template.",
1093
+ "tutor-templates update": "Update a tutor template.",
1094
+ "tutor-templates delete": "Delete a tutor template.",
1095
+ "goals adaptations list": "List a goal's adaptation runs.",
1096
+ "goals adaptations diff": "Diff the files an adaptation run changed.",
1097
+ "goals files list": "List a goal workspace's files.",
1098
+ "goals files read": "Read one goal workspace file.",
1099
+ "goals files init": "Start a new draft goal workspace locally.",
1100
+ "goals files checkout": "Check out a goal or draft workspace locally.",
1101
+ "goals files push": "Push a local goal checkout's commits.",
1102
+ "goals files write": "Write files into a goal or draft workspace.",
1103
+ "goals pdf upload": "Upload a PDF into a goal or draft workspace.",
1104
+ "goals video upload": "Upload an mp4 for goal content.",
1105
+ };
1106
+ /** What each noun covers — one line per noun in the compact root `help`. */
1107
+ export const NOUN_SUMMARIES = {
1108
+ profile: "Saved API/web origin profiles.",
1109
+ jobs: "Local ledger of write operations by operation key.",
1110
+ feedback: "Send or list feedback about this CLI.",
1111
+ auth: "Sign in (browser or headless), session status, sign out.",
1112
+ users: "Accounts: search/get, lock/unlock, disable/restore, phone, tier, school status.",
1113
+ guides: "Create and invite guide accounts.",
1114
+ guardians: "Invite guardians into a family.",
1115
+ students: "Kids: roster, today, schedule, todos, analysis, XP, SMS summaries, notes.",
1116
+ "chat-logs": "Read kids' AI chat conversations.",
1117
+ rooms: "Search and read live-room meeting transcripts.",
1118
+ enrollments: "Cohort enrollments and registrations.",
1119
+ subscriptions: "List a family's Stripe subscriptions.",
1120
+ invoices: "List invoices; refund or credit a line item.",
1121
+ billing: "Pause/resume, extend trial, cancel subscriptions.",
1122
+ apps: "Studio apps: scaffold, validate, publish, assign to kids.",
1123
+ applications: "Enrollment applications: triage, claim, quote, enroll.",
1124
+ quotes: "Tuition quotes: preview, create, send, accept/decline.",
1125
+ cohorts: "Cohorts: search, schedule, parent emails, end, billing, email.",
1126
+ payout: "Guide payouts: payruns, recipients, invoices, line items.",
1127
+ families: "Bulk-set family mailing addresses.",
1128
+ channels: "Community channels and their members.",
1129
+ "tuition-plans": "Compute tuition plan sheets (stores nothing).",
1130
+ feed: "Post messages to users' feeds.",
1131
+ events: "Class events: list, attendance, cancel, reschedule, add.",
1132
+ registrations: "Approve or deny cohort registrations.",
1133
+ request: "Raw read-only GET of any API path.",
1134
+ onboarding: "Family onboarding: status, next action, intake, provisioning, comms.",
1135
+ school: "Partner schools: families, conversion, invite codes, reps, credits.",
1136
+ village: "Recess Village: models, worlds, building, objects, events.",
1137
+ "store-items": "Village store items and their status.",
1138
+ db: "Read-only SQL queries and who may run them.",
1139
+ "content-library": "Curated gem library: search, submit, admission stage.",
1140
+ skills: "Authoring skills to load before writing templates/goals.",
1141
+ "goal-templates": "Goal templates: browse, author, apply, policy, curriculum.",
1142
+ goals: "Kids' goals: create/edit, queue, workspace files, PDFs, videos.",
1143
+ todos: "Kids' todos: create, edit, complete, analysis, applets.",
1144
+ memories: "Kid memory files and the context Rocky sees.",
1145
+ rocky: "A kid's Rocky personality settings.",
1146
+ "tutor-templates": "Tutor templates and their assignment to kids.",
1147
+ mastery: "Mastery graphs and the content linked to them.",
1148
+ };
715
1149
  //# sourceMappingURL=help.js.map