trismegistus 1.0.1 → 1.0.2

package/README.md

@@ -39,7 +39,7 @@ The daemon picks up tasks one at a time, runs each in a full Claude Code session
 
 | Command | Description |
 |---------|-------------|
-| `tmg init` | Create `.trismegistus/` folder with config, tasks, and notes files |
+| `tmg init` | Create `.trismegistus/` folder with config, tasks, notes, and README; adds transient files to `.gitignore` |
 | `tmg add "task"` | Add a task to the queue |
 | `tmg start` | Start the daemon — runs tasks continuously until the queue is empty |
 | `tmg status` | Show counts of pending, in-progress, done, retrying, and gave-up tasks |
@@ -178,12 +178,15 @@ TASK_DELAY_SECONDS=5    # Pause between tasks
 
 ```
 .trismegistus/
-  config          # Daemon configuration
-  tasks.md        # Your task queue
-  notes.md        # Notes for Claude (cleared after each read)
-  handoff         # Context passed between retry attempts (auto-managed)
+  config          # Daemon configuration (committed)
+  README.md       # Explains the folder to collaborators (committed)
+  tasks.md        # Your task queue (gitignored)
+  notes.md        # Notes for Claude, cleared after each read (gitignored)
+  handoff         # Context passed between retry attempts (gitignored, auto-managed)
 ```
 
+`tmg init` automatically adds the transient files (`tasks.md`, `notes.md`, `handoff`) to your project's `.gitignore`. The `config` and `README.md` are committed so team members share daemon settings and understand the folder.
+
 ## License
 
 MIT

package/dist/cli.js

@@ -7,7 +7,7 @@ import { hostname } from "os";
 import qrcode from "qrcode-terminal";
 
 // src/init.ts
-import { existsSync, mkdirSync, writeFileSync } from "fs";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "fs";
 import { join } from "path";
 
 // src/types.ts
@@ -37,6 +37,44 @@ IDLE_POLL_SECONDS=10
 TASK_DELAY_SECONDS=5
 `;
 var STATUS_PRIORITY = [" ", "!", "!!"];
+var README_FILE = "README.md";
+var README_TEMPLATE = `# .trismegistus
+
+This project uses [Trismegistus](https://www.npmjs.com/package/trismegistus) \u2014 a local daemon that runs Claude Code sessions from a task queue.
+
+## Getting started
+
+\`\`\`bash
+npm install -D trismegistus
+npx tmg init      # already done if you see this file
+npx tmg add "your task here"
+npx tmg start     # runs tasks autonomously
+\`\`\`
+
+## Files in this directory
+
+| File | Tracked | Purpose |
+|------|---------|---------|
+| \`config\` | Yes | Daemon settings (retries, timeouts) \u2014 shared with team |
+| \`README.md\` | Yes | This file |
+| \`tasks.md\` | No | Personal task queue (gitignored) |
+| \`notes.md\` | No | Notes for Claude, cleared after each read (gitignored) |
+| \`handoff\` | No | Retry context between failed attempts (gitignored) |
+
+## Commands
+
+- \`tmg add "task"\` \u2014 Add a task to the queue
+- \`tmg start\` \u2014 Start the daemon
+- \`tmg status\` \u2014 Show task counts
+- \`tmg notes "text"\` \u2014 Leave notes for Claude's next run
+- \`tmg reset\` \u2014 Reset gave-up tasks back to pending
+- \`tmg remote\` \u2014 Start a VS Code tunnel for mobile access
+`;
+var GITIGNORE_ENTRIES = [
+  ".trismegistus/tasks.md",
+  ".trismegistus/notes.md",
+  ".trismegistus/handoff"
+];
 var CLAUDE_COMMANDS = [
   {
     name: "tmg.md",
@@ -105,7 +143,8 @@ function initProject(projectDir) {
   const files = [
     { name: CONFIG_FILE, content: CONFIG_TEMPLATE },
     { name: TASKS_FILE, content: TASKS_TEMPLATE },
-    { name: NOTES_FILE, content: NOTES_TEMPLATE }
+    { name: NOTES_FILE, content: NOTES_TEMPLATE },
+    { name: README_FILE, content: README_TEMPLATE }
   ];
   for (const file of files) {
     const path = join(tmgDir, file.name);
@@ -125,11 +164,23 @@ function initProject(projectDir) {
       result.created.push(`.claude/commands/${cmd.name}`);
     }
   }
+  const gitignorePath = join(projectDir, ".gitignore");
+  let gitignoreContent = existsSync(gitignorePath) ? readFileSync(gitignorePath, "utf-8") : "";
+  const missing = GITIGNORE_ENTRIES.filter(
+    (entry) => !gitignoreContent.includes(entry)
+  );
+  if (missing.length > 0) {
+    const block = missing.join("\n") + "\n";
+    const needsNewline = gitignoreContent.length > 0 && !gitignoreContent.endsWith("\n");
+    gitignoreContent += (needsNewline ? "\n" : "") + block;
+    writeFileSync(gitignorePath, gitignoreContent);
+    result.created.push(".gitignore entries");
+  }
   return result;
 }
 
 // src/tasks.ts
-import { readFileSync, writeFileSync as writeFileSync2, existsSync as existsSync2, unlinkSync } from "fs";
+import { readFileSync as readFileSync2, writeFileSync as writeFileSync2, existsSync as existsSync2, unlinkSync } from "fs";
 import { join as join2 } from "path";
 var TASK_REGEX = /^- \[([^\]]*)\] (.+)$/;
 function tasksPath(projectDir) {
@@ -156,7 +207,7 @@ function parseTasks(content) {
 function readTasks(projectDir) {
   const path = tasksPath(projectDir);
   if (!existsSync2(path)) return [];
-  return parseTasks(readFileSync(path, "utf-8"));
+  return parseTasks(readFileSync2(path, "utf-8"));
 }
 function getNextTask(projectDir) {
   const tasks = readTasks(projectDir);
@@ -168,7 +219,7 @@ function getNextTask(projectDir) {
 }
 function setTaskStatus(projectDir, taskText, newStatus) {
   const path = tasksPath(projectDir);
-  const content = readFileSync(path, "utf-8");
+  const content = readFileSync2(path, "utf-8");
   const lines = content.split("\n");
   let found = false;
   for (let i = 0; i < lines.length; i++) {
@@ -198,7 +249,7 @@ function getTaskCounts(projectDir) {
 function resetGaveUpTasks(projectDir) {
   const path = tasksPath(projectDir);
   if (!existsSync2(path)) return 0;
-  const content = readFileSync(path, "utf-8");
+  const content = readFileSync2(path, "utf-8");
   const lines = content.split("\n");
   let count = 0;
   for (let i = 0; i < lines.length; i++) {
@@ -214,7 +265,7 @@ function resetGaveUpTasks(projectDir) {
 function readAndClearNotes(projectDir) {
   const path = notesPath(projectDir);
   if (!existsSync2(path)) return "";
-  const content = readFileSync(path, "utf-8");
+  const content = readFileSync2(path, "utf-8");
   const notes = content.split("\n").filter((l) => !l.startsWith("#") && l.trim() !== "").slice(0, 50).join("\n");
   writeFileSync2(
     path,
@@ -225,7 +276,7 @@ function readAndClearNotes(projectDir) {
 function readHandoff(projectDir) {
   const path = handoffPath(projectDir);
   if (!existsSync2(path)) return "";
-  return readFileSync(path, "utf-8");
+  return readFileSync2(path, "utf-8");
 }
 function writeHandoff(projectDir, content) {
   writeFileSync2(handoffPath(projectDir), content);
@@ -255,7 +306,7 @@ function appendNotes(projectDir, text) {
   if (!existsSync2(path)) {
     throw new Error("No notes file found. Run `tmg init` first.");
   }
-  const content = readFileSync(path, "utf-8");
+  const content = readFileSync2(path, "utf-8");
   const separator = content.length > 0 && !content.endsWith("\n") ? "\n" : "";
   writeFileSync2(path, content + separator + trimmed + "\n");
 }
@@ -270,7 +321,7 @@ function addTask(projectDir, text) {
       "No tasks file found. Run `tmg init` first."
     );
   }
-  const content = readFileSync(path, "utf-8");
+  const content = readFileSync2(path, "utf-8");
   const line = `- [ ] ${trimmed}
 `;
   const separator = content.length > 0 && !content.endsWith("\n") ? "\n" : "";
@@ -288,7 +339,7 @@ import { join as join4 } from "path";
 import { execFileSync } from "child_process";
 
 // src/config.ts
-import { readFileSync as readFileSync2, existsSync as existsSync3 } from "fs";
+import { readFileSync as readFileSync3, existsSync as existsSync3 } from "fs";
 import { join as join3 } from "path";
 var KEY_MAP = {
   MAX_RETRIES: "maxRetries",
@@ -319,7 +370,7 @@ function loadConfig(projectDir) {
   if (!existsSync3(configPath)) {
     return { ...DEFAULT_CONFIG };
   }
-  const content = readFileSync2(configPath, "utf-8");
+  const content = readFileSync3(configPath, "utf-8");
   const overrides = parseConfigFile(content);
   return { ...DEFAULT_CONFIG, ...overrides };
 }

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "trismegistus",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A local persistent daemon that runs AI sessions from a task queue, with mobile support.",
   "type": "module",
-  "main": "./dist/cli.js",
   "bin": {
     "tmg": "./dist/cli.js"
   },
@@ -12,7 +11,7 @@
     "dev": "tsx src/cli.ts",
     "test": "vitest run",
     "test:watch": "vitest",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build && npm test"
   },
   "keywords": [
     "claude",