palmier 0.3.2 → 0.3.3

package/README.md

@@ -6,7 +6,7 @@
 
 **Website:** [palmier.me](https://www.palmier.me) | **App:** [app.palmier.me](https://app.palmier.me)
 
-A Node.js CLI that runs on your machine as a persistent daemon. It manages tasks, communicates with the Palmier app via NATS and/or direct HTTP, and executes tasks on schedule or demand using CLI tools.
+A Node.js CLI that runs on your machine as a persistent daemon. It lets you create, schedule, and run AI agent tasks from your phone or browser, communicating via a cloud relay (NATS) and/or direct HTTP.
 
 > **Important:** By using Palmier, you agree to the [Terms of Service](https://www.palmier.me/terms) and [Privacy Policy](https://www.palmier.me/privacy). See the [Disclaimer](#disclaimer) section below.
 
@@ -16,10 +16,10 @@ The host supports two independent connection modes, enabled during `palmier init
 
 | Mode | Transport | PWA URL | Features |
 |------|-----------|---------|----------|
-| **Server** | NATS (cloud relay) | `https://app.palmier.me` | Push notifications, remote access |
+| **Server** | Cloud relay (NATS) | `https://app.palmier.me` | Push notifications, remote access |
 | **LAN** | HTTP (direct, on-demand) | `http://<host-ip>:7400` | Low-latency, no external server needed |
 
-**Server mode** relays communication through the Palmier server via NATS. All features including push notifications are available. The PWA is served over HTTPS.
+**Server mode** relays communication through the Palmier cloud server (via [NATS](https://nats.io), a lightweight messaging system). All features including push notifications are available. The PWA is served over HTTPS.
 
 **LAN mode** is started on-demand via `palmier lan`. It runs a local HTTP server that reverse-proxies PWA assets from `app.palmier.me` and serves API endpoints locally. The browser accesses everything at `http://<host-ip>:<port>` (same-origin). Push notifications are not available in LAN mode.
 
@@ -35,6 +35,8 @@ The host supports two independent connection modes, enabled during `palmier init
 npm install -g palmier
 ```
 
+All `palmier` commands should be run from a dedicated Palmier root directory (e.g., `~/palmier`). This is where tasks, configuration, and execution data are stored.
+
 ## CLI Commands
 
 | Command | Description |
@@ -57,7 +59,7 @@ npm install -g palmier
 ### Quick Start
 
 1. Install the host: `npm install -g palmier`
-2. Run `palmier init` in your project directory.
+2. Run `palmier init` in your Palmier root directory (e.g., `~/palmier`).
 3. The wizard detects installed agents, registers with the Palmier server, installs a background daemon, and generates a pairing code.
 4. Enter the pairing code in the Palmier PWA to connect your device.
 
@@ -153,7 +155,6 @@ src/
   spawn-command.ts    # Shared helper for spawning CLI tools
   task.ts             # Task file management
   types.ts            # Shared type definitions
-  pairing.ts          # OTP code generation and expiry constant
   lan-lock.ts         # LAN lockfile path and port reader
   events.ts           # Event broadcasting (NATS pub/sub or HTTP SSE)
   agents/
@@ -210,11 +211,11 @@ Requires a provisioned host (`palmier init`) with server mode enabled.
 |---|---|---|
 | `send-push-notification` | `title`, `body` (required) | Send a push notification to all paired devices |
 
-## Removing a Host
+## Uninstalling
 
-To fully remove a host from a machine:
+To fully remove Palmier from a machine:
 
-1. **Unpair the host from the PWA** (via the host menu).
+1. **Unpair your device** in the PWA (via the host menu).
 
 2. **Stop and remove the daemon:**
 
@@ -248,16 +249,11 @@ To fully remove a host from a machine:
    schtasks /delete /tn "PalmierTask-*" /f 2>$null
    ```
 
-4. **Remove the host configuration:**
+4. **Remove configuration and task data:**
 
    ```bash
    rm -rf ~/.config/palmier
-   ```
-
-5. **Remove the tasks directory** from your project root:
-
-   ```bash
-   rm -rf tasks/
+   rm -rf tasks/   # from your Palmier root directory
    ```
 
 ## Disclaimer

package/dist/commands/lan.js

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { loadConfig, CONFIG_DIR } from "../config.js";
 import { createRpcHandler } from "../rpc-handler.js";
 import { startHttpTransport, detectLanIp } from "../transports/http-transport.js";
-import { generatePairingCode } from "../pairing.js";
+import { generatePairingCode } from "./pair.js";
 import { LAN_LOCKFILE } from "../lan-lock.js";
 const bold = (s) => `\x1b[1m${s}\x1b[0m`;
 const cyan = (s) => `\x1b[36m${s}\x1b[0m`;

package/dist/commands/pair.d.ts

@@ -1,3 +1,5 @@
+export declare const PAIRING_EXPIRY_MS: number;
+export declare function generatePairingCode(): string;
 /**
  * Generate an OTP code and wait for a PWA client to pair.
  * Listens on NATS always, and also on the LAN server if `palmier lan` is running.

package/dist/commands/pair.js

@@ -3,8 +3,15 @@ import { StringCodec } from "nats";
 import { loadConfig } from "../config.js";
 import { connectNats } from "../nats-client.js";
 import { addSession } from "../session-store.js";
-import { generatePairingCode, PAIRING_EXPIRY_MS } from "../pairing.js";
 import { getLanPort } from "../lan-lock.js";
+const CODE_CHARS = "ABCDEFGHJKMNPQRSTUVWXYZ23456789"; // no O/0/I/1/L
+const CODE_LENGTH = 6;
+export const PAIRING_EXPIRY_MS = 5 * 60 * 1000; // 5 minutes
+export function generatePairingCode() {
+    const bytes = new Uint8Array(CODE_LENGTH);
+    crypto.getRandomValues(bytes);
+    return Array.from(bytes, (b) => CODE_CHARS[b % CODE_CHARS.length]).join("");
+}
 function buildPairResponse(config, label) {
     const session = addSession(label);
     return {

package/dist/platform/windows.js

@@ -63,8 +63,9 @@ function schtasksTaskName(taskId) {
 export class WindowsPlatform {
     installDaemon(config) {
         const script = process.argv[1] || "palmier";
-        // Write a VBS launcher that starts the daemon with no visible console window
-        const vbs = `CreateObject("WScript.Shell").Run """${process.execPath.replace(/\\/g, "\\\\")}"" ""${script.replace(/\\/g, "\\\\")}"" serve", 0, False`;
+        // Write a VBS launcher that starts the daemon with no visible console window.
+        // VBS doesn't use backslash escaping — only quotes need doubling ("").
+        const vbs = `CreateObject("WScript.Shell").Run """${process.execPath}"" ""${script}"" serve", 0, False`;
         fs.writeFileSync(DAEMON_VBS_FILE, vbs, "utf-8");
         const regValue = `"${process.env.SYSTEMROOT || "C:\\Windows"}\\System32\\wscript.exe" "${DAEMON_VBS_FILE}"`;
         try {

package/dist/update-checker.d.ts

@@ -1,3 +1,5 @@
+/** True when running from a source checkout (has .git) rather than a global npm install. */
+export declare const isDevBuild: boolean;
 export declare const currentVersion: string;
 /**
  * Check the npm registry for the latest version of palmier.

package/dist/update-checker.js

@@ -4,8 +4,11 @@ import { fileURLToPath } from "url";
 import { spawnCommand } from "./spawn-command.js";
 import { getPlatform } from "./platform/index.js";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "package.json"), "utf-8"));
-export const currentVersion = pkg.version;
+const packageRoot = path.join(__dirname, "..");
+const pkg = JSON.parse(fs.readFileSync(path.join(packageRoot, "package.json"), "utf-8"));
+/** True when running from a source checkout (has .git) rather than a global npm install. */
+export const isDevBuild = fs.existsSync(path.join(packageRoot, ".git"));
+export const currentVersion = isDevBuild ? `${pkg.version}-dev` : pkg.version;
 let latestVersion = null;
 let lastCheckTime = 0;
 const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
@@ -13,6 +16,8 @@ const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
  * Check the npm registry for the latest version of palmier.
  */
 export async function checkForUpdate() {
+    if (isDevBuild)
+        return;
     const now = Date.now();
     if (now - lastCheckTime < CHECK_INTERVAL_MS)
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "palmier",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Palmier host CLI - provisions, executes tasks, and serves NATS RPC",
   "license": "Apache-2.0",
   "author": "Hongxu Cai",

package/src/commands/lan.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { loadConfig, CONFIG_DIR } from "../config.js";
 import { createRpcHandler } from "../rpc-handler.js";
 import { startHttpTransport, detectLanIp } from "../transports/http-transport.js";
-import { generatePairingCode } from "../pairing.js";
+import { generatePairingCode } from "./pair.js";
 import { LAN_LOCKFILE } from "../lan-lock.js";
 
 const bold = (s: string) => `\x1b[1m${s}\x1b[0m`;

package/src/commands/pair.ts

@@ -3,10 +3,20 @@ import { StringCodec } from "nats";
 import { loadConfig } from "../config.js";
 import { connectNats } from "../nats-client.js";
 import { addSession } from "../session-store.js";
-import { generatePairingCode, PAIRING_EXPIRY_MS } from "../pairing.js";
 import { getLanPort } from "../lan-lock.js";
 import type { HostConfig } from "../types.js";
 
+const CODE_CHARS = "ABCDEFGHJKMNPQRSTUVWXYZ23456789"; // no O/0/I/1/L
+const CODE_LENGTH = 6;
+
+export const PAIRING_EXPIRY_MS = 5 * 60 * 1000; // 5 minutes
+
+export function generatePairingCode(): string {
+  const bytes = new Uint8Array(CODE_LENGTH);
+  crypto.getRandomValues(bytes);
+  return Array.from(bytes, (b) => CODE_CHARS[b % CODE_CHARS.length]).join("");
+}
+
 function buildPairResponse(config: HostConfig, label?: string) {
   const session = addSession(label);
   return {

package/src/platform/windows.ts

@@ -78,8 +78,9 @@ export class WindowsPlatform implements PlatformService {
   installDaemon(config: HostConfig): void {
     const script = process.argv[1] || "palmier";
 
-    // Write a VBS launcher that starts the daemon with no visible console window
-    const vbs = `CreateObject("WScript.Shell").Run """${process.execPath.replace(/\\/g, "\\\\")}"" ""${script.replace(/\\/g, "\\\\")}"" serve", 0, False`;
+    // Write a VBS launcher that starts the daemon with no visible console window.
+    // VBS doesn't use backslash escaping — only quotes need doubling ("").
+    const vbs = `CreateObject("WScript.Shell").Run """${process.execPath}"" ""${script}"" serve", 0, False`;
     fs.writeFileSync(DAEMON_VBS_FILE, vbs, "utf-8");
 
     const regValue = `"${process.env.SYSTEMROOT || "C:\\Windows"}\\System32\\wscript.exe" "${DAEMON_VBS_FILE}"`;

package/src/update-checker.ts

@@ -5,8 +5,12 @@ import { spawnCommand } from "./spawn-command.js";
 import { getPlatform } from "./platform/index.js";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const pkg = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "package.json"), "utf-8")) as { version: string };
-export const currentVersion = pkg.version;
+const packageRoot = path.join(__dirname, "..");
+const pkg = JSON.parse(fs.readFileSync(path.join(packageRoot, "package.json"), "utf-8")) as { version: string };
+
+/** True when running from a source checkout (has .git) rather than a global npm install. */
+export const isDevBuild = fs.existsSync(path.join(packageRoot, ".git"));
+export const currentVersion = isDevBuild ? `${pkg.version}-dev` : pkg.version;
 
 let latestVersion: string | null = null;
 let lastCheckTime = 0;
@@ -16,6 +20,7 @@ const CHECK_INTERVAL_MS = 24 * 60 * 60 * 1000;
  * Check the npm registry for the latest version of palmier.
  */
 export async function checkForUpdate(): Promise<void> {
+  if (isDevBuild) return;
   const now = Date.now();
   if (now - lastCheckTime < CHECK_INTERVAL_MS) return;
   lastCheckTime = now;

package/dist/pairing.d.ts

@@ -1,3 +0,0 @@
-export declare const PAIRING_EXPIRY_MS: number;
-export declare function generatePairingCode(): string;
-//# sourceMappingURL=pairing.d.ts.map

package/dist/pairing.js

@@ -1,9 +0,0 @@
-const CODE_CHARS = "ABCDEFGHJKMNPQRSTUVWXYZ23456789"; // no O/0/I/1/L
-const CODE_LENGTH = 6;
-export const PAIRING_EXPIRY_MS = 5 * 60 * 1000; // 5 minutes
-export function generatePairingCode() {
-    const bytes = new Uint8Array(CODE_LENGTH);
-    crypto.getRandomValues(bytes);
-    return Array.from(bytes, (b) => CODE_CHARS[b % CODE_CHARS.length]).join("");
-}
-//# sourceMappingURL=pairing.js.map

package/src/pairing.ts

@@ -1,10 +0,0 @@
-const CODE_CHARS = "ABCDEFGHJKMNPQRSTUVWXYZ23456789"; // no O/0/I/1/L
-const CODE_LENGTH = 6;
-
-export const PAIRING_EXPIRY_MS = 5 * 60 * 1000; // 5 minutes
-
-export function generatePairingCode(): string {
-  const bytes = new Uint8Array(CODE_LENGTH);
-  crypto.getRandomValues(bytes);
-  return Array.from(bytes, (b) => CODE_CHARS[b % CODE_CHARS.length]).join("");
-}