@possumtech/rummy 0.2.4 → 0.2.6

package/.env.example

@@ -1,3 +1,10 @@
+# DO NOT EDIT OR REMOVE!
+# COPY TO ~/.rummy.env or add appropriate
+# environment variables to ~/.bashrc or wherever
+
+# This project uses cascading environment variables
+# (environment) > ~/.rummy/.env > ~/.rummy/.env.example
+
 # Service Configuration
 PORT=3044
 

package/README.md

@@ -22,7 +22,7 @@ Rummy is the only LLM agent service inspired by and dedicated to the memory of f
 npm i -g @possumtech/rummy
 cd ~/.rummy
 cp .env.example .env
-vim .env
+vim .env # set up at least one model alias
 npm start
 ```
 

package/bin/postinstall.js

@@ -0,0 +1,22 @@
+import { existsSync, mkdirSync, copyFileSync } from "node:fs";
+import { join, dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import { homedir } from "node:os";
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const packageRoot = join(__dirname, "..");
+const envExample = join(packageRoot, ".env.example");
+
+const rummyHome = process.env.RUMMY_HOME || join(homedir(), ".rummy");
+
+if (!existsSync(rummyHome)) {
+	mkdirSync(rummyHome, { recursive: true });
+}
+for (const dir of ["plugins", "skills", "personas"]) {
+	const path = join(rummyHome, dir);
+	if (!existsSync(path)) mkdirSync(path, { recursive: true });
+}
+
+copyFileSync(envExample, join(rummyHome, ".env.example"));
+console.log(`[RUMMY] Configuration: ${rummyHome}/.env.example`);
+console.log(`[RUMMY] Copy to ${rummyHome}/.env and add your API keys.`);

package/bin/rummy.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { existsSync, mkdirSync } from "node:fs";
+import { existsSync } from "node:fs";
 import { join, dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 import { homedir } from "node:os";
@@ -8,24 +8,11 @@ import { homedir } from "node:os";
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const packageRoot = join(__dirname, "..");
 
-// Resolve RUMMY_HOME
 const rummyHome = process.env.RUMMY_HOME || join(homedir(), ".rummy");
 process.env.RUMMY_HOME = rummyHome;
 
-// Bootstrap ~/.rummy if needed
-if (!existsSync(rummyHome)) {
-	mkdirSync(rummyHome, { recursive: true });
-	console.log(`[RUMMY] Created ${rummyHome}`);
-}
-for (const dir of ["plugins", "skills", "personas"]) {
-	const path = join(rummyHome, dir);
-	if (!existsSync(path)) mkdirSync(path, { recursive: true });
-}
-
-// Load defaults from .env.example, then user overrides from ~/.rummy/.env
 process.loadEnvFile(join(packageRoot, ".env.example"));
 const userEnv = join(rummyHome, ".env");
 if (existsSync(userEnv)) process.loadEnvFile(userEnv);
 
-// Start service
 await import(join(packageRoot, "service.js"));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@possumtech/rummy",
-	"version": "0.2.4",
+	"version": "0.2.6",
 	"description": "Relational Unknowns Memory Management Yoke",
 	"keywords": [
 		"llm"
@@ -28,6 +28,7 @@
 	"type": "module",
 	"main": "service.js",
 	"scripts": {
+		"postinstall": "node ./bin/postinstall.js",
 		"start": "node --env-file-if-exists=.env.example --env-file-if-exists=.env service.js",
 		"dev": "node --env-file-if-exists=.env.example --env-file-if-exists=.env --env-file-if-exists=.env.dev --watch service.js",
 		"debug": "node --env-file-if-exists=.env.example --env-file-if-exists=.env --env-file-if-exists=.env.debug --inspect service.js",