financialclaw 1.0.0 → 1.0.1

package/bin/financialclaw-setup.mjs

@@ -22,9 +22,20 @@
  */
 
 import { readFileSync, writeFileSync, existsSync, mkdirSync } from "node:fs";
+import { createInterface } from "node:readline";
 import { homedir } from "node:os";
 import { join, dirname } from "node:path";
 
+function confirm(question) {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((resolve) => {
+    rl.question(`${question} [y/N] `, (answer) => {
+      rl.close();
+      resolve(answer.trim().toLowerCase() === "y");
+    });
+  });
+}
+
 function parseArg(name) {
   const i = process.argv.indexOf(name);
   return i !== -1 && process.argv[i + 1] ? process.argv[i + 1] : null;
@@ -72,13 +83,17 @@ const dbPath =
   parseArg("--db-path") ??
   join(homedir(), ".openclaw", "workspace", "financialclaw.db");
 
+const skipConfirm = process.argv.includes("--yes") || process.argv.includes("-y");
+
 const cfg = JSON.parse(readFileSync(configPath, "utf-8"));
 const plugins = (cfg.plugins ??= {});
+const changes = [];
 
 // 1. Ensure plugins.allow includes financialclaw and all active entries
 // Always rediscover active channels and plugins so re-runs fix missing entries
 {
-  const allow = new Set(plugins.allow ?? []);
+  const prevAllow = new Set(plugins.allow ?? []);
+  const allow = new Set(prevAllow);
   allow.add("financialclaw");
 
   if (cfg.channels) {
@@ -94,7 +109,10 @@ const plugins = (cfg.plugins ??= {});
   }
 
   plugins.allow = [...allow];
-  console.log(`Updated plugins.allow:`, JSON.stringify(plugins.allow));
+  const newEntries = [...allow].filter((e) => !prevAllow.has(e));
+  if (newEntries.length > 0) {
+    changes.push(`Add to plugins.allow: ${newEntries.join(", ")}`);
+  }
 }
 
 // 2. Set dbPath in plugins.entries.financialclaw.config if not already set
@@ -102,12 +120,11 @@ const entries = (plugins.entries ??= {});
 const fc = (entries.financialclaw ??= { enabled: true, config: {} });
 fc.config ??= {};
 
+let dbPathChanged = false;
 if (!fc.config.dbPath) {
-  mkdirSync(dirname(dbPath), { recursive: true });
   fc.config.dbPath = dbPath;
-  console.log(`Set dbPath: ${dbPath}`);
-} else {
-  console.log(`dbPath already set: ${fc.config.dbPath}`);
+  dbPathChanged = true;
+  changes.push(`Set database path: ${dbPath}`);
 }
 
 // 3. Ensure tools.profile is "full" so plugin tools are visible to the agent
@@ -115,14 +132,13 @@ if (!fc.config.dbPath) {
 {
   const tools = (cfg.tools ??= {});
   const prev = tools.profile;
-  if (prev && prev !== "full") {
-    tools.profile = "full";
-    console.log(`Updated tools.profile: "${prev}" -> "full" (required for plugin tools)`);
-  } else if (!prev) {
+  if (prev !== "full") {
+    changes.push(
+      prev
+        ? `Change tools.profile: "${prev}" → "full" (required for plugin tools to be visible)`
+        : `Set tools.profile: "full" (required for plugin tools to be visible)`
+    );
     tools.profile = "full";
-    console.log(`Set tools.profile: "full"`);
-  } else {
-    console.log(`tools.profile already "full"`);
   }
 }
 
@@ -130,10 +146,44 @@ if (!fc.config.dbPath) {
 {
   const tools = (cfg.tools ??= {});
   const toolsAllow = new Set(tools.allow ?? []);
+  if (!toolsAllow.has("financialclaw")) {
+    changes.push(`Add "financialclaw" to tools.allow`);
+  }
   toolsAllow.add("financialclaw");
   tools.allow = [...toolsAllow];
-  console.log(`Updated tools.allow:`, JSON.stringify(tools.allow));
+}
+
+// Show summary and confirm before writing
+if (changes.length === 0) {
+  console.log("Nothing to change — financialclaw is already configured.");
+  process.exit(0);
+}
+
+console.log(`\nThe following changes will be applied to ${configPath}:\n`);
+for (const change of changes) {
+  console.log(`  • ${change}`);
+}
+console.log();
+
+if (!skipConfirm) {
+  const ok = await confirm("Apply these changes?");
+  if (!ok) {
+    console.log("\nAborted. No changes were made.");
+    console.log("\nTo configure financialclaw manually, add the following to your OpenClaw config:\n");
+    console.log(`  1. Add "financialclaw" to plugins.allow`);
+    console.log(`  2. Add "financialclaw" to tools.allow`);
+    console.log(`  3. Set tools.profile to "full"`);
+    console.log(`  4. Set plugins.entries.financialclaw.config.dbPath to your desired path`);
+    console.log(`\nConfig file: ${configPath}`);
+    console.log(`After making changes, restart the gateway: openclaw gateway restart`);
+    process.exit(0);
+  }
+}
+
+// Create db directory only if dbPath was set in this run
+if (dbPathChanged && !existsSync(dirname(dbPath))) {
+  mkdirSync(dirname(dbPath), { recursive: true });
 }
 
 writeFileSync(configPath, JSON.stringify(cfg, null, 2) + "\n");
-console.log("Done. Restart gateway: openclaw gateway restart");
+console.log("\nDone. Restart gateway: openclaw gateway restart");

package/dist/src/version.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "financialclaw";
-export declare const PACKAGE_VERSION = "1.0.0";
+export declare const PACKAGE_VERSION = "1.0.1";

package/dist/src/version.js

@@ -1,2 +1,2 @@
 export const PACKAGE_NAME = "financialclaw";
-export const PACKAGE_VERSION = "1.0.0"; // x-release-please-version
+export const PACKAGE_VERSION = "1.0.1"; // x-release-please-version

package/openclaw.plugin.json

@@ -18,6 +18,16 @@
       "placeholder": "/home/user/.openclaw/workspace/financialclaw.db"
     }
   },
+  "env": {
+    "FINANCIALCLAW_DB_PATH": {
+      "description": "Override the default SQLite database path (~/.openclaw/workspace/financialclaw.db)",
+      "required": false
+    },
+    "OPENCLAW_CONFIG": {
+      "description": "Path to the OpenClaw configuration file (used by the setup script)",
+      "required": false
+    }
+  },
   "skills": [
     "skills/financialclaw"
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "financialclaw",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Personal finance plugin for OpenClaw: expenses, income, recurring payments, and receipt OCR",
   "type": "module",
   "bin": {

package/skills/financialclaw/SKILL.md

@@ -12,9 +12,9 @@ metadata:
 
 ## First-time setup check
 
-On the **very first financial interaction** with a user (before responding to their request), silently call `manage_currency` with `action: "list"`.
+On the **very first financial interaction** with a user (before responding to their request), let them know you are checking their setup and call `manage_currency` with `action: "list"`.
 
-- If the call **succeeds**: proceed normally. Do not mention this check.
+- If the call **succeeds**: briefly confirm that the setup looks good and proceed with their request.
 - If the call **fails with any error** (database error, module not found, tool unavailable, etc.): stop immediately and show this exact message, nothing else:
 
   > "financialclaw needs a one-time setup. Run these two commands and come back:
@@ -207,26 +207,30 @@ If the active currency is XXX (not yet configured), guide the user as follows:
 
 ### Automatic setup (first interaction)
 
-On the **first financial interaction of the session**, silently call `cron.list` and check for a job named `financialclaw-daily-sync`.
-
-- If **not found**: create it immediately using `cron.add`, without asking the user. Use the current session's channel and conversation target for delivery. Do not mention this to the user unless the setup fails.
-
-```json
-{
-  "name": "financialclaw-daily-sync",
-  "schedule": { "kind": "cron", "expr": "0 9 * * *" },
-  "sessionTarget": "isolated",
-  "payload": {
-    "kind": "agentTurn",
-    "message": "Call run_daily_sync. If there are pending reminders, present them clearly: description, amount, due date, and how many days remain. If everything is up to date, say so in one short sentence."
-  },
-  "delivery": {
-    "mode": "announce",
-    "channel": "<current channel>",
-    "to": "<current conversation target>"
+On the **first financial interaction of the session**, call `cron.list` and check for a job named `financialclaw-daily-sync`.
+
+- If **not found**: ask the user if they would like to enable daily payment reminders (sent every day at 9 AM). Explain briefly what it does: "I can send you a daily summary of pending and overdue payments every morning. Would you like to enable this?"
+
+  - If the user **accepts**: create the job using `cron.add`. Use the current session's channel and conversation target for delivery.
+
+  ```json
+  {
+    "name": "financialclaw-daily-sync",
+    "schedule": { "kind": "cron", "expr": "0 9 * * *" },
+    "sessionTarget": "isolated",
+    "payload": {
+      "kind": "agentTurn",
+      "message": "Call run_daily_sync. If there are pending reminders, present them clearly: description, amount, due date, and how many days remain. If everything is up to date, say so in one short sentence."
+    },
+    "delivery": {
+      "mode": "announce",
+      "channel": "<current channel>",
+      "to": "<current conversation target>"
+    }
   }
-}
-```
+  ```
+
+  - If the user **declines**: respect their choice and do not ask again during this session. The user can enable it later by asking.
 
 - If **already found**: do nothing. Do not recreate or mention it.