totem-llm 0.1.0 → 0.1.1

package/README.md

@@ -2,6 +2,48 @@
 
 Totem LLM is a sovereign AI solution, aimed at optimizing for consumer hardware and ensuring data privacy. It is designed to run efficiently on consumer-grade hardware, such as laptops and desktops, without the need for cloud-based processing. This allows users to have full control over their data and AI interactions, without relying on third-party services.
 
+## Install Quick Start Package
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) v18 or later
+- [Ollama](https://ollama.com/) (recommended) or an [OpenRouter](https://openrouter.ai/) API key
+
+### 1. Install the package
+
+```bash
+npm install -g totem-llm
+```
+
+This downloads Totem LLM and installs all server and collector dependencies automatically.
+
+### 2. Start Totem LLM
+
+```bash
+totem-llm start
+```
+
+On first run this performs one-time setup (creates `~/.totem-llm/`, migrates the database) then launches the server and document collector. Open [http://localhost:3001](http://localhost:3001) to access the UI.
+
+### Options
+
+```
+totem-llm --no-collector    Start without the document collector
+totem-llm --port=8080       Override the server port (default: 3001)
+totem-llm setup             Run first-time setup without starting
+totem-llm --help            Show all options
+```
+
+> **Storage**: All data is kept in `~/.totem-llm/` by default. Override with `TOTEM_STORAGE_DIR=/your/path totem-llm start`.
+
+> **Windows (PowerShell)**: If you see `cannot be loaded because running scripts is disabled`, run this once in PowerShell then retry:
+> ```powershell
+> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+> ```
+> Alternatively, use **Command Prompt** (`cmd.exe`) where `totem-llm.cmd` runs without any policy change.
+
+---
+
 ## Quick Start (Build from Source)
 
 ### Prerequisites

package/lib/setup.js

@@ -54,7 +54,7 @@ function buildEnvFile(storageDir) {
  */
 function runCommand(cmd, args, { cwd, env } = {}) {
   return new Promise((resolve, reject) => {
-    // On Windows, executables like "npx" need the .cmd wrapper
+    // On Windows, .cmd files must be invoked through the shell (EINVAL otherwise)
     const isWin = process.platform === "win32";
     const bin = isWin && !cmd.endsWith(".cmd") ? `${cmd}.cmd` : cmd;
 
@@ -62,7 +62,7 @@ function runCommand(cmd, args, { cwd, env } = {}) {
       cwd,
       env,
       stdio: "inherit",
-      shell: false,
+      shell: isWin,
     });
 
     child.on("close", (code) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "totem-llm",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Totem LLM – Your Private AI. Run a self-hosted AI assistant locally on Linux, macOS, or Windows.",
   "main": "bin/totem-llm.js",
   "type": "module",

package/scripts/postinstall.mjs

@@ -30,7 +30,7 @@ function bin(name) {
 /** Run a command, streaming output, resolving on exit-0, rejecting otherwise. */
 function run(cmd, args, cwd) {
   return new Promise((resolve, reject) => {
-    const child = spawn(bin(cmd), args, { cwd, stdio: "inherit", shell: false });
+    const child = spawn(bin(cmd), args, { cwd, stdio: "inherit", shell: isWin });
     child.on("close", (code) =>
       code === 0
         ? resolve()