create-evda 0.1.0 → 0.1.2

package/lib/setup.mjs

@@ -0,0 +1,204 @@
+// Setup: the questions a new owner answers once, the platforms their EVDA works with, and where
+// model training is turned off on each. Used by create-evda interactively (one question at a
+// time on a terminal) and unattended (flags, or --yes). The answers land in the owner section of
+// AGENTS.md, "What this EVÐA is", in the owner's words.
+//
+// The training instructions were checked against each provider's own help page on 2026-09-16.
+// A provider renames a toggle every so often, so each entry carries the link to its page and
+// says the setting's name as that page gives it.
+
+export const DEFAULT_AGENT_NAME = "Iris";
+
+export const PLATFORMS = {
+  claude: {
+    label: "Claude (the Claude apps, or Claude Code)",
+    training: [
+      "In Claude, open Settings, then Privacy, and turn off \"Help improve our AI models\".",
+      "The same setting covers Claude Code when you sign in with a Free, Pro or Max plan. Work and API accounts are not trained on by default.",
+    ],
+    url: "https://privacy.claude.com/en/articles/12109829-how-do-i-change-my-model-improvement-privacy-settings",
+    open: ["Claude Code: run `claude` in this folder. It reads CLAUDE.md, which loads AGENTS.md."],
+  },
+  chatgpt: {
+    label: "ChatGPT or Codex",
+    training: [
+      "In ChatGPT, open Settings, then Data Controls, and turn off \"Improve the model for everyone\".",
+      "On a personal plan the same setting covers Codex. Business and API accounts are not trained on by default.",
+    ],
+    url: "https://help.openai.com/en/articles/7730893-data-controls-faq",
+    open: ["Codex: run `codex` in this folder. It reads AGENTS.md on its own."],
+  },
+  gemini: {
+    label: "Gemini (the Gemini app, or Gemini CLI)",
+    training: [
+      "In the Gemini app, open Settings & help, then Activity, and turn Keep Activity off.",
+      "In Gemini CLI signed in with a personal Google account, run /privacy and decline data use, or use a paid Gemini API key, which Google does not train on.",
+    ],
+    url: "https://support.google.com/gemini/answer/13278892",
+    open: ["Gemini CLI: run `gemini` in this folder. It reads GEMINI.md, which loads AGENTS.md."],
+  },
+  cursor: {
+    label: "Cursor",
+    training: [
+      "In Cursor, open Cursor Settings (Cmd+Shift+J on a Mac, Ctrl+Shift+J elsewhere), then General, and turn Privacy Mode on.",
+    ],
+    url: "https://cursor.com/help/security-and-privacy/privacy",
+    open: ["Cursor: open this folder. It reads AGENTS.md on its own."],
+  },
+  other: {
+    label: "Something else",
+    training: [
+      "Open your AI's privacy or data settings and turn off anything that lets it use your conversations to train or improve its models.",
+      "If you cannot find one, check its terms say your data is not used for training before you write anything personal.",
+    ],
+    url: null,
+    open: ["Any agent that reads AGENTS.md (Codex, Cursor, GitHub Copilot, Windsurf, Zed, opencode and others) works in this folder as it is. Aider: `aider --read AGENTS.md`."],
+  },
+};
+
+export const PLATFORM_KEYS = Object.keys(PLATFORMS);
+
+const SHORT_NAMES = { claude: "Claude", chatgpt: "ChatGPT", gemini: "Gemini", cursor: "Cursor", other: "" };
+
+// The "Turning training off" section of the scaffolded README, generated from PLATFORMS so the
+// owner's copy and the setup flow say the same thing.
+export function trainingSection() {
+  return PLATFORM_KEYS.map((k) => {
+    const p = PLATFORMS[k];
+    return `- **${p.label}.** ${p.training.join(" ")}${p.url ? ` <${p.url}>` : ""}`;
+  }).join("\n");
+}
+
+// A chat app with project instructions cannot read or write the folder. It can still be used.
+export const CHAT_APPS = [
+  "ChatGPT or Claude in the browser or app: make a Project, paste AGENTS.md into its instructions, and add your record files to it. Anything you write there stays in that app until you copy it into record/.",
+];
+
+// The loaders: one line that imports AGENTS.md, for the tools that do not read it on their own.
+// Codex, Cursor, Copilot, Windsurf, Zed and the others on agents.md read AGENTS.md directly and
+// need nothing.
+export const LOADERS = {
+  "CLAUDE.md": "Claude Code",
+  "GEMINI.md": "Gemini CLI",
+};
+
+export const DICTATION = "Talking is often easier than typing. Apple's built-in dictation works well, or Wispr Flow with data collection turned off.";
+
+// Accepts a key, a number from the menu, or a word from the label ("codex" -> chatgpt).
+export function platformKey(answer) {
+  const a = String(answer ?? "").trim().toLowerCase();
+  if (!a) return null;
+  if (/^\d+$/.test(a)) return PLATFORM_KEYS[Number(a) - 1] ?? null;
+  if (PLATFORMS[a]) return a;
+  if (/codex|openai|gpt/.test(a)) return "chatgpt";
+  if (/claude|anthropic/.test(a)) return "claude";
+  if (/gemini|google/.test(a)) return "gemini";
+  if (/cursor/.test(a)) return "cursor";
+  return "other";
+}
+
+// The owner's answers as the owner section's lines. A field left empty stays empty, so Iris asks
+// for it in the first session.
+export const FIELDS = [
+  ["agentName", "Agent name"],
+  ["owner", "Who I am"],
+  ["purpose", "What I want this for"],
+  ["voice", "How I want it to talk to me"],
+  ["ai", "The AI I use with it, and its training setting"],
+];
+
+function oneLine(s) {
+  return String(s ?? "").replace(/\s*\n\s*/g, " ").trim();
+}
+
+// The value written on the AI line. Empty unless training off was confirmed, because an AI with
+// training in an unknown state is the thing setup exists to prevent, and an empty line is what
+// makes Iris ask.
+export function aiLine({ platform, platformName, trainingOff, date }) {
+  if (!trainingOff) return "";
+  const name = oneLine(platformName) || (platform ? SHORT_NAMES[platform] : "") || "";
+  return `${name ? `${name}. ` : ""}Training off, confirmed ${date}.`;
+}
+
+// Fill the owner section of an AGENTS.md text. Each field's line is `- **Label:** value`; a line
+// present in the template is filled in place, a missing one is added at the end of the section's
+// list. Only the section "## What this EVÐA is" is touched.
+export function fillOwnerSection(text, answers) {
+  const lines = text.split("\n");
+  const start = lines.findIndex((l) => /^## What this EVÐA is\s*$/.test(l));
+  if (start === -1) return text;
+  let end = lines.findIndex((l, i) => i > start && (/^## /.test(l) || l.startsWith("<!-- evda:generated")));
+  if (end === -1) end = lines.length;
+  let lastField = -1;
+  for (const [key, label] of FIELDS) {
+    const value = oneLine(answers[key]);
+    const re = new RegExp(`^- \\*\\*${label.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}:\\*\\*`);
+    const i = lines.findIndex((l, j) => j > start && j < end && re.test(l));
+    const line = `- **${label}:**${value ? ` ${value}` : ""}`;
+    if (i !== -1) {
+      if (value || key !== "agentName") lines[i] = line;
+      lastField = Math.max(lastField, i);
+    } else if (value) {
+      const at = lastField !== -1 ? lastField + 1 : end;
+      lines.splice(at, 0, line);
+      lastField = at;
+      end += 1;
+    }
+  }
+  return lines.join("\n");
+}
+
+export const WELCOME = [
+  "EVÐA is a really organized journal that helps you live your life the more you use it.",
+  "",
+  "Freewrite with Iris about anything: what stresses you out, what you are unsure of, the things you do every day that feel slightly off. You will get better at seeing your thoughts, understanding why you do what you do, why certain people matter to you and why you react the way you do. Iris cannot give you the right answer for your life, but it is good at suggestions: take them, push back on what you disagree with, get specific, and get a new response back. Iris keeps it all in your EVÐA as you talk.",
+  "",
+  "It is not easy to put your deepest thoughts into a system, especially ones you have not admitted to yourself, never mind a friend or a therapist. EVÐA is built for exactly that, and it is open source so you can check. Your data is always yours, and never accessible to anyone at EVÐA: the company never receives your record. The AI you use does receive what Iris reads, which is why setup asks you to turn training off first.",
+  "",
+  "The only requirement is that you want to, and you are open to it. Iris is the default name; call it whatever you like.",
+].join("\n");
+
+// Ask the setup questions one at a time. `io.ask(prompt)` returns the answer (a promise or a
+// string); `io.out(line)` prints. Only questions whose flag is missing are asked. Returns the
+// answers, including `trainingOff` which is true only after the owner typed yes.
+export async function interview(opts, io) {
+  const out = io.out;
+  const ask = async (q) => oneLine(await io.ask(q));
+  out(WELCOME);
+  out("");
+  const a = { ...opts };
+  if (a.agentName == null) a.agentName = (await ask(`What would you like to call your agent? (${DEFAULT_AGENT_NAME}) `)) || DEFAULT_AGENT_NAME;
+  const agent = a.agentName || DEFAULT_AGENT_NAME;
+  if (!a.owner) a.owner = await ask("What is your name? ");
+  if (!a.purpose) a.purpose = await ask(`What do you want ${agent} for? Say it however it comes out. `);
+  if (!a.voice) a.voice = await ask(`How do you want ${agent} to talk to you? `);
+  if (!a.platform) {
+    out("Which AI will you use it with?");
+    PLATFORM_KEYS.forEach((k, i) => out(`  ${i + 1}. ${PLATFORMS[k].label}`));
+    let key = null;
+    let raw = "";
+    while (!key) {
+      raw = await ask("Number or name: ");
+      key = platformKey(raw);
+    }
+    a.platform = key;
+    if (key === "other" && !/^\d+$/.test(raw) && raw.toLowerCase() !== "other") a.platformName = raw;
+  }
+  const p = PLATFORMS[a.platform];
+  if (!a.trainingOff) {
+    out("");
+    out("Before anything personal goes in, turn model training off:");
+    for (const line of p.training) out(`  ${line}`);
+    if (p.url) out(`  ${p.url}`);
+    let yes = false;
+    while (!yes) {
+      const r = (await ask("Type yes once training is off: ")).toLowerCase();
+      yes = r === "yes" || r === "y";
+      if (!yes) out("Setup finishes once training is off. Take your time; nothing has been written yet.");
+    }
+    a.trainingOff = true;
+  }
+  out("");
+  out(DICTATION);
+  return a;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-evda",
-  "version": "0.1.0",
-  "description": "Make your own EVÐA: a directory that knows what it is. Plain files are the truth, the tooling is optional, and there are no runtime dependencies.",
+  "version": "0.1.2",
+  "description": "Make your own EVÐA: a running journal of your life with Iris, as plain files on your machine, for any AI. No runtime dependencies.",
   "type": "module",
   "bin": {
     "create-evda": "create-evda.mjs",