#!/usr/bin/env bun /** * study-guide-builder * Creates structured study guides using OpenAI. */ import { parseArgs } from "util"; import { existsSync, mkdirSync, appendFileSync, readFileSync } from "fs"; import { join, dirname, resolve } from "path"; type OutputFormat = "markdown" | "json"; type StudyTemplate = Record; interface SkillOptions { material: string; subject?: string; level?: string; focus?: string; format: OutputFormat; model: string; output?: string; template?: StudyTemplate; } interface OpenAIChatResponse { choices?: Array<{ message?: { content?: string | null; }; }>; error?: { message?: string; }; } const SKILL_SLUG = "study-guide-builder"; function ensureDir(path: string) { if (!existsSync(path)) { mkdirSync(path, { recursive: true }); } } function getPaths() { const sessionStamp = new Date().toISOString().replace(/[:.]/g, "_").replace(/-/g, "_"); const exportsRoot = process.env.SKILLS_EXPORTS_DIR || join(process.cwd(), ".skills", "exports"); const logsRoot = process.env.SKILLS_LOGS_DIR || join(process.cwd(), ".skills", "logs"); const skillExportsDir = join(exportsRoot, SKILL_SLUG); const skillLogsDir = join(logsRoot, SKILL_SLUG); ensureDir(skillExportsDir); ensureDir(skillLogsDir); return { sessionStamp, skillExportsDir, skillLogsDir, }; } function createLogger(logDir: string, sessionStamp: string) { const logFile = join(logDir, `log_${sessionStamp}.txt`); function write(level: "info" | "success" | "error", message: string) { const timestamp = new Date().toISOString(); const entry = `[${timestamp}] [${level.toUpperCase()}] ${message}\n`; appendFileSync(logFile, entry); const prefix = level === "success" ? "✅" : level === "error" ? "❌" : "â„šī¸"; console.log(`${prefix} ${message}`); } return { info: (message: string) => write("info", message), success: (message: string) => write("success", message), error: (message: string) => write("error", message), logFile, }; } function slugify(value: string): string { return value .toLowerCase() .replace(/[^a-z0-9]+/g, "-") .replace(/^-+|-+$/g, "") .slice(0, 40) || "study-guide"; } function parseJsonTemplate(content: string): StudyTemplate | undefined { try { const data = JSON.parse(content); if (typeof data === "object" && data !== null) { return data as StudyTemplate; } } catch (_error) { // treat as text when parsing fails } return undefined; } function showHelp(): void { console.log(` study-guide-builder - Create structured study guides using AI Usage: skills run study-guide-builder -- [options] skills run study-guide-builder -- --text "" [options] Options: -h, --help Show this help message --text Inline study material --subject Subject area (default: general) --level Difficulty level (default: mixed) --focus Focus topic (default: core concepts) --format Output format: markdown | json (default: markdown) --model OpenAI model (default: gpt-4o-mini) --output Custom output file path Output includes: - Summary - Key terms - Comprehension checkpoints - Practice questions with answers - Spaced review plan - Study notes Examples: skills run study-guide-builder -- ./chapter.txt --subject "Biology" --level "intermediate" skills run study-guide-builder -- --text "Photosynthesis overview..." --focus "key reactions" Requirements: OPENAI_API_KEY environment variable must be set. `); } function parseOptions(): SkillOptions { const { values, positionals } = parseArgs({ args: Bun.argv.slice(2), options: { help: { type: "boolean", short: "h" }, text: { type: "string" }, subject: { type: "string" }, level: { type: "string" }, focus: { type: "string" }, format: { type: "string", default: "markdown" }, model: { type: "string", default: "gpt-4o-mini" }, output: { type: "string" }, }, allowPositionals: true, }); if (values.help) { showHelp(); process.exit(0); } let material = values.text || ""; let template: StudyTemplate | undefined; if (!material && positionals[0]) { const filePath = resolve(positionals[0]); const content = readFileSync(filePath, "utf-8"); template = parseJsonTemplate(content); material = template ? "" : content; } if (!material.trim() && !template) { throw new Error("Provide study materials via file path, JSON template, or --text."); } const format: OutputFormat = values.format === "json" ? "json" : values.format === "markdown" ? "markdown" : "markdown"; return { material, subject: values.subject, level: values.level, focus: values.focus, format, model: values.model, output: values.output, template, }; } function buildPrompt(options: SkillOptions) { const system = `You are a supportive study coach. Distill material into structured summaries, key terms, comprehension checks, and spaced review prompts. Encourage active recall and cite data when possible. Avoid guaranteeing grades.`; const instructions = options.format === "json" ? "Respond in JSON with keys: summary, key_terms, checkpoints, practice_questions, spaced_review, notes. Provide difficulty levels and answer keys where relevant." : "Respond in Markdown with sections for Summary, Key Terms, Checkpoints, Practice Questions (with answers hidden or separated), Spaced Review Plan, and Notes. Use tables for timelines if helpful."; const payload = { subject: options.subject || "general", level: options.level || "mixed", focus: options.focus || "core concepts", material_excerpt: options.material.substring(0, 6000), structured_template: options.template, }; const user = `${instructions}\n\nStudy material context:\n${JSON.stringify(payload, null, 2)}`; return { system, user }; } async function callOpenAI(options: SkillOptions, system: string, user: string): Promise { const apiKey = process.env.OPENAI_API_KEY; if (!apiKey) { throw new Error("OPENAI_API_KEY environment variable is required."); } const body = { model: options.model, messages: [ { role: "system", content: system }, { role: "user", content: user }, ], temperature: 0.45, max_tokens: options.format === "json" ? 2100 : 1900, }; const response = await fetch("https://api.openai.com/v1/chat/completions", { method: "POST", headers: { "Content-Type": "application/json", Authorization: `Bearer ${apiKey}`, }, body: JSON.stringify(body), }); const data: OpenAIChatResponse = await response.json(); if (!response.ok) { throw new Error(data.error?.message || `OpenAI API error (${response.status})`); } const content = data.choices?.[0]?.message?.content; if (!content) { throw new Error("OpenAI response did not include content."); } return content.trim(); } async function writeExport(path: string, content: string) { ensureDir(dirname(path)); await Bun.write(path, content); } function buildExportPath(skillExportsDir: string, sessionStamp: string, options: SkillOptions) { if (options.output) { return resolve(options.output); } const descriptorParts = [options.subject || "general", options.level || "mixed"]; const base = slugify(descriptorParts.filter(Boolean).join("-")); const extension = options.format === "json" ? "json" : "md"; return join(skillExportsDir, `${base}_${sessionStamp}.${extension}`); } function preview(content: string) { const lines = content.split(/\r?\n/).slice(0, 8); lines.forEach(line => console.log(` ${line}`)); if (content.split(/\r?\n/).length > 8) { console.log(" ..."); } } async function main() { const { sessionStamp, skillExportsDir, skillLogsDir } = getPaths(); const logger = createLogger(skillLogsDir, sessionStamp); try { const options = parseOptions(); logger.info("Parsed study material and options."); const { system, user } = buildPrompt(options); logger.info("Constructed study guide prompt."); const content = await callOpenAI(options, system, user); logger.success("Received study guide from OpenAI."); const exportPath = buildExportPath(skillExportsDir, sessionStamp, options); await writeExport(exportPath, content); logger.success(`Saved study guide to ${exportPath}`); console.log("\nPreview:"); preview(content); } catch (error) { const message = error instanceof Error ? error.message : String(error); logger.error(message); process.exitCode = 1; } } main();