@lifeaitools/rdc-skills 0.24.42 → 0.25.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/.claude/settings.json +15 -15
- package/.claude-plugin/marketplace.json +21 -21
- package/.claude-plugin/plugin.json +1518 -1371
- package/.github/workflows/publish.yml +34 -34
- package/.github/workflows/self-test.yml +58 -58
- package/CHANGELOG.md +310 -310
- package/LICENSE +21 -21
- package/MANIFEST.md +221 -221
- package/README.md +375 -376
- package/README.sandbox.md +3 -3
- package/assets/watcher/viewer.html +164 -164
- package/bin/rdc-skills-mcp.mjs +316 -316
- package/commands/build.md +183 -183
- package/commands/collab.md +180 -180
- package/commands/deploy.md +152 -152
- package/commands/design.md +31 -31
- package/commands/edit.md +28 -28
- package/commands/fixit.md +150 -124
- package/commands/handoff.md +173 -173
- package/commands/help.md +95 -95
- package/commands/overnight.md +220 -220
- package/commands/plan.md +158 -158
- package/commands/preplan.md +131 -131
- package/commands/prototype.md +145 -145
- package/commands/release.md +49 -49
- package/commands/report.md +99 -99
- package/commands/review.md +120 -120
- package/commands/self-test.md +113 -113
- package/commands/status.md +86 -86
- package/commands/watch.md +98 -98
- package/commands/workitems.md +137 -137
- package/git-sha.json +1 -1
- package/guides/agent-bootstrap.md +295 -295
- package/guides/agents/backend.md +104 -104
- package/guides/agents/content.md +94 -94
- package/guides/agents/cs2.md +56 -56
- package/guides/agents/data.md +87 -87
- package/guides/agents/design.md +77 -77
- package/guides/agents/frontend.md +92 -92
- package/guides/agents/infrastructure.md +81 -81
- package/guides/agents/setup.md +281 -281
- package/guides/agents/verify.md +151 -151
- package/guides/agents/viz.md +106 -106
- package/guides/backend.md +146 -146
- package/guides/content.md +147 -147
- package/guides/cs2.md +190 -190
- package/guides/data.md +123 -123
- package/guides/design.md +116 -116
- package/guides/engineering-behavior.md +43 -43
- package/guides/escalation-protocol.md +125 -125
- package/guides/frontend.md +151 -151
- package/guides/history-md-spec.md +297 -297
- package/guides/infrastructure.md +179 -179
- package/guides/lessons-learned-spec.md +145 -151
- package/guides/output-contract.md +108 -108
- package/guides/publish-md-spec.md +289 -289
- package/guides/rdc-skills-startup.md +30 -30
- package/guides/verify.md +11 -11
- package/hooks/check-cwd.js +31 -31
- package/hooks/check-rdc-environment.js +164 -164
- package/hooks/check-services.js +6 -6
- package/hooks/check-stale-work-items.js +19 -19
- package/hooks/foreground-process-gate.js +128 -128
- package/hooks/gate-watchdog-selfcheck.js +257 -257
- package/hooks/hook-logger.js +25 -25
- package/hooks/lib/run-evidence-gate.mjs +241 -241
- package/hooks/no-stop-open-epics.js +127 -127
- package/hooks/post-tool-batch-gate.js +203 -203
- package/hooks/post-work-check.js +21 -21
- package/hooks/postcompact-log.js +13 -13
- package/hooks/precompact-log.js +13 -13
- package/hooks/rate-limit-retry.js +46 -46
- package/hooks/rdc-invocation-marker.js +157 -157
- package/hooks/rdc-output-contract-gate.js +94 -94
- package/hooks/require-work-item-on-commit.js +294 -294
- package/hooks/restart-brief.js +19 -19
- package/hooks/run-hidden-hook.ps1 +47 -47
- package/hooks/task-completed-gate.js +274 -274
- package/hooks/work-item-exit-gate.js +944 -944
- package/lib/catalog.mjs +236 -236
- package/lib/cloud-rewrite.mjs +155 -155
- package/package.json +57 -57
- package/rules/work-items-rpc.md +520 -520
- package/scaffold/templates/HISTORY.md.template +39 -39
- package/scaffold/templates/PUBLISH.md.template +21 -21
- package/scaffold/templates/brochure-studio-default.html +70 -70
- package/scripts/acceptance.mjs +502 -502
- package/scripts/fixtures/guides/bad-guide.md +15 -15
- package/scripts/fixtures/guides-clean/good-guide.md +16 -16
- package/scripts/install-rdc-skills.js +1289 -1289
- package/scripts/install.ps1 +202 -202
- package/scripts/install.sh +132 -132
- package/scripts/lib/assertions.mjs +287 -287
- package/scripts/lib/manifest-schema.mjs +754 -754
- package/scripts/lib/runner.mjs +465 -465
- package/scripts/lib/sandbox.mjs +435 -435
- package/scripts/prepack.mjs +32 -32
- package/scripts/rdc-brochure.mjs +482 -482
- package/scripts/rdc-design-cli.mjs +134 -134
- package/scripts/rebuild-mcp.mjs +107 -107
- package/scripts/self-test.mjs +1460 -1460
- package/scripts/stamp-git-sha.mjs +29 -29
- package/scripts/test-guide-validator.mjs +196 -196
- package/scripts/test-rdc-hooks.mjs +145 -145
- package/scripts/uninstall.ps1 +77 -77
- package/scripts/uninstall.sh +69 -69
- package/scripts/update.ps1 +43 -43
- package/scripts/update.sh +43 -43
- package/scripts/validate-place-histories.js +461 -461
- package/scripts/validate-publish-manifests.js +502 -424
- package/scripts/watch-init.mjs +100 -100
- package/skills/brochure/SKILL.md +107 -107
- package/skills/build/SKILL.md +563 -563
- package/skills/channel-formatter/SKILL.md +538 -533
- package/skills/co-develop/SKILL.md +196 -196
- package/skills/collab/SKILL.md +239 -239
- package/skills/convert/SKILL.md +167 -140
- package/skills/deploy/SKILL.md +541 -541
- package/skills/design/SKILL.md +211 -211
- package/skills/design/reference/ownership.md +16 -16
- package/skills/design/reference/rampa.md +92 -92
- package/skills/design/reference/studio-model.md +153 -153
- package/skills/edit/SKILL.md +98 -98
- package/skills/fixit/SKILL.md +203 -165
- package/skills/fs-mcp/SKILL.md +148 -148
- package/skills/handoff/SKILL.md +236 -236
- package/skills/help/SKILL.md +143 -143
- package/skills/housekeeping/SKILL.md +160 -219
- package/skills/lifeai-brochure-author/SKILL.md +340 -340
- package/skills/onramp/SKILL.md +248 -0
- package/skills/overnight/SKILL.md +251 -251
- package/skills/plan/SKILL.md +345 -345
- package/skills/preplan/SKILL.md +90 -90
- package/skills/prototype/SKILL.md +150 -150
- package/skills/rdc-brochurify/SKILL.md +245 -245
- package/skills/rdc-extract-verifier-rules/SKILL.md +191 -191
- package/skills/release/SKILL.md +140 -140
- package/skills/report/SKILL.md +100 -100
- package/skills/review/SKILL.md +152 -152
- package/skills/rpms-filemap/SKILL.cloud.md +111 -111
- package/skills/rpms-filemap/SKILL.md +111 -111
- package/skills/self-test/SKILL.md +132 -132
- package/skills/status/SKILL.md +99 -99
- package/skills/terminal-config/SKILL.md +62 -62
- package/skills/tests/MATRIX.md +54 -54
- package/skills/tests/README.md +47 -47
- package/skills/tests/onramp.test.json +87 -0
- package/skills/tests/rdc-brochure.test.json +34 -34
- package/skills/tests/rdc-build.test.json +36 -36
- package/skills/tests/rdc-channel-formatter.test.json +45 -45
- package/skills/tests/rdc-co-develop.test.json +29 -29
- package/skills/tests/rdc-collab.test.json +29 -29
- package/skills/tests/rdc-convert.test.json +35 -35
- package/skills/tests/rdc-deploy.test.json +30 -30
- package/skills/tests/rdc-design.test.json +27 -27
- package/skills/tests/rdc-edit.test.json +29 -29
- package/skills/tests/rdc-fixit.test.json +36 -36
- package/skills/tests/rdc-fs-mcp.test.json +36 -36
- package/skills/tests/rdc-handoff.test.json +28 -28
- package/skills/tests/rdc-help.test.json +29 -29
- package/skills/tests/rdc-housekeeping.test.json +28 -32
- package/skills/tests/rdc-lifeai-brochure-author.test.json +35 -35
- package/skills/tests/rdc-overnight.test.json +37 -37
- package/skills/tests/rdc-plan.test.json +27 -27
- package/skills/tests/rdc-preplan.test.json +31 -31
- package/skills/tests/rdc-prototype.test.json +28 -28
- package/skills/tests/rdc-rdc-brochurify.test.json +23 -23
- package/skills/tests/rdc-rdc-extract-verifier-rules.test.json +34 -34
- package/skills/tests/rdc-release.test.json +29 -29
- package/skills/tests/rdc-report.test.json +28 -28
- package/skills/tests/rdc-review.test.json +29 -29
- package/skills/tests/rdc-rpms-filemap.test.json +28 -28
- package/skills/tests/rdc-self-test.test.json +24 -24
- package/skills/tests/rdc-status.test.json +29 -29
- package/skills/tests/rdc-terminal-config.test.json +29 -29
- package/skills/tests/rdc-watch.test.json +24 -24
- package/skills/tests/rdc-workitems.test.json +27 -27
- package/skills/watch/SKILL.md +97 -97
- package/skills/workitems/SKILL.md +151 -151
- package/tests/acceptance.test.mjs +59 -59
- package/tests/channel-formatter.contract.test.mjs +251 -251
- package/tests/curl-surface.test.mjs +289 -289
- package/tests/harness-gates.test.mjs +325 -325
- package/tests/help-surface.test.mjs +61 -61
- package/tests/install-rdc-skills.test.mjs +49 -49
- package/tests/manifest-contract-fields.test.mjs +78 -78
- package/tests/mcp.test.mjs +271 -271
- package/tests/rdc-brochure.test.mjs +125 -125
- package/tests/require-work-item-on-commit.test.mjs +162 -162
- package/tests/run-evidence-gate.test.mjs +82 -82
- package/tests/skill-test-matrix.test.mjs +66 -66
- package/tests/validate-skills.js +27 -27
- package/tests/work-item-exit-gate-l2.test.mjs +368 -368
- package/tests/work-item-exit-gate-l3.test.mjs +197 -197
- package/RELEASE.md +0 -42
- package/tests/housekeeping-lessons-triage.test.mjs +0 -49
- package/tests/lessons-pipeline-contract.test.mjs +0 -27
- package/tests/release-contract.test.mjs +0 -16
package/scripts/watch-init.mjs
CHANGED
|
@@ -1,100 +1,100 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
// watch-init.mjs — initialize a session log + viewer for rdc:watch.
|
|
3
|
-
//
|
|
4
|
-
// Usage:
|
|
5
|
-
// node scripts/watch-init.mjs [--project-root <path>]
|
|
6
|
-
//
|
|
7
|
-
// Creates:
|
|
8
|
-
// <projectRoot>/.rdc/session-log/<runId>.log (with banner line)
|
|
9
|
-
// <projectRoot>/.rdc/session-log/current.log (copy of the new log)
|
|
10
|
-
// <projectRoot>/.rdc/session-log/viewer.html (copied from plugin assets)
|
|
11
|
-
//
|
|
12
|
-
// Exits 0 on success, 1 on error.
|
|
13
|
-
|
|
14
|
-
import { mkdirSync, writeFileSync, copyFileSync, existsSync, statSync, readFileSync } from "node:fs";
|
|
15
|
-
import { join, resolve, dirname } from "node:path";
|
|
16
|
-
import { fileURLToPath } from "node:url";
|
|
17
|
-
import { platform } from "node:os";
|
|
18
|
-
|
|
19
|
-
function parseArgs(argv) {
|
|
20
|
-
const out = { projectRoot: process.cwd() };
|
|
21
|
-
for (let i = 0; i < argv.length; i++) {
|
|
22
|
-
if (argv[i] === "--project-root" && argv[i + 1]) {
|
|
23
|
-
out.projectRoot = resolve(argv[++i]);
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
return out;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
function randId(n) {
|
|
30
|
-
const chars = "abcdefghijklmnopqrstuvwxyz0123456789";
|
|
31
|
-
let s = "";
|
|
32
|
-
for (let i = 0; i < n; i++) s += chars[Math.floor(Math.random() * chars.length)];
|
|
33
|
-
return s;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
function makeRunId() {
|
|
37
|
-
const d = new Date();
|
|
38
|
-
const pad = (x) => String(x).padStart(2, "0");
|
|
39
|
-
const stamp =
|
|
40
|
-
d.getFullYear() + "-" + pad(d.getMonth() + 1) + "-" + pad(d.getDate()) +
|
|
41
|
-
"-" + pad(d.getHours()) + pad(d.getMinutes()) + pad(d.getSeconds());
|
|
42
|
-
return stamp + "-" + randId(6);
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
function openHint(viewerPath) {
|
|
46
|
-
const p = platform();
|
|
47
|
-
if (p === "win32") return `start "" "${viewerPath}"`;
|
|
48
|
-
if (p === "darwin") return `open "${viewerPath}"`;
|
|
49
|
-
return `xdg-open "${viewerPath}"`;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
function main() {
|
|
53
|
-
const { projectRoot } = parseArgs(process.argv.slice(2));
|
|
54
|
-
const here = dirname(fileURLToPath(import.meta.url)); // .../rdc-skills/scripts
|
|
55
|
-
const pluginRoot = resolve(here, ".."); // .../rdc-skills
|
|
56
|
-
const assetViewer = join(pluginRoot, "assets", "watcher", "viewer.html");
|
|
57
|
-
|
|
58
|
-
if (!existsSync(assetViewer)) {
|
|
59
|
-
console.error(`watch-init: viewer asset missing at ${assetViewer}`);
|
|
60
|
-
process.exit(1);
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
const logDir = join(projectRoot, ".rdc", "session-log");
|
|
64
|
-
mkdirSync(logDir, { recursive: true });
|
|
65
|
-
|
|
66
|
-
const runId = makeRunId();
|
|
67
|
-
const logPath = join(logDir, `${runId}.log`);
|
|
68
|
-
const currentPath = join(logDir, "current.log");
|
|
69
|
-
const viewerPath = join(logDir, "viewer.html");
|
|
70
|
-
|
|
71
|
-
const iso = new Date().toISOString();
|
|
72
|
-
const banner = `[${iso}] [banner] Session started: ${runId}\n`;
|
|
73
|
-
writeFileSync(logPath, banner, "utf8");
|
|
74
|
-
writeFileSync(currentPath, banner, "utf8");
|
|
75
|
-
|
|
76
|
-
// Copy viewer.html if missing or stale (source newer than dest).
|
|
77
|
-
let needsCopy = !existsSync(viewerPath);
|
|
78
|
-
if (!needsCopy) {
|
|
79
|
-
try {
|
|
80
|
-
const srcM = statSync(assetViewer).mtimeMs;
|
|
81
|
-
const dstM = statSync(viewerPath).mtimeMs;
|
|
82
|
-
if (srcM > dstM) needsCopy = true;
|
|
83
|
-
} catch { needsCopy = true; }
|
|
84
|
-
}
|
|
85
|
-
if (needsCopy) copyFileSync(assetViewer, viewerPath);
|
|
86
|
-
|
|
87
|
-
console.log("run_id: " + runId);
|
|
88
|
-
console.log("log_path: " + logPath);
|
|
89
|
-
console.log("current: " + currentPath);
|
|
90
|
-
console.log("viewer: " + viewerPath);
|
|
91
|
-
console.log("open_hint: " + openHint(viewerPath));
|
|
92
|
-
process.exit(0);
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
try {
|
|
96
|
-
main();
|
|
97
|
-
} catch (err) {
|
|
98
|
-
console.error("watch-init: " + (err && err.message ? err.message : String(err)));
|
|
99
|
-
process.exit(1);
|
|
100
|
-
}
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// watch-init.mjs — initialize a session log + viewer for rdc:watch.
|
|
3
|
+
//
|
|
4
|
+
// Usage:
|
|
5
|
+
// node scripts/watch-init.mjs [--project-root <path>]
|
|
6
|
+
//
|
|
7
|
+
// Creates:
|
|
8
|
+
// <projectRoot>/.rdc/session-log/<runId>.log (with banner line)
|
|
9
|
+
// <projectRoot>/.rdc/session-log/current.log (copy of the new log)
|
|
10
|
+
// <projectRoot>/.rdc/session-log/viewer.html (copied from plugin assets)
|
|
11
|
+
//
|
|
12
|
+
// Exits 0 on success, 1 on error.
|
|
13
|
+
|
|
14
|
+
import { mkdirSync, writeFileSync, copyFileSync, existsSync, statSync, readFileSync } from "node:fs";
|
|
15
|
+
import { join, resolve, dirname } from "node:path";
|
|
16
|
+
import { fileURLToPath } from "node:url";
|
|
17
|
+
import { platform } from "node:os";
|
|
18
|
+
|
|
19
|
+
function parseArgs(argv) {
|
|
20
|
+
const out = { projectRoot: process.cwd() };
|
|
21
|
+
for (let i = 0; i < argv.length; i++) {
|
|
22
|
+
if (argv[i] === "--project-root" && argv[i + 1]) {
|
|
23
|
+
out.projectRoot = resolve(argv[++i]);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
return out;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
function randId(n) {
|
|
30
|
+
const chars = "abcdefghijklmnopqrstuvwxyz0123456789";
|
|
31
|
+
let s = "";
|
|
32
|
+
for (let i = 0; i < n; i++) s += chars[Math.floor(Math.random() * chars.length)];
|
|
33
|
+
return s;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function makeRunId() {
|
|
37
|
+
const d = new Date();
|
|
38
|
+
const pad = (x) => String(x).padStart(2, "0");
|
|
39
|
+
const stamp =
|
|
40
|
+
d.getFullYear() + "-" + pad(d.getMonth() + 1) + "-" + pad(d.getDate()) +
|
|
41
|
+
"-" + pad(d.getHours()) + pad(d.getMinutes()) + pad(d.getSeconds());
|
|
42
|
+
return stamp + "-" + randId(6);
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function openHint(viewerPath) {
|
|
46
|
+
const p = platform();
|
|
47
|
+
if (p === "win32") return `start "" "${viewerPath}"`;
|
|
48
|
+
if (p === "darwin") return `open "${viewerPath}"`;
|
|
49
|
+
return `xdg-open "${viewerPath}"`;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
function main() {
|
|
53
|
+
const { projectRoot } = parseArgs(process.argv.slice(2));
|
|
54
|
+
const here = dirname(fileURLToPath(import.meta.url)); // .../rdc-skills/scripts
|
|
55
|
+
const pluginRoot = resolve(here, ".."); // .../rdc-skills
|
|
56
|
+
const assetViewer = join(pluginRoot, "assets", "watcher", "viewer.html");
|
|
57
|
+
|
|
58
|
+
if (!existsSync(assetViewer)) {
|
|
59
|
+
console.error(`watch-init: viewer asset missing at ${assetViewer}`);
|
|
60
|
+
process.exit(1);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
const logDir = join(projectRoot, ".rdc", "session-log");
|
|
64
|
+
mkdirSync(logDir, { recursive: true });
|
|
65
|
+
|
|
66
|
+
const runId = makeRunId();
|
|
67
|
+
const logPath = join(logDir, `${runId}.log`);
|
|
68
|
+
const currentPath = join(logDir, "current.log");
|
|
69
|
+
const viewerPath = join(logDir, "viewer.html");
|
|
70
|
+
|
|
71
|
+
const iso = new Date().toISOString();
|
|
72
|
+
const banner = `[${iso}] [banner] Session started: ${runId}\n`;
|
|
73
|
+
writeFileSync(logPath, banner, "utf8");
|
|
74
|
+
writeFileSync(currentPath, banner, "utf8");
|
|
75
|
+
|
|
76
|
+
// Copy viewer.html if missing or stale (source newer than dest).
|
|
77
|
+
let needsCopy = !existsSync(viewerPath);
|
|
78
|
+
if (!needsCopy) {
|
|
79
|
+
try {
|
|
80
|
+
const srcM = statSync(assetViewer).mtimeMs;
|
|
81
|
+
const dstM = statSync(viewerPath).mtimeMs;
|
|
82
|
+
if (srcM > dstM) needsCopy = true;
|
|
83
|
+
} catch { needsCopy = true; }
|
|
84
|
+
}
|
|
85
|
+
if (needsCopy) copyFileSync(assetViewer, viewerPath);
|
|
86
|
+
|
|
87
|
+
console.log("run_id: " + runId);
|
|
88
|
+
console.log("log_path: " + logPath);
|
|
89
|
+
console.log("current: " + currentPath);
|
|
90
|
+
console.log("viewer: " + viewerPath);
|
|
91
|
+
console.log("open_hint: " + openHint(viewerPath));
|
|
92
|
+
process.exit(0);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
try {
|
|
96
|
+
main();
|
|
97
|
+
} catch (err) {
|
|
98
|
+
console.error("watch-init: " + (err && err.message ? err.message : String(err)));
|
|
99
|
+
process.exit(1);
|
|
100
|
+
}
|
package/skills/brochure/SKILL.md
CHANGED
|
@@ -1,107 +1,107 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: rdc:brochure
|
|
3
|
-
description: "Usage `rdc:brochure <input> [--out <path>] [--template <name>] [--format Letter|A4]` — Turn a zip, folder, HTML file, URL, or markdown folder into a print-quality PDF brochure via Puppeteer. Auto-detects print-variant HTML, honors @page CSS, falls back to a Studio-token-aware template when no HTML exists."
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> **⚠️ OUTPUT CONTRACT (READ FIRST):** `guides/output-contract.md`
|
|
7
|
-
> Checklist-only output. No tool-call narration. No raw MCP/JSON/log dumps.
|
|
8
|
-
> One checklist upfront, updated in place, shown again at end with a 1-line verdict.
|
|
9
|
-
|
|
10
|
-
> **Sandbox contract:** Honors `RDC_TEST=1`. Under the flag the skill renders to a fixture path and skips any post-deploy or upload steps.
|
|
11
|
-
|
|
12
|
-
# rdc:brochure — Zip / Folder / HTML → PDF Brochure
|
|
13
|
-
|
|
14
|
-
A focused render pipeline. Two modes:
|
|
15
|
-
|
|
16
|
-
1. **Render mode** — input already contains print-ready HTML. Skill picks the best HTML file and renders it.
|
|
17
|
-
2. **Compose mode** — input is a folder of assets + markdown/text with no HTML. Skill composes a Studio-token-aware brochure layout, then renders it.
|
|
18
|
-
|
|
19
|
-
## When to Use
|
|
20
|
-
- A client zip of deliverables that includes a print-first HTML doc (FuturVille ASP, ranch reports, project plans).
|
|
21
|
-
- A `places/<slug>/` or `apps/<app>/` markdown package that needs a PDF artifact.
|
|
22
|
-
- A single URL or HTML file you want as a clean PDF.
|
|
23
|
-
|
|
24
|
-
## When NOT to Use
|
|
25
|
-
- Production marketing collateral that lives in `apps/*` and ships via Coolify — that goes through `rdc:design` + `rdc:deploy`.
|
|
26
|
-
- Multi-document publication systems — use `rdc:plan` to scaffold first.
|
|
27
|
-
|
|
28
|
-
## Arguments
|
|
29
|
-
- `rdc:brochure <input>` — path to `.zip`, folder, `.html`, `.md`, or `http(s)://...` URL.
|
|
30
|
-
- `--out <path>` — output PDF path. Default: `<input-basename>.pdf` next to the input (or `./brochure.pdf` for URLs).
|
|
31
|
-
- `--template <name>` — compose-mode template. Default `studio-default`. Templates live in `scaffold/templates/brochure-*.html`. An unknown name errors out and lists the available template(s) — it does not silently fall back.
|
|
32
|
-
- `--format Letter|A4` — page size. Default `Letter`.
|
|
33
|
-
- `--margin <css>` — override margin. Default honors `@page` from source CSS, else `0.6in 0.7in`.
|
|
34
|
-
- `--no-print-emulate` — render with screen media instead of print.
|
|
35
|
-
- `--keep-workdir` — keep the staged working directory for inspection.
|
|
36
|
-
- `--auto-fit` — inject corrective print-fit CSS (oversized images, wide tables, long code, heading orphans, figure splits) and log overflow diagnostics. Use when source HTML overflows page boundaries.
|
|
37
|
-
- `--scale <n>` — PDF scale factor (e.g. `0.92` to tighten). Default `1`.
|
|
38
|
-
|
|
39
|
-
## Procedure
|
|
40
|
-
|
|
41
|
-
1. **Resolve input.**
|
|
42
|
-
- Zip → extract to `tmp/rdc-brochure/<hash>/src`.
|
|
43
|
-
- Folder → stage in place (read-only).
|
|
44
|
-
- URL → fetch into a sandbox dir as `index.html` + linked assets via Puppeteer.
|
|
45
|
-
- `.html` → stage as-is.
|
|
46
|
-
- `.md` or folder-without-html → compose mode.
|
|
47
|
-
|
|
48
|
-
2. **Pick HTML in render mode.**
|
|
49
|
-
- Prefer the largest standalone HTML containing `@page` or `@media print` rules.
|
|
50
|
-
- Else prefer files matching `*-print.html`, `*-brochure.html`, `print.html`.
|
|
51
|
-
- Else the largest HTML at root.
|
|
52
|
-
|
|
53
|
-
3. **Compose mode.**
|
|
54
|
-
- Read the chosen template (`scaffold/templates/brochure-studio-default.html`).
|
|
55
|
-
- Inventory the input dir: `*.md`, `*.txt`, images grouped by directory, `cover.*`, `logo.*`.
|
|
56
|
-
- Render markdown to HTML, inject into template slots: cover, foreword, sections, figures, back-matter.
|
|
57
|
-
- Use Studio token CSS (Source Serif 4 + Hanken Grotesk, loam/moss/ochre palette) as the default. If a sibling `tokens.css` is present, prefer that.
|
|
58
|
-
|
|
59
|
-
4. **Render with Puppeteer.**
|
|
60
|
-
- `headless: 'new'`, `--font-render-hinting=none`.
|
|
61
|
-
- `waitUntil: 'networkidle0'`, await `document.fonts.ready`, then 1500ms settle.
|
|
62
|
-
- `emulateMediaType('print')` unless `--no-print-emulate`.
|
|
63
|
-
- `printBackground: true`, `preferCSSPageSize: true`.
|
|
64
|
-
- Letter @ `0.6in 0.7in` default margins.
|
|
65
|
-
|
|
66
|
-
5. **Verify.**
|
|
67
|
-
- Output exists and `> 50KB`.
|
|
68
|
-
- PDF metadata: page count > 0.
|
|
69
|
-
- Log: input, picked HTML or template, page count, file size, output path.
|
|
70
|
-
|
|
71
|
-
## Output
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
PDF: <absolute path>
|
|
75
|
-
Pages: <n>
|
|
76
|
-
Size: <human bytes>
|
|
77
|
-
Source: <input> → <chosen html or template>
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
## Boundaries
|
|
81
|
-
- Does not commit, publish, or upload the resulting PDF. The user moves it.
|
|
82
|
-
- Does not modify the source input.
|
|
83
|
-
- Does not auto-install global dependencies — uses `npx puppeteer` via the skill's own `node_modules` if present, otherwise an on-demand local install under `~/.cache/rdc-brochure/`.
|
|
84
|
-
- Compose-mode templates live in `scaffold/templates/brochure-*.html`. New templates need `rdc:plan` if they cross the architectural-change-approval triggers.
|
|
85
|
-
|
|
86
|
-
## Implementation
|
|
87
|
-
The executable is `scripts/rdc-brochure.mjs` (in the rdc-skills repo). Invoke directly:
|
|
88
|
-
|
|
89
|
-
```powershell
|
|
90
|
-
node {RDC_SKILLS_ROOT}/scripts/rdc-brochure.mjs <input> [--out path] [--template name] [--format Letter|A4]
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
## Examples
|
|
94
|
-
|
|
95
|
-
```powershell
|
|
96
|
-
# Zip of deliverables with print HTML inside
|
|
97
|
-
rdc:brochure "C:/Users/me/Downloads/FuturVille Deliverables.zip"
|
|
98
|
-
|
|
99
|
-
# Folder of markdown + images, compose a brochure
|
|
100
|
-
rdc:brochure "places/futurville-vulcan" --template studio-default --out reports/futurville.pdf
|
|
101
|
-
|
|
102
|
-
# Single HTML to PDF, A4
|
|
103
|
-
rdc:brochure docs/source/some-prototype.html --format A4
|
|
104
|
-
|
|
105
|
-
# URL
|
|
106
|
-
rdc:brochure https://example.com/spec.html --out spec.pdf
|
|
107
|
-
```
|
|
1
|
+
---
|
|
2
|
+
name: rdc:brochure
|
|
3
|
+
description: "Usage `rdc:brochure <input> [--out <path>] [--template <name>] [--format Letter|A4]` — Turn a zip, folder, HTML file, URL, or markdown folder into a print-quality PDF brochure via Puppeteer. Auto-detects print-variant HTML, honors @page CSS, falls back to a Studio-token-aware template when no HTML exists."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
> **⚠️ OUTPUT CONTRACT (READ FIRST):** `guides/output-contract.md`
|
|
7
|
+
> Checklist-only output. No tool-call narration. No raw MCP/JSON/log dumps.
|
|
8
|
+
> One checklist upfront, updated in place, shown again at end with a 1-line verdict.
|
|
9
|
+
|
|
10
|
+
> **Sandbox contract:** Honors `RDC_TEST=1`. Under the flag the skill renders to a fixture path and skips any post-deploy or upload steps.
|
|
11
|
+
|
|
12
|
+
# rdc:brochure — Zip / Folder / HTML → PDF Brochure
|
|
13
|
+
|
|
14
|
+
A focused render pipeline. Two modes:
|
|
15
|
+
|
|
16
|
+
1. **Render mode** — input already contains print-ready HTML. Skill picks the best HTML file and renders it.
|
|
17
|
+
2. **Compose mode** — input is a folder of assets + markdown/text with no HTML. Skill composes a Studio-token-aware brochure layout, then renders it.
|
|
18
|
+
|
|
19
|
+
## When to Use
|
|
20
|
+
- A client zip of deliverables that includes a print-first HTML doc (FuturVille ASP, ranch reports, project plans).
|
|
21
|
+
- A `places/<slug>/` or `apps/<app>/` markdown package that needs a PDF artifact.
|
|
22
|
+
- A single URL or HTML file you want as a clean PDF.
|
|
23
|
+
|
|
24
|
+
## When NOT to Use
|
|
25
|
+
- Production marketing collateral that lives in `apps/*` and ships via Coolify — that goes through `rdc:design` + `rdc:deploy`.
|
|
26
|
+
- Multi-document publication systems — use `rdc:plan` to scaffold first.
|
|
27
|
+
|
|
28
|
+
## Arguments
|
|
29
|
+
- `rdc:brochure <input>` — path to `.zip`, folder, `.html`, `.md`, or `http(s)://...` URL.
|
|
30
|
+
- `--out <path>` — output PDF path. Default: `<input-basename>.pdf` next to the input (or `./brochure.pdf` for URLs).
|
|
31
|
+
- `--template <name>` — compose-mode template. Default `studio-default`. Templates live in `scaffold/templates/brochure-*.html`. An unknown name errors out and lists the available template(s) — it does not silently fall back.
|
|
32
|
+
- `--format Letter|A4` — page size. Default `Letter`.
|
|
33
|
+
- `--margin <css>` — override margin. Default honors `@page` from source CSS, else `0.6in 0.7in`.
|
|
34
|
+
- `--no-print-emulate` — render with screen media instead of print.
|
|
35
|
+
- `--keep-workdir` — keep the staged working directory for inspection.
|
|
36
|
+
- `--auto-fit` — inject corrective print-fit CSS (oversized images, wide tables, long code, heading orphans, figure splits) and log overflow diagnostics. Use when source HTML overflows page boundaries.
|
|
37
|
+
- `--scale <n>` — PDF scale factor (e.g. `0.92` to tighten). Default `1`.
|
|
38
|
+
|
|
39
|
+
## Procedure
|
|
40
|
+
|
|
41
|
+
1. **Resolve input.**
|
|
42
|
+
- Zip → extract to `tmp/rdc-brochure/<hash>/src`.
|
|
43
|
+
- Folder → stage in place (read-only).
|
|
44
|
+
- URL → fetch into a sandbox dir as `index.html` + linked assets via Puppeteer.
|
|
45
|
+
- `.html` → stage as-is.
|
|
46
|
+
- `.md` or folder-without-html → compose mode.
|
|
47
|
+
|
|
48
|
+
2. **Pick HTML in render mode.**
|
|
49
|
+
- Prefer the largest standalone HTML containing `@page` or `@media print` rules.
|
|
50
|
+
- Else prefer files matching `*-print.html`, `*-brochure.html`, `print.html`.
|
|
51
|
+
- Else the largest HTML at root.
|
|
52
|
+
|
|
53
|
+
3. **Compose mode.**
|
|
54
|
+
- Read the chosen template (`scaffold/templates/brochure-studio-default.html`).
|
|
55
|
+
- Inventory the input dir: `*.md`, `*.txt`, images grouped by directory, `cover.*`, `logo.*`.
|
|
56
|
+
- Render markdown to HTML, inject into template slots: cover, foreword, sections, figures, back-matter.
|
|
57
|
+
- Use Studio token CSS (Source Serif 4 + Hanken Grotesk, loam/moss/ochre palette) as the default. If a sibling `tokens.css` is present, prefer that.
|
|
58
|
+
|
|
59
|
+
4. **Render with Puppeteer.**
|
|
60
|
+
- `headless: 'new'`, `--font-render-hinting=none`.
|
|
61
|
+
- `waitUntil: 'networkidle0'`, await `document.fonts.ready`, then 1500ms settle.
|
|
62
|
+
- `emulateMediaType('print')` unless `--no-print-emulate`.
|
|
63
|
+
- `printBackground: true`, `preferCSSPageSize: true`.
|
|
64
|
+
- Letter @ `0.6in 0.7in` default margins.
|
|
65
|
+
|
|
66
|
+
5. **Verify.**
|
|
67
|
+
- Output exists and `> 50KB`.
|
|
68
|
+
- PDF metadata: page count > 0.
|
|
69
|
+
- Log: input, picked HTML or template, page count, file size, output path.
|
|
70
|
+
|
|
71
|
+
## Output
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
PDF: <absolute path>
|
|
75
|
+
Pages: <n>
|
|
76
|
+
Size: <human bytes>
|
|
77
|
+
Source: <input> → <chosen html or template>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Boundaries
|
|
81
|
+
- Does not commit, publish, or upload the resulting PDF. The user moves it.
|
|
82
|
+
- Does not modify the source input.
|
|
83
|
+
- Does not auto-install global dependencies — uses `npx puppeteer` via the skill's own `node_modules` if present, otherwise an on-demand local install under `~/.cache/rdc-brochure/`.
|
|
84
|
+
- Compose-mode templates live in `scaffold/templates/brochure-*.html`. New templates need `rdc:plan` if they cross the architectural-change-approval triggers.
|
|
85
|
+
|
|
86
|
+
## Implementation
|
|
87
|
+
The executable is `scripts/rdc-brochure.mjs` (in the rdc-skills repo). Invoke directly:
|
|
88
|
+
|
|
89
|
+
```powershell
|
|
90
|
+
node {RDC_SKILLS_ROOT}/scripts/rdc-brochure.mjs <input> [--out path] [--template name] [--format Letter|A4]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Examples
|
|
94
|
+
|
|
95
|
+
```powershell
|
|
96
|
+
# Zip of deliverables with print HTML inside
|
|
97
|
+
rdc:brochure "C:/Users/me/Downloads/FuturVille Deliverables.zip"
|
|
98
|
+
|
|
99
|
+
# Folder of markdown + images, compose a brochure
|
|
100
|
+
rdc:brochure "places/futurville-vulcan" --template studio-default --out reports/futurville.pdf
|
|
101
|
+
|
|
102
|
+
# Single HTML to PDF, A4
|
|
103
|
+
rdc:brochure docs/source/some-prototype.html --format A4
|
|
104
|
+
|
|
105
|
+
# URL
|
|
106
|
+
rdc:brochure https://example.com/spec.html --out spec.pdf
|
|
107
|
+
```
|