yt-briefing 0.7.0 → 0.9.0

package/README.md

@@ -1,11 +1,11 @@
 # yt-briefing
 
-Save hours on YouTube. yt-briefing watches the channels you follow so you don't have to. It
-turns each new video into a short summary in your own language that keeps what matters and
-skips the filler. Reading it takes a fraction of the time the video would, so you stay on top
-of everything and only watch what's actually worth it.
+Save hours on YouTube. yt-briefing watches the channels you follow so you don't have to. For
+each new video it distills the essence in your own language — every point that matters, with
+only the filler cut, so nothing important is lost. Reading it takes a fraction of the time the
+video would, so you stay on top of everything and only watch what's actually worth it.
 
-It also gets better the more you use it. You give each summary a quick rating, worth my time
+It also gets better the more you use it. You give each briefing a quick rating, worth my time
 or not, and from that it learns what to keep showing you and what to drop. Over time the queue
 becomes yours: less noise, more of what you care about.
 
@@ -46,13 +46,26 @@ yarn add yt-briefing
 bun  add yt-briefing
 ```
 
-3. Onboard:
+3. Put your keys in a `.env` at your project root — all four are required:
+
+```ini
+YT_BRIEFING_LLM_BASE_URL=https://generativelanguage.googleapis.com/v1beta/openai
+YT_BRIEFING_LLM_API_KEY=<key>        # free at https://aistudio.google.com/apikey
+YT_BRIEFING_LLM_MODEL=gemini-2.5-flash
+YT_BRIEFING_YOUTUBE_API_KEY=<key>    # console.cloud.google.com → enable "YouTube Data API v3"
+```
+
+Any OpenAI-compatible endpoint works — see [Providers](#providers) to use OpenRouter, OpenAI, or a
+local Ollama instead of Gemini. Miss a key and the engine tells you exactly which one. Keep `.env`
+gitignored; `YT_BRIEFING_PROXY` (datacenter/VPS IPs) is the only optional extra.
+
+4. Onboard:
 
 ```bash
 npx yt-briefing init      # or: bunx yt-briefing init
 ```
 
-`init` asks for your language, your keys, the channels to follow, and which tool runs `/yt`.
+`init` asks for your language, the channels to follow, and which tool runs `/yt`.
 
 Add or remove channels anytime:
 
@@ -64,12 +77,12 @@ npx yt-briefing list                                        # show the current l
 
 ## One-off: transcribe a single video
 
-Just want one video summarized — no channels, no queue, no rating? Run `/yt-transcribe` and
+Just want one video distilled — no channels, no queue, no rating? Run `/yt-transcribe` and
 paste a URL or video ID. It pulls that video's transcript and writes a journalist-grade
-summary in the language you chose at setup (the same `output_lang` as `/yt`). Want a one-off in
+briefing in the language you chose at setup (the same `output_lang` as `/yt`). Want a one-off in
 another language? Just say so when you run it (e.g. `/yt-transcribe <url> in German`) — it
 won't change your setup. `--lang pl|en` is separate — it picks which caption track to fetch,
-not the summary language.
+not the language it's written in.
 
 The skill is installed alongside `/yt` by `init` / `install-skill`. From the plain CLI:
 
@@ -110,32 +123,16 @@ YT_BRIEFING_LLM_MODEL=gemini-2.5-flash
 > or switch to a paid key (enable billing, same model) to avoid it.
 
 Want something else? Change those three lines for OpenRouter (`https://openrouter.ai/api/v1`),
-OpenAI (`https://api.openai.com/v1`), or a local Ollama (`http://localhost:11434/v1`).
-
-### Where the keys live
-
-Keys are read from your project's **root `.env`** only — there is no fallback file. Put them there
-(or export them in the shell / CI — an exported var wins). `bun run init` writes them into your
-root `.env`, merging without clobbering any other variables already in it.
-
-These are **required**, and missing one fails fast naming exactly which (no silent defaults):
-
-```ini
-YT_BRIEFING_LLM_BASE_URL=https://generativelanguage.googleapis.com/v1beta/openai
-YT_BRIEFING_LLM_API_KEY=<your-key>
-YT_BRIEFING_LLM_MODEL=gemini-2.5-flash
-YT_BRIEFING_YOUTUBE_API_KEY=<your-key>
-```
-
-`YT_BRIEFING_PROXY` and `YT_BRIEFING_DLP_PATH` are optional. Keep `.env` gitignored.
+OpenAI (`https://api.openai.com/v1`), or a local Ollama (`http://localhost:11434/v1`). Set
+`YT_BRIEFING_LLM_BASE_URL`, `_API_KEY`, and `_MODEL` in your root `.env` (see [Setup](#setup)).
 
 ## Why an API, not the agent's native model
 
-The filtering and the summaries go through a plain OpenAI-compatible API call from the engine,
+The filtering and the briefings go through a plain OpenAI-compatible API call from the engine,
 not through the coding agent's own model. Two reasons.
 
 Speed. The engine works ahead in the background. It expands channels in parallel and starts
-summarizing the next video while you rate the current one, so the following step is usually
+on the next video's briefing while you rate the current one, so the following step is usually
 ready with no wait. An agent's turn-by-turn loop cannot prefetch like that, and every step pays
 its own cold start, which adds up across a whole queue.
 

package/dist/bootstrap.js

@@ -6,18 +6,18 @@
  *
  * Asks for, and writes:
  *   1. Output language for summaries + ratings   → DATA_DIR/config.json
- *   2. LLM provider / model / key, YouTube key, optional proxy → .env
- *   3. The channels you follow — just a flat list of handles
+ *   2. The channels you follow — just a flat list of handles
  *      → DATA_DIR/channels.md, DATA_DIR/state.md, DATA_DIR/channels/<slug>.md
+ *   3. Which agent runs /yt — installs the skill into its skills dir
  *
- * Re-running is safe: it warns before overwriting existing data and lets you bail.
+ * It does NOT touch keys: those live in your project root .env (see README → Setup); the engine
+ * reads them at run time. Re-running is safe: it warns before overwriting existing data and bails.
  * Everything it writes is plain Markdown / JSON you can also edit by hand afterwards.
  */
-import { existsSync, readFileSync, mkdirSync, writeFileSync } from 'node:fs';
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
-import { DATA_DIR, BASE_DIR, PKG_ROOT, CHANNELS_DIR, CHANNELS_MD, STATE_MD, CONFIG_JSON, ROOT_ENV_PATH, profilePath, } from "./lib/paths.js";
+import { DATA_DIR, BASE_DIR, PKG_ROOT, CHANNELS_DIR, CHANNELS_MD, STATE_MD, CONFIG_JSON, profilePath, } from "./lib/paths.js";
 import { AGENTS, installSkills, projectSkillsRoot, customSkillsRootDefault, isPackageDevCwd } from "./lib/skill-install.js";
-import { loadEnv } from "./lib/env.js";
 import { question } from "./lib/prompt.js";
 import { normalizeHandle, slugify, serializeChannels, serializeState, profileBody, baselineStateRow } from "./lib/channels.js";
 const ask = (q, def = '') => {
@@ -30,34 +30,8 @@ const askYN = (q, def = true) => {
         return def;
     return a.startsWith('y');
 };
-// Secrets: if already provided by the environment (root .env or an exported var), offer to keep it
-// without echoing the value back to the terminal. Returns the kept/typed value.
-const askSecret = (q, preset) => {
-    if (preset)
-        return question(`${q} [Enter = keep the value from your environment]:`).trim() || preset;
-    return ask(q);
-};
-// Merge vars into the project root .env without clobbering: only append keys not already present
-// (so a value the user keeps from their existing root .env stays the single source). Skips empties.
-function mergeRootEnv(vars) {
-    const existing = existsSync(ROOT_ENV_PATH) ? readFileSync(ROOT_ENV_PATH, 'utf8') : '';
-    const present = new Set(existing.split('\n').map(l => l.trim()).filter(l => l && !l.startsWith('#'))
-        .map(l => l.slice(0, l.indexOf('=')).trim()).filter(Boolean));
-    const additions = vars.filter(([k, v]) => v !== '' && !present.has(k)).map(([k, v]) => `${k}=${v}`);
-    if (additions.length) {
-        const sep = existing && !existing.endsWith('\n') ? '\n' : '';
-        writeFileSync(ROOT_ENV_PATH, existing + sep + additions.join('\n') + '\n', 'utf8');
-    }
-    return additions.map(l => l.slice(0, l.indexOf('=')));
-}
 function main() {
     console.log('\n  yt-briefing — onboarding\n  ' + '─'.repeat(40) + '\n');
-    // See what the environment already provides (root .env / exported vars) so we can offer to keep
-    // those secrets instead of re-asking, and avoid baking a second copy into .yt-briefing/.env.
-    loadEnv();
-    const presetLlmKey = process.env.YT_BRIEFING_LLM_API_KEY ?? '';
-    const presetYtKey = process.env.YT_BRIEFING_YOUTUBE_API_KEY ?? '';
-    const presetProxy = process.env.YT_BRIEFING_PROXY ?? '';
     if (existsSync(CHANNELS_MD)) {
         console.log(`  Existing data found at ${DATA_DIR}`);
         if (!askYN('  Overwrite it?', false)) {
@@ -66,47 +40,15 @@ function main() {
         }
         console.log('');
     }
+    // Keys are NOT asked here — they live in your project root .env (LLM + YouTube; see README
+    // → Setup). The engine reads them at run time and fails fast naming any that are missing.
     // 1. Language ----------------------------------------------------------------
     console.log('  1) Language');
     const outputLang = ask('  Output language for summaries and ratings', 'English');
-    // 2. LLM provider (.env) -----------------------------------------------------
-    // Pick a provider → we prefill its endpoint + a sensible model and ask ONLY for the
-    // key (with the exact link to get it). The recommended free path is the default, so
-    // pressing Enter lands on it — no long URL to paste, nothing to guess.
-    console.log('\n  2) Which AI writes the filtering + summaries? Pick a provider:\n');
-    console.log('     1) Gemini      — FREE key, best way to start   ·  https://aistudio.google.com/apikey');
-    console.log('     2) OpenRouter  — one key for Gemini + GPT + …   ·  https://openrouter.ai/keys');
-    console.log('     3) OpenAI      — GPT models                     ·  https://platform.openai.com/api-keys');
-    console.log('     4) Other / local (Ollama or any custom endpoint)\n');
-    console.log('     Type 1, 2, 3 or 4 and press Enter.  (Just press Enter for 1 — Gemini, recommended.)');
-    const PROVIDERS = {
-        '1': { name: 'Gemini', base: 'https://generativelanguage.googleapis.com/v1beta/openai', model: 'gemini-2.5-flash', keyUrl: 'https://aistudio.google.com/apikey' },
-        '2': { name: 'OpenRouter', base: 'https://openrouter.ai/api/v1', model: 'google/gemini-2.5-flash', keyUrl: 'https://openrouter.ai/keys' },
-        '3': { name: 'OpenAI', base: 'https://api.openai.com/v1', model: 'gpt-4o-mini', keyUrl: 'https://platform.openai.com/api-keys' },
-    };
-    let llmBaseUrl, llmModel, llmKey;
-    const picked = PROVIDERS[ask('  Your choice', '1')];
-    if (picked) {
-        console.log(`\n     → ${picked.name}. Get your key here: ${picked.keyUrl}`);
-        llmKey = askSecret('  Paste your API key', presetLlmKey);
-        llmBaseUrl = picked.base;
-        llmModel = ask('  Model (Enter to accept)', picked.model);
-    }
-    else {
-        console.log('\n     → Custom / local endpoint (e.g. Ollama at http://localhost:11434/v1)');
-        llmBaseUrl = ask('  YT_BRIEFING_LLM_BASE_URL', 'http://localhost:11434/v1');
-        llmModel = ask('  YT_BRIEFING_LLM_MODEL', 'llama3.1');
-        llmKey = askSecret('  YT_BRIEFING_LLM_API_KEY (blank for local)', presetLlmKey);
-    }
-    console.log('\n  3) YouTube Data API (needed to list channel uploads)');
-    console.log('     Get a key: https://console.cloud.google.com → YouTube Data API v3');
-    const ytKey = askSecret('  YT_BRIEFING_YOUTUBE_API_KEY', presetYtKey);
-    console.log('\n  4) Proxy (optional — only needed on datacenter/VPS IPs; see docs/warp-proxy.md)');
-    const ytProxy = askSecret('  YT_BRIEFING_PROXY (blank = direct)', presetProxy);
-    // 5. Channels ----------------------------------------------------------------
+    // 2. Channels ----------------------------------------------------------------
     // Just collect a flat list. No categories, no per-channel rules to define up front —
     // each channel's profile LEARNS what to skip as you rate it (## Skip titles / ## Notes).
-    console.log('\n  5) Channels you follow');
+    console.log('\n  2) Channels you follow');
     console.log('     Add one per line — paste whichever form you have, all work as-is:');
     console.log('     eg. @betterstack, betterstack or https://www.youtube.com/@betterstack');
     console.log('     (Paste the full URL directly — it reads the @handle for you) Empty line to finish.');
@@ -132,31 +74,20 @@ function main() {
     if (channels.length === 0) {
         console.log('\n  No channels added — you can add them later by editing data/channels.md.\n');
     }
-    // 6. Coding agent ------------------------------------------------------------
+    // 3. Coding agent ------------------------------------------------------------
     // Place the skill INTO THIS PROJECT (the package folder you open in the agent) — never a
     // home-global dir (that's the npm -g antipattern: machine-wide, invisible, easy to forget).
     // SKILL.md is the cross-agent standard, so the shipped skill runs in any compatible agent —
     // we just install it into that agent's skills dir (.claude/skills, .cursor/skills, .codex/skills).
     // 1/2/3 = known agents; 4 = any other compatible agent (a project folder you name).
-    console.log('\n  6) Which agent will you run /yt in?  (it ships a standard Agent Skill — any compatible agent works)');
+    console.log('\n  3) Which agent will you run /yt in?  (it ships a standard Agent Skill — any compatible agent works)');
     console.log('       1) Claude Code   2) Cursor   3) Codex   4) Custom folder (any other agent)\n');
     const agentKey = ask('  Your agent', '1');
     // For a custom target, ask the folder now (keeps all prompts in the interactive block).
     const customDir = AGENTS[agentKey] ? '' : ask('  Skills folder to install into', customSkillsRootDefault());
-    // 7. Write everything --------------------------------------------------------
+    // 4. Write everything --------------------------------------------------------
     mkdirSync(CHANNELS_DIR, { recursive: true });
-    // Secrets live in the project ROOT .env (the only file the engine reads). Merge into it without
-    // clobbering — keys already there (e.g. kept from the environment) stay the single source. The
-    // engine has no fallback file, so a key not set here (or exported) is a hard error at run time.
-    const envAdded = mergeRootEnv([
-        ['YT_BRIEFING_LLM_BASE_URL', llmBaseUrl],
-        ['YT_BRIEFING_LLM_API_KEY', llmKey],
-        ['YT_BRIEFING_LLM_MODEL', llmModel],
-        ['YT_BRIEFING_YOUTUBE_API_KEY', ytKey],
-        ['YT_BRIEFING_PROXY', ytProxy],
-    ]);
     // Keep the throwaway cache out of git for the consume layout. data/ stays versionable (for sync).
-    // No secrets live under .yt-briefing/ anymore, so nothing else needs ignoring here.
     if (BASE_DIR !== PKG_ROOT) {
         writeFileSync(join(BASE_DIR, '.gitignore'), 'data/.cache/\n', 'utf8');
     }
@@ -170,7 +101,6 @@ function main() {
         writeFileSync(profilePath(c.slug), profileBody(c.handle, c.slug), 'utf8');
     console.log('  ' + '─'.repeat(40));
     console.log(`  Done. Wrote:`);
-    console.log(`    ${ROOT_ENV_PATH}  ${envAdded.length ? `(+${envAdded.join(', ')})` : '(no new keys — already set)'}`);
     console.log(`    ${CONFIG_JSON}`);
     console.log(`    ${CHANNELS_MD}`);
     console.log(`    ${STATE_MD}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yt-briefing",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "A self-learning YouTube briefing engine: it sweeps the channels you follow, filters noise in two stages (title, then transcript), summarizes the rest in your language, and adapts to your ratings — one video at a time.",
   "type": "module",
   "bin": {