recess-cli 3.16.1 → 3.18.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/args.js +2 -0
- package/dist/cli.js +155 -2
- package/dist/command-schema.js +9 -1
- package/dist/commands/tuition-plans.js +27 -3
- package/dist/goal-authoring.js +3 -8
- package/dist/help.js +43 -15
- package/package.json +1 -1
package/dist/args.js
CHANGED
|
@@ -29,6 +29,7 @@ export const BOOLEAN_FLAGS = new Set([
|
|
|
29
29
|
"no-paywall",
|
|
30
30
|
"no-text",
|
|
31
31
|
"all",
|
|
32
|
+
"all-goals",
|
|
32
33
|
"all-references",
|
|
33
34
|
"allow-assigned-edits",
|
|
34
35
|
"allow-billing",
|
|
@@ -36,6 +37,7 @@ export const BOOLEAN_FLAGS = new Set([
|
|
|
36
37
|
"allow-state-modification",
|
|
37
38
|
"allow-strand",
|
|
38
39
|
"analyzed",
|
|
40
|
+
"append",
|
|
39
41
|
"apply",
|
|
40
42
|
"archived",
|
|
41
43
|
"cancel-subscriptions",
|
package/dist/cli.js
CHANGED
|
@@ -5235,7 +5235,151 @@ export async function executeRecessCommand(argv, options = {}) {
|
|
|
5235
5235
|
body: { studentUserId, answers },
|
|
5236
5236
|
})));
|
|
5237
5237
|
}
|
|
5238
|
-
|
|
5238
|
+
if (verb === "publish") {
|
|
5239
|
+
const id = await resolveGoalTemplateId(api, positional(parsed, 2, "template ID or slug"));
|
|
5240
|
+
const commitOid = flagString(parsed, "commit");
|
|
5241
|
+
const sourceDraft = flagString(parsed, "source-draft");
|
|
5242
|
+
if ([commitOid, sourceDraft, flagString(parsed, "source-dir")].filter(Boolean).length !== 1) {
|
|
5243
|
+
throw new CliError("invalid_arguments", "Pass exactly one of --source-draft <draft-slug> --student <kid>, --source-dir <course-dir>, or --commit <course-repo-commit>.");
|
|
5244
|
+
}
|
|
5245
|
+
const local = commitOid || sourceDraft
|
|
5246
|
+
? null
|
|
5247
|
+
: await readGoalWorkspaceWriteSource(parsed);
|
|
5248
|
+
const source = local
|
|
5249
|
+
? { kind: "files", files: local.files }
|
|
5250
|
+
: sourceDraft
|
|
5251
|
+
? {
|
|
5252
|
+
kind: "draft",
|
|
5253
|
+
draft: sourceDraft,
|
|
5254
|
+
studentUserId: (await studentFlag(api, parsed, { required: true })).id,
|
|
5255
|
+
}
|
|
5256
|
+
: { kind: "commit", commitOid: commitOid };
|
|
5257
|
+
const audience = hasFlag(parsed, "all-goals")
|
|
5258
|
+
? "all"
|
|
5259
|
+
: "shared";
|
|
5260
|
+
const preflight = unwrap(await api.client.POST("/ai/goal-templates/{id}/publish", {
|
|
5261
|
+
params: { path: { id } },
|
|
5262
|
+
body: { source, dryRun: true, audience },
|
|
5263
|
+
}));
|
|
5264
|
+
if (preflight.action !== "preview_course_publish") {
|
|
5265
|
+
throw new CliError("unexpected_response", "Course publish did not return a preview; nothing was published.");
|
|
5266
|
+
}
|
|
5267
|
+
if (hasFlag(parsed, "dry-run"))
|
|
5268
|
+
return preflight;
|
|
5269
|
+
const { plan } = preflight;
|
|
5270
|
+
if (plan.problems.length > 0) {
|
|
5271
|
+
throw new CliError("invalid_course", `The course cannot be published; nothing was published:\n- ${plan.problems.join("\n- ")}`, 1, { problems: plan.problems });
|
|
5272
|
+
}
|
|
5273
|
+
if (plan.unchanged) {
|
|
5274
|
+
return {
|
|
5275
|
+
...preflight,
|
|
5276
|
+
next: "No course file changed; nothing to publish.",
|
|
5277
|
+
};
|
|
5278
|
+
}
|
|
5279
|
+
if (!preflight.publishEnabled) {
|
|
5280
|
+
throw new CliError("publish_disabled", "Course publishing is off on this server (COURSE_PUBLISH_ENABLED). Run with --dry-run to see the plan; nothing was published.", 1, { affectedKids: plan.affectedKids, midLesson: plan.midLesson });
|
|
5281
|
+
}
|
|
5282
|
+
const preview = {
|
|
5283
|
+
action: `publish a new course version that every kid on it reads at once (affects ${plan.affectedKids} kids, ${plan.midLesson} mid-lesson)`,
|
|
5284
|
+
target: {
|
|
5285
|
+
templateId: plan.goalTemplateId,
|
|
5286
|
+
slug: plan.slug,
|
|
5287
|
+
title: plan.title,
|
|
5288
|
+
version: plan.templateVersion,
|
|
5289
|
+
},
|
|
5290
|
+
request: {
|
|
5291
|
+
source: local
|
|
5292
|
+
? {
|
|
5293
|
+
kind: "directory",
|
|
5294
|
+
absolutePath: local.source.absolutePath,
|
|
5295
|
+
fileCount: local.files.length,
|
|
5296
|
+
sha256: local.sha256,
|
|
5297
|
+
}
|
|
5298
|
+
: source,
|
|
5299
|
+
audience,
|
|
5300
|
+
digest: plan.digest,
|
|
5301
|
+
},
|
|
5302
|
+
details: {
|
|
5303
|
+
affectedKids: plan.affectedKids,
|
|
5304
|
+
affectedGoals: plan.affectedGoals,
|
|
5305
|
+
midLesson: plan.midLesson,
|
|
5306
|
+
warnings: plan.warnings.map((warning) => ({
|
|
5307
|
+
kind: warning.kind,
|
|
5308
|
+
lesson: warning.title,
|
|
5309
|
+
detail: warning.detail,
|
|
5310
|
+
goals: warning.goalIds.length,
|
|
5311
|
+
midLesson: warning.midLessonGoalIds.length,
|
|
5312
|
+
})),
|
|
5313
|
+
lessons: plan.lessons,
|
|
5314
|
+
changes: plan.changes,
|
|
5315
|
+
stampedKeys: plan.stampedKeys,
|
|
5316
|
+
dropped: plan.dropped,
|
|
5317
|
+
...(plan.killSwitchActive
|
|
5318
|
+
? {
|
|
5319
|
+
killSwitch: "GOAL_CONTENT_SOURCE_OVERRIDE=COPY: no goal reads the course until it is lifted.",
|
|
5320
|
+
}
|
|
5321
|
+
: {}),
|
|
5322
|
+
note: "Every kid on this course (SHARED goals) reads the new version from their next session; progress and notes are keyed by Item key. The confirmed publish is fenced to this exact plan digest.",
|
|
5323
|
+
},
|
|
5324
|
+
};
|
|
5325
|
+
return previewBoundWrite(parsed, preview, async () => unwrap(await api.client.POST("/ai/goal-templates/{id}/publish", {
|
|
5326
|
+
params: { path: { id } },
|
|
5327
|
+
body: {
|
|
5328
|
+
source,
|
|
5329
|
+
dryRun: false,
|
|
5330
|
+
audience,
|
|
5331
|
+
expectedDigest: plan.digest,
|
|
5332
|
+
},
|
|
5333
|
+
})));
|
|
5334
|
+
}
|
|
5335
|
+
throw new CliError("invalid_arguments", "Use goal-templates list|get|versions|validate-spec|create|patch-spec|set-metadata|generate-image|delete|snapshot-files|capture-snapshot|publish|answers-template|apply|apply-starter.");
|
|
5336
|
+
}
|
|
5337
|
+
if (noun === "goals" && (verb === "notes" || verb === "progress")) {
|
|
5338
|
+
const student = await studentFlag(api, parsed, { required: true });
|
|
5339
|
+
const studentId = student.id;
|
|
5340
|
+
const goalId = flagString(parsed, "goal", { required: true });
|
|
5341
|
+
const params = { params: { path: { studentId, goalId } } };
|
|
5342
|
+
if (verb === "progress") {
|
|
5343
|
+
return unwrap(await api.client.GET("/tutor/students/{studentId}/goals/{goalId}/progress", params));
|
|
5344
|
+
}
|
|
5345
|
+
const action = positional(parsed, 2, "goals notes action");
|
|
5346
|
+
const lesson = flagString(parsed, "lesson");
|
|
5347
|
+
if (action === "list" || action === "get") {
|
|
5348
|
+
const notes = unwrap(await api.client.GET("/tutor/students/{studentId}/goals/{goalId}/notes", params));
|
|
5349
|
+
if (action === "list")
|
|
5350
|
+
return notes;
|
|
5351
|
+
if (!lesson) {
|
|
5352
|
+
return { goalId, contentSource: notes.contentSource, note: notes.goal };
|
|
5353
|
+
}
|
|
5354
|
+
const match = notes.lessons.find((entry) => entry.key === lesson || entry.ref === lesson);
|
|
5355
|
+
if (!match) {
|
|
5356
|
+
throw new CliError("not_found", `No lesson ${lesson} on goal ${goalId}; goals notes list shows each lesson's key.`);
|
|
5357
|
+
}
|
|
5358
|
+
return { goalId, contentSource: notes.contentSource, lesson: match };
|
|
5359
|
+
}
|
|
5360
|
+
if (action === "set") {
|
|
5361
|
+
const textFile = flagString(parsed, "text-file");
|
|
5362
|
+
const text = textFile
|
|
5363
|
+
? await fs.readFile(path.resolve(textFile), "utf8")
|
|
5364
|
+
: flagString(parsed, "text");
|
|
5365
|
+
if (!text?.trim() || (textFile && flagString(parsed, "text"))) {
|
|
5366
|
+
throw new CliError("invalid_arguments", "Pass exactly one of --text TEXT or --text-file <path>.");
|
|
5367
|
+
}
|
|
5368
|
+
const mode = hasFlag(parsed, "append")
|
|
5369
|
+
? "append"
|
|
5370
|
+
: "replace";
|
|
5371
|
+
const body = { lesson: lesson ?? null, text: text.trim(), mode };
|
|
5372
|
+
return writeCommand(parsed, {
|
|
5373
|
+
action: `${mode} Rocky's note for this kid on ${lesson ? "a lesson" : "the goal"} (never changes the lesson or its criteria)`,
|
|
5374
|
+
target: { studentId, goalId, lesson: lesson ?? "goal" },
|
|
5375
|
+
request: body,
|
|
5376
|
+
details: {
|
|
5377
|
+
...resolvedStudentDetails(student),
|
|
5378
|
+
note: "Notes exist only on shared-course goals. To change the lesson itself for every kid, edit the course and run goal-templates publish.",
|
|
5379
|
+
},
|
|
5380
|
+
}, async () => unwrap(await api.client.PUT("/tutor/students/{studentId}/goals/{goalId}/notes", { ...params, body })));
|
|
5381
|
+
}
|
|
5382
|
+
throw new CliError("invalid_arguments", "Use goals notes list|get|set.");
|
|
5239
5383
|
}
|
|
5240
5384
|
if (noun === "goals" && verb === "adaptations") {
|
|
5241
5385
|
const action = positional(parsed, 2, "goals adaptations action");
|
|
@@ -6778,12 +6922,21 @@ export async function executeRecessCommand(argv, options = {}) {
|
|
|
6778
6922
|
}
|
|
6779
6923
|
if (action === "checkout") {
|
|
6780
6924
|
const response = await readRemoteWorkspaceSnapshot(api, studentId, target);
|
|
6781
|
-
|
|
6925
|
+
const checkedOut = await checkoutGoalWorkspace({
|
|
6782
6926
|
outputDirectory,
|
|
6783
6927
|
studentId,
|
|
6784
6928
|
target,
|
|
6785
6929
|
snapshot: response.snapshot,
|
|
6786
6930
|
});
|
|
6931
|
+
// SHARED goal: the checkout is the merged view; lesson files are
|
|
6932
|
+
// read-only (a push to them is refused), so say so up front.
|
|
6933
|
+
if (!response.sharedCourse)
|
|
6934
|
+
return checkedOut;
|
|
6935
|
+
return {
|
|
6936
|
+
...checkedOut,
|
|
6937
|
+
sharedCourse: response.sharedCourse,
|
|
6938
|
+
next: `${response.sharedCourse.message} ${checkedOut.next}`,
|
|
6939
|
+
};
|
|
6787
6940
|
}
|
|
6788
6941
|
// The server scaffold is a fixed two-lesson tree; an explicit --modules
|
|
6789
6942
|
// count keeps the local scaffold, as does a server without the init route.
|
package/dist/command-schema.js
CHANGED
|
@@ -119,11 +119,15 @@ const FAMILY_AI_COMMANDS = new Set([
|
|
|
119
119
|
"goal-templates capture-snapshot",
|
|
120
120
|
"goal-templates create",
|
|
121
121
|
// set-metadata/delete/patch-spec: the server lets a non-staff author touch
|
|
122
|
-
// only their own PRIVATE templates
|
|
122
|
+
// only their own PRIVATE templates, plus unpublish (set-metadata
|
|
123
|
+
// --visibility PRIVATE alone) their own published one.
|
|
123
124
|
"goal-templates delete",
|
|
124
125
|
"goal-templates get",
|
|
125
126
|
"goal-templates list",
|
|
126
127
|
"goal-templates patch-spec",
|
|
128
|
+
// publish: the server allows staff or the author, and only while every kid
|
|
129
|
+
// reading the course is one the caller manages.
|
|
130
|
+
"goal-templates publish",
|
|
127
131
|
"goal-templates set-metadata",
|
|
128
132
|
"goal-templates snapshot-files",
|
|
129
133
|
"goal-templates validate-spec",
|
|
@@ -142,7 +146,11 @@ const FAMILY_AI_COMMANDS = new Set([
|
|
|
142
146
|
"goals launch-todo",
|
|
143
147
|
"goals list",
|
|
144
148
|
"goals move-module",
|
|
149
|
+
"goals notes get",
|
|
150
|
+
"goals notes list",
|
|
151
|
+
"goals notes set",
|
|
145
152
|
"goals pdf upload",
|
|
153
|
+
"goals progress",
|
|
146
154
|
"goals video upload",
|
|
147
155
|
"goals queue get",
|
|
148
156
|
"goals queue set",
|
|
@@ -74,10 +74,11 @@ function renderPlan(plan, webUrl, pdfPath) {
|
|
|
74
74
|
p.scheduleLine,
|
|
75
75
|
])),
|
|
76
76
|
// Award unknown: each payment is billed as is, or a ceiling for now.
|
|
77
|
-
|
|
77
|
+
// Award confirmed: each payment is the family's share of the period.
|
|
78
|
+
...(esa || plan.esaAward
|
|
78
79
|
? o.paymentPlans
|
|
79
80
|
.filter((p) => p.kind !== "PAY_IN_FULL" && p.kind !== "STAFF_CUSTOM")
|
|
80
|
-
.flatMap((p) => p.installments.map((inst) => ` ${p.kind === "MONTHLY" ? `invoiced ${inst.invoiceDate}, due ${inst.dueDate}` : `${inst.serviceStart} → ${inst.serviceEnd}`} tuition ${dollars(inst.fullTuitionCents ?? inst.amountCents)} you pay ${inst.award === "
|
|
81
|
+
.flatMap((p) => p.installments.map((inst) => ` ${p.kind === "MONTHLY" ? `invoiced ${inst.invoiceDate}, due ${inst.dueDate}` : `${inst.serviceStart} → ${inst.serviceEnd}`} tuition ${dollars(inst.fullTuitionCents ?? inst.amountCents)} you pay ${inst.award === "PENDING" ? `up to ${dollars(inst.amountCents)}` : dollars(inst.amountCents)}${inst.illustrativeNote ? ` (${inst.illustrativeNote})` : ""} ${inst.note ?? ""}`))
|
|
81
82
|
: []),
|
|
82
83
|
// A staff-written option: every row as the family will see it.
|
|
83
84
|
...o.paymentPlans
|
|
@@ -164,6 +165,16 @@ export function parseTuitionPlanSpecFlags(parsed) {
|
|
|
164
165
|
}
|
|
165
166
|
return `${key}=${date}`;
|
|
166
167
|
});
|
|
168
|
+
const dueDates = flagList(parsed, "due-date").map((raw) => {
|
|
169
|
+
const [key, date] = raw.split("=").map((v) => v.trim().toLowerCase());
|
|
170
|
+
if (!key ||
|
|
171
|
+
!date ||
|
|
172
|
+
!/^(upfront|[1-9]\d*)$/.test(key) ||
|
|
173
|
+
!ISO_DATE.test(date)) {
|
|
174
|
+
throw new CliError("invalid_arguments", `--due-date takes upfront=YYYY-MM-DD or N=YYYY-MM-DD (installment N), got "${raw}".`);
|
|
175
|
+
}
|
|
176
|
+
return `${key}=${date}`;
|
|
177
|
+
});
|
|
167
178
|
const amounts = flagList(parsed, "amount").map((raw) => {
|
|
168
179
|
const [key, dollars] = raw.split("=").map((v) => v.trim());
|
|
169
180
|
if (!key ||
|
|
@@ -190,6 +201,17 @@ export function parseTuitionPlanSpecFlags(parsed) {
|
|
|
190
201
|
}
|
|
191
202
|
// A staff-written option, as JSON inline or `@path/to/plan.json`; the
|
|
192
203
|
// server validates it (CustomPlanSpecSchema).
|
|
204
|
+
// Award confirmed: --annual stays the no-award price; the sheet bills the
|
|
205
|
+
// family's share after the award and Recess aid.
|
|
206
|
+
const esaAward = flagString(parsed, "esa-award")?.trim().replace(/[$,]/g, "");
|
|
207
|
+
if (esaAward !== undefined) {
|
|
208
|
+
if (esaUnknown) {
|
|
209
|
+
throw new CliError("invalid_arguments", "Use --esa-award or --esa-award-unknown, not both.");
|
|
210
|
+
}
|
|
211
|
+
if (!/^\d+(\.\d{1,2})?$/.test(esaAward) || Number(esaAward) <= 0) {
|
|
212
|
+
throw new CliError("invalid_arguments", "--esa-award must be a positive dollar amount (the family's annual award).");
|
|
213
|
+
}
|
|
214
|
+
}
|
|
193
215
|
const customRaw = flagString(parsed, "custom-plan")?.trim();
|
|
194
216
|
let customPlan;
|
|
195
217
|
if (customRaw) {
|
|
@@ -207,7 +229,7 @@ export function parseTuitionPlanSpecFlags(parsed) {
|
|
|
207
229
|
customPlan = JSON.stringify(JSON.parse(text));
|
|
208
230
|
}
|
|
209
231
|
catch {
|
|
210
|
-
throw new CliError("invalid_arguments", "--custom-plan takes JSON (or @file.json): {label, summary?, clause?, continueFrom?, rows: [{label, note?, amount?, amountText?, date?, when?}]}.");
|
|
232
|
+
throw new CliError("invalid_arguments", "--custom-plan takes JSON (or @file.json): {label, summary?, clause?, continueFrom?, rows: [{label, note?, amount?, amountText?, date?, due?, when?}]}.");
|
|
211
233
|
}
|
|
212
234
|
}
|
|
213
235
|
const customOnly = hasFlag(parsed, "custom-only");
|
|
@@ -221,8 +243,10 @@ export function parseTuitionPlanSpecFlags(parsed) {
|
|
|
221
243
|
: {}),
|
|
222
244
|
...(esaUnknown ? { esaAwardUnknown: "true" } : {}),
|
|
223
245
|
...(esaScenarios ? { esaScenarios } : {}),
|
|
246
|
+
...(esaAward ? { esaAward: Number(esaAward) } : {}),
|
|
224
247
|
...(even ? { evenInstallments: "true" } : {}),
|
|
225
248
|
...(billDates.length ? { billDates: billDates.join(",") } : {}),
|
|
249
|
+
...(dueDates.length ? { dueDates: dueDates.join(",") } : {}),
|
|
226
250
|
...(amounts.length ? { amounts: amounts.join(",") } : {}),
|
|
227
251
|
...(endDate ? { endDate } : {}),
|
|
228
252
|
...(terms ? { terms: terms.join(",") } : {}),
|
package/dist/goal-authoring.js
CHANGED
|
@@ -44,7 +44,7 @@ You are Rocky, running **${title}** with one student.
|
|
|
44
44
|
|
|
45
45
|
## File discipline
|
|
46
46
|
|
|
47
|
-
-
|
|
47
|
+
- Recess tracks progress; the review after the student taps Submit completes a module.
|
|
48
48
|
- Put student-facing work under \`resources/\`; student uploads arrive under \`uploads/\`.`),
|
|
49
49
|
},
|
|
50
50
|
{
|
|
@@ -87,11 +87,7 @@ Where to start: name the exact page, app, file, or tab Rocky opens first, then t
|
|
|
87
87
|
|
|
88
88
|
## Completion criteria
|
|
89
89
|
|
|
90
|
-
-
|
|
91
|
-
|
|
92
|
-
## State updates
|
|
93
|
-
|
|
94
|
-
- Keep the current step in \`state/progress.json\` current; \`complete_module\` records the completion.`),
|
|
90
|
+
- What the student does or makes that proves the learning target${index === modules.length - 1 ? " and finishes the path" : ""}.`),
|
|
95
91
|
})),
|
|
96
92
|
];
|
|
97
93
|
}
|
|
@@ -117,7 +113,6 @@ const READY_MODULE_REQUIREMENTS = [
|
|
|
117
113
|
patterns: [/^Resources(?: and surfaces)?\b/i],
|
|
118
114
|
},
|
|
119
115
|
{ label: "completion criteria", patterns: [/^Completion criteria\b/i] },
|
|
120
|
-
{ label: "state updates", patterns: [/^State updates\b/i] },
|
|
121
116
|
];
|
|
122
117
|
const SIMPLE_DAILY_TODO_GOAL_MODES = new Set([
|
|
123
118
|
"simple_daily_todos",
|
|
@@ -224,7 +219,7 @@ function moduleContentErrors(path, content) {
|
|
|
224
219
|
}
|
|
225
220
|
const errors = missing.length
|
|
226
221
|
? [
|
|
227
|
-
`${path} is not a complete runtime module; missing ${missing.join(", ")}. Required: a Summary line or ## Summary, an Estimated time line, and populated ## Learning targets, ## Tutor guidance, ## Resources and surfaces, ## Completion criteria
|
|
222
|
+
`${path} is not a complete runtime module; missing ${missing.join(", ")}. Required: a Summary line or ## Summary, an Estimated time line, and populated ## Learning targets, ## Tutor guidance, ## Resources and surfaces, ## Completion criteria.`,
|
|
228
223
|
]
|
|
229
224
|
: [];
|
|
230
225
|
const itemKey = headerField(lines, "Item key");
|
package/dist/help.js
CHANGED
|
@@ -201,8 +201,8 @@ Usage:
|
|
|
201
201
|
[--partner-school <slug|id>] [--force-direct] [--state-funding] [--elective-price DOLLARS]
|
|
202
202
|
[--one-on-one-price DOLLARS] [--one-on-one-sessions N] [--end YYYY-MM-DD]
|
|
203
203
|
[--terms full-year,school-year,custom] [--payments upfront,installments]
|
|
204
|
-
[--note TEXT]... [--bill-date upfront|N=YYYY-MM-DD]... [--amount N=DOLLARS]... [--even-installments]
|
|
205
|
-
[--esa-award-unknown [--esa-scenarios DOLLARS,...]] [--custom-plan JSON|@file] [--custom-only]
|
|
204
|
+
[--note TEXT]... [--bill-date upfront|N=YYYY-MM-DD]... [--due-date upfront|N=YYYY-MM-DD]... [--amount N=DOLLARS]... [--even-installments]
|
|
205
|
+
[--esa-award DOLLARS | --esa-award-unknown [--esa-scenarios DOLLARS,...]] [--custom-plan JSON|@file] [--custom-only]
|
|
206
206
|
[--pdf <path>] [--open]
|
|
207
207
|
recess [--json] tuition-plans states
|
|
208
208
|
recess [--json] admissions create --school <institution-slug> --enrollment direct|partner-school|program
|
|
@@ -213,8 +213,8 @@ Usage:
|
|
|
213
213
|
[--tier complete] [--paywall DOLLARS|--paywall-offline] [--staff-note TEXT]... [--no-email]
|
|
214
214
|
(--no-agreement | --start YYYY-MM-DD --annual DOLLARS) [--state-funding] [--end YYYY-MM-DD]
|
|
215
215
|
[--terms full-year,school-year,custom] [--payments upfront,installments] [--note TEXT]...
|
|
216
|
-
[--bill-date upfront|N=YYYY-MM-DD]... [--amount N=DOLLARS]... [--even-installments] [--force-direct]
|
|
217
|
-
[--esa-award-unknown [--esa-scenarios DOLLARS,...]] [--custom-plan JSON|@file] [--custom-only]
|
|
216
|
+
[--bill-date upfront|N=YYYY-MM-DD]... [--due-date upfront|N=YYYY-MM-DD]... [--amount N=DOLLARS]... [--even-installments] [--force-direct]
|
|
217
|
+
[--esa-award DOLLARS | --esa-award-unknown [--esa-scenarios DOLLARS,...]] [--custom-plan JSON|@file] [--custom-only]
|
|
218
218
|
[--elective-price DOLLARS]
|
|
219
219
|
[--one-on-one-price DOLLARS] [--one-on-one-sessions N] [--confirm]
|
|
220
220
|
recess [--json] admissions get <packet-id>
|
|
@@ -479,6 +479,10 @@ Usage:
|
|
|
479
479
|
(--source-goal <goal-id> | --source-draft <draft-slug> --student <goal-owner-id>
|
|
480
480
|
| --source-dir <local-checkout>)
|
|
481
481
|
[--dry-run] [--confirm --approval-token TOKEN]
|
|
482
|
+
recess [--json] goal-templates publish <template-id|slug>
|
|
483
|
+
(--source-draft <draft-slug> --student <draft-owner-id>
|
|
484
|
+
| --source-dir <course-dir> | --commit <course-repo-commit>) [--all-goals]
|
|
485
|
+
[--dry-run] [--confirm --approval-token TOKEN]
|
|
482
486
|
recess [--json] goal-templates answers-template <template-id|slug>
|
|
483
487
|
[--student <kid-id-or-name>]
|
|
484
488
|
recess [--json] goal-templates apply <template-id> [--student <kid-id-or-name>]
|
|
@@ -552,6 +556,13 @@ Usage:
|
|
|
552
556
|
[--lessons-dir <dir>] [--emoji TEXT] [--grade-min N] [--grade-max N]
|
|
553
557
|
[--visibility PUBLIC|STAFF] [--confirm]
|
|
554
558
|
recess [--json] tutor-templates delete <slug> [--confirm]
|
|
559
|
+
recess [--json] goals notes list --student <goal-owner-id> --goal <goal-id>
|
|
560
|
+
recess [--json] goals notes get --student <goal-owner-id> --goal <goal-id>
|
|
561
|
+
[--lesson <item-key|module-ref>]
|
|
562
|
+
recess [--json] goals notes set --student <goal-owner-id> --goal <goal-id>
|
|
563
|
+
[--lesson <item-key|module-ref>] (--text TEXT | --text-file <path>) [--append]
|
|
564
|
+
[--confirm --approval-token TOKEN]
|
|
565
|
+
recess [--json] goals progress --student <goal-owner-id> --goal <goal-id>
|
|
555
566
|
recess [--json] goals adaptations list --student <goal-owner-id> --goal <goal-id>
|
|
556
567
|
recess [--json] goals adaptations diff <run-id> --student <goal-owner-id>
|
|
557
568
|
--goal <goal-id> [--path P]
|
|
@@ -583,6 +594,11 @@ bundled into this npm package. Load os-v2-goal-template-builder and its
|
|
|
583
594
|
references/deterministic-workflow-setup.md BEFORE authoring a template; that is
|
|
584
595
|
the same guidance the recess.gg/ai agent follows, so there is exactly one
|
|
585
596
|
standard. Responses cache under ~/.recess-cli/skills-cache/ (--refresh re-fetches).
|
|
597
|
+
Shared courses (a goal with contentSource SHARED): every kid reads the course's
|
|
598
|
+
latest published version, so "goal-templates publish" is the one way to change a
|
|
599
|
+
lesson; it previews "affects N kids (M mid-lesson)". Per-kid tailoring is a note
|
|
600
|
+
("goals notes set"), never a lesson edit: goal file pushes to lesson paths are
|
|
601
|
+
refused. capture-snapshot and the curriculum commands are deprecated for them.
|
|
586
602
|
Goal file writes/pushes warn and refuse curriculum edits with unfinished assignments
|
|
587
603
|
unless --allow-assigned-edits is supplied. This can change lessons while a student
|
|
588
604
|
is working; assignments are not retired/completed and student answers are not merged.
|
|
@@ -750,8 +766,9 @@ Custom plans (--custom-plan, generate/create/requote): for an arrangement the
|
|
|
750
766
|
computed options cannot express, e.g. a bridge payment until ESA funding
|
|
751
767
|
starts. JSON inline or @file: {"label", "summary"?, "clause"?, "continueFrom"?,
|
|
752
768
|
"rows": [{"label", "note"?, "amount"? (dollars), "amountText"?, "date"?
|
|
753
|
-
(invoice date), "
|
|
754
|
-
|
|
769
|
+
(invoice date), "due"? (due date; default 15 days after "date"), "when"?}]}.
|
|
770
|
+
Each row needs an amount or amountText and a date or when; the first row needs
|
|
771
|
+
a date and an amount (the first invoice). Rows show
|
|
755
772
|
exactly as written; dated rows with amounts are real invoices. "continueFrom": N
|
|
756
773
|
then carries on with the computed installment plan from installment N (e.g. a
|
|
757
774
|
September bridge, then the regular quarters from 2). "continueOverrides": {"N":
|
|
@@ -788,6 +805,8 @@ still add up to the plan total, and it cannot combine with --even-installments o
|
|
|
788
805
|
--esa-award-unknown. --note TEXT (repeatable) prints a note on the sheet. --bill-date (repeatable)
|
|
789
806
|
moves an invoice date: upfront=YYYY-MM-DD for pay in full, N=YYYY-MM-DD for
|
|
790
807
|
installment N in every term; due dates follow and dates must stay in order.
|
|
808
|
+
--due-date (repeatable, same keys) keeps the invoice date and sets when it is
|
|
809
|
+
due; once any due date is moved, the sheet prints every due date.
|
|
791
810
|
--even-installments splits each installment plan evenly in whole dollars (any
|
|
792
811
|
remainder on the first payment) instead of pricing each by its school days.
|
|
793
812
|
--esa-award-unknown is for a family with no ESA award yet: --annual is their
|
|
@@ -803,6 +822,10 @@ tuition page lists installments on the ESA funding quarters (no pay in full): a
|
|
|
803
822
|
start too late for approval (~30 days) to land in its quarter bills that quarter
|
|
804
823
|
now with no award; every other payment shows "up to" its no-award amount. The
|
|
805
824
|
agreement adds a clause that the plan is re-issued once the award is confirmed.
|
|
825
|
+
--esa-award DOLLARS is for a family whose annual ESA award is confirmed: --annual
|
|
826
|
+
stays their income-based price with no award, the award pays first, then Recess
|
|
827
|
+
aid, and every amount on the sheet is the family's share (each payment shows its
|
|
828
|
+
tuition and what the award and aid pay). Implies --state-funding; not Florida.
|
|
806
829
|
|
|
807
830
|
Admissions notes: an admission packet is the one link a school family gets to go
|
|
808
831
|
from "yes" to enrolled: create account, sign the tuition plan (and the partner
|
|
@@ -1185,22 +1208,23 @@ export const COMMAND_SUMMARIES = {
|
|
|
1185
1208
|
"goal-templates migrate-policy": "Migrate students' goals to the template policy.",
|
|
1186
1209
|
"goal-templates student-policy": "Edit one student's goal policy.",
|
|
1187
1210
|
"goal-templates retire-assignments": "Retire a goal's open assignments.",
|
|
1188
|
-
"goal-templates curriculum backlog": "Show goals' curriculum backlog.",
|
|
1189
|
-
"goal-templates curriculum preview": "Preview a curriculum version upgrade.",
|
|
1190
|
-
"goal-templates curriculum validate-resolutions": "Validate curriculum-upgrade conflict resolutions.",
|
|
1191
|
-
"goal-templates curriculum apply": "Apply a curriculum version to goals.",
|
|
1192
|
-
"goal-templates curriculum reverse": "Reverse a curriculum upgrade on goals.",
|
|
1193
|
-
"goal-templates curriculum status": "Check a curriculum job's status.",
|
|
1194
|
-
"goal-templates curriculum retry": "Retry a failed curriculum job.",
|
|
1211
|
+
"goal-templates curriculum backlog": "Show goals' curriculum backlog (deprecated for shared courses).",
|
|
1212
|
+
"goal-templates curriculum preview": "Preview a curriculum version upgrade (deprecated for shared courses).",
|
|
1213
|
+
"goal-templates curriculum validate-resolutions": "Validate curriculum-upgrade conflict resolutions (deprecated for shared courses).",
|
|
1214
|
+
"goal-templates curriculum apply": "Apply a curriculum version to goals (deprecated for shared courses).",
|
|
1215
|
+
"goal-templates curriculum reverse": "Reverse a curriculum upgrade on goals (deprecated for shared courses).",
|
|
1216
|
+
"goal-templates curriculum status": "Check a curriculum job's status (deprecated for shared courses).",
|
|
1217
|
+
"goal-templates curriculum retry": "Retry a failed curriculum job (deprecated for shared courses).",
|
|
1195
1218
|
"goal-templates versions": "List a template's version history.",
|
|
1196
1219
|
"goal-templates validate-spec": "Validate a template file (no write).",
|
|
1197
1220
|
"goal-templates create": "Create a goal template from a file.",
|
|
1198
1221
|
"goal-templates patch-spec": "Patch a template's setup-workflow spec (own PRIVATE ones for guardians).",
|
|
1199
|
-
"goal-templates set-metadata": "Edit a template's title, art, tags, visibility (own PRIVATE ones for guardians).",
|
|
1222
|
+
"goal-templates set-metadata": "Edit a template's title, art, tags, visibility (own PRIVATE ones for guardians, who may also unpublish their own: --visibility PRIVATE alone).",
|
|
1200
1223
|
"goal-templates delete": "Delete a goal template (own PRIVATE ones for guardians).",
|
|
1201
1224
|
"goal-templates generate-image": "Generate a template's cover art.",
|
|
1202
1225
|
"goal-templates snapshot-files": "List or read a template's snapshot files.",
|
|
1203
|
-
"goal-templates capture-snapshot": "Capture a goal/draft/checkout into a template snapshot.",
|
|
1226
|
+
"goal-templates capture-snapshot": "Capture a goal/draft/checkout into a template snapshot (deprecated for shared courses: use publish).",
|
|
1227
|
+
"goal-templates publish": "Publish a course version every kid on it reads (own templates for guardians); previews 'affects N kids'.",
|
|
1204
1228
|
"goal-templates answers-template": "Print a fillable answers file for a template's wizard.",
|
|
1205
1229
|
"goal-templates apply": "Apply a template for a student from answers.",
|
|
1206
1230
|
"goal-templates apply-starter": "Apply a starter template for a kid.",
|
|
@@ -1242,6 +1266,10 @@ export const COMMAND_SUMMARIES = {
|
|
|
1242
1266
|
"tutor-templates create": "Create a tutor template.",
|
|
1243
1267
|
"tutor-templates update": "Update a tutor template.",
|
|
1244
1268
|
"tutor-templates delete": "Delete a tutor template.",
|
|
1269
|
+
"goals notes list": "List Rocky's per-kid notes on a shared-course goal.",
|
|
1270
|
+
"goals notes get": "Read the goal's or one lesson's note.",
|
|
1271
|
+
"goals notes set": "Write Rocky's note for this kid on a lesson (never the lesson itself).",
|
|
1272
|
+
"goals progress": "Per-lesson progress for one kid's goal.",
|
|
1245
1273
|
"goals adaptations list": "List a goal's adaptation runs.",
|
|
1246
1274
|
"goals adaptations diff": "Diff the files an adaptation run changed.",
|
|
1247
1275
|
"goals files list": "List a goal workspace's files.",
|