localsage 1.0.1 → 1.0.4

package/README.md

@@ -21,19 +21,23 @@ npm install -g localsage
 
 ## Quick Start
 
-1. Create a `knowledge` folder in your working directory and add documents:
+1. Go to any folder that contains your documents (PDF, TXT, MD) — or create a `knowledge` subfolder for them:
 
 ```bash
-mkdir knowledge
-cp your-document.pdf knowledge/
+cd my-documents
 ```
 
-2. Start LocalSage:
+2. Start LocalSage right there:
 
 ```bash
 localsage
 ```
 
+LocalSage picks the knowledge source automatically:
+1. the path you pass with `-k / --knowledge`, if given
+2. otherwise a `knowledge/` subfolder in the current directory, if it exists
+3. otherwise **the current directory itself** — so you can just `cd` into your docs folder and run `localsage`
+
 The first run downloads the model (~500 MB) to your Hugging Face cache. After that, it works fully offline.
 
 3. Ask questions about your documents!
@@ -50,7 +54,8 @@ The first run downloads the model (~500 MB) to your Hugging Face cache. After th
 localsage [options]
 
   -m, --model <model>      Model to use (default: "onnx-community/Qwen2.5-0.5B-Instruct")
-  -k, --knowledge <path>   Knowledge folder path (default: "./knowledge")
+  -k, --knowledge <path>   Knowledge folder path (default: ./knowledge if it
+                           exists, else the current directory)
   --no-pdf                 Disable PDF support
   --max-tokens <number>    Max tokens for response (default: 200)
   --temperature <number>   Temperature for generation (default: 0.7)
@@ -98,7 +103,7 @@ main();
 
 ## How It Works
 
-1. **Knowledge loading** — reads all TXT, MD, and PDF files from the knowledge folder (plus an optional `knowledge.txt` in the working directory)
+1. **Knowledge loading** — reads all TXT, MD, and PDF files from the resolved knowledge folder (explicit `-k` path → `./knowledge` subfolder → current directory), plus an optional `knowledge.txt` in the working directory
 2. **AI processing** — runs the Qwen model locally with `@huggingface/transformers`
 3. **History** — saves the conversation to `history.json` in the working directory
 

package/bin/localsage

@@ -1,4 +1,12 @@
 #!/usr/bin/env node
 
-// Wrapper that runs the LocalSage CLI
-require('../cli.js');
+// LocalSage CLI entry point.
+// cli.js exports runCLI and only auto-runs when it is the main module —
+// which it is NOT when launched through this bin wrapper. So we must
+// invoke it explicitly here.
+const runCLI = require('../cli.js');
+
+runCLI().catch((error) => {
+  console.error('Fatal Error:', error.message);
+  process.exit(1);
+});

package/cli.js

@@ -7,10 +7,13 @@ const LocalSage = require('./index');
 
 program
   .name('localsage')
-  .version('1.0.0')
+  .version('1.0.3')
   .description('LocalSage — local, offline AI assistant with PDF & document knowledge')
   .option('-m, --model <model>', 'Model name', 'onnx-community/Qwen2.5-0.5B-Instruct')
-  .option('-k, --knowledge <path>', 'Knowledge folder path', './knowledge')
+  .option(
+    '-k, --knowledge <path>',
+    'Knowledge folder path (default: ./knowledge if it exists, else the current directory)'
+  )
   .option('--no-pdf', 'Disable PDF support')
   .option('--max-tokens <number>', 'Max tokens for response', '200')
   .option('--temperature <number>', 'Temperature for generation', '0.7')
@@ -33,7 +36,7 @@ async function runCLI() {
   console.log(chalk.green.bold(' 🧙 LocalSage — your local AI assistant '));
   console.log(chalk.blue('='.repeat(60)));
   console.log(chalk.gray(` Model: ${options.model}`));
-  console.log(chalk.gray(` Knowledge: ${options.knowledge}`));
+  console.log(chalk.gray(` Knowledge: ${assistant.getResolvedKnowledgePath()}`));
   console.log(chalk.gray(` PDF Support: ${options.pdf !== false ? 'Enabled' : 'Disabled'}`));
   console.log(chalk.blue('='.repeat(60)));
   console.log(chalk.gray(' Commands:'));

package/index.js

@@ -6,7 +6,9 @@ class LocalSage {
   constructor(options = {}) {
     this.options = {
       model: options.model || 'onnx-community/Qwen2.5-0.5B-Instruct',
-      knowledgePath: options.knowledgePath || './knowledge',
+      // null = auto-resolve: ./knowledge if it exists, else the current
+      // working directory the user ran the command from
+      knowledgePath: options.knowledgePath || null,
       maxTokens: options.maxTokens || 200,
       temperature: options.temperature || 0.7,
       topP: options.topP || 0.9,
@@ -85,6 +87,10 @@ ${knowledge}`;
     return this.knowledge.getKnowledge();
   }
 
+  getResolvedKnowledgePath() {
+    return this.knowledge.getResolvedPath();
+  }
+
   async reloadKnowledge() {
     await this.knowledge.loadKnowledge();
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "localsage",
-  "version": "1.0.1",
+  "version": "1.0.4",
   "description": "LocalSage — a local, offline AI assistant with PDF & document knowledge. Powered by Qwen via Transformers.js. Pure Node.js, no Python.",
   "main": "index.js",
   "bin": {

package/src/knowledge.js

@@ -2,17 +2,41 @@ const fs = require('fs-extra');
 const path = require('path');
 
 class KnowledgeManager {
-  constructor(knowledgePath = './knowledge') {
-    this.knowledgePath = knowledgePath;
+  /**
+   * @param {string|null} knowledgePath - explicit path from the user, or null
+   *        to auto-resolve: use ./knowledge if it exists, otherwise the
+   *        current working directory itself.
+   */
+  constructor(knowledgePath = null) {
+    this.requestedPath = knowledgePath;
+    this.knowledgePath = null; // resolved in loadKnowledge()
     this.knowledge = '';
   }
 
+  resolvePath() {
+    if (this.requestedPath) {
+      return path.resolve(this.requestedPath);
+    }
+    const sub = path.join(process.cwd(), 'knowledge');
+    if (fs.pathExistsSync(sub)) {
+      return sub;
+    }
+    // Fall back to the directory the user ran the command from
+    return process.cwd();
+  }
+
   async loadKnowledge() {
+    this.knowledgePath = this.resolvePath();
     let combinedKnowledge = '';
 
-    // Load from knowledge.txt in the current directory (optional)
+    // Load a standalone knowledge.txt from the working directory —
+    // but only if it isn't already inside the folder we're about to scan
+    // (avoids loading it twice when knowledgePath === cwd).
     const txtFile = path.join(process.cwd(), 'knowledge.txt');
-    if (await fs.pathExists(txtFile)) {
+    if (
+      path.dirname(txtFile) !== this.knowledgePath &&
+      (await fs.pathExists(txtFile))
+    ) {
       try {
         combinedKnowledge += await fs.readFile(txtFile, 'utf-8');
         console.log('Knowledge loaded from knowledge.txt');
@@ -21,9 +45,8 @@ class KnowledgeManager {
       }
     }
 
-    // Load from the knowledge folder
     if (await fs.pathExists(this.knowledgePath)) {
-      console.log(`Loading knowledge from folder: ${this.knowledgePath}/`);
+      console.log(`Loading knowledge from: ${this.knowledgePath}`);
       const folderKnowledge = await this.loadFolder(this.knowledgePath);
       if (folderKnowledge) {
         if (combinedKnowledge) {
@@ -31,6 +54,8 @@ class KnowledgeManager {
         }
         combinedKnowledge += folderKnowledge;
       }
+    } else {
+      console.log(`Knowledge path not found: ${this.knowledgePath}`);
     }
 
     this.knowledge = combinedKnowledge;
@@ -50,7 +75,13 @@ class KnowledgeManager {
 
     for (const file of files) {
       const filePath = path.join(folderPath, file);
-      const stat = await fs.stat(filePath);
+
+      let stat;
+      try {
+        stat = await fs.stat(filePath);
+      } catch {
+        continue;
+      }
       if (stat.isDirectory()) continue;
 
       const ext = path.extname(file).toLowerCase();
@@ -80,7 +111,6 @@ class KnowledgeManager {
 
   async extractPDF(filePath) {
     try {
-      // Lazy-require so the app still starts if pdf-parse is missing/broken
       const pdfParse = require('pdf-parse');
       const dataBuffer = await fs.readFile(filePath);
       const data = await pdfParse(dataBuffer);
@@ -91,6 +121,10 @@ class KnowledgeManager {
     }
   }
 
+  getResolvedPath() {
+    return this.knowledgePath || this.resolvePath();
+  }
+
   getKnowledge(truncate = true, maxLength = 4000) {
     if (!truncate || this.knowledge.length <= maxLength) {
       return this.knowledge;