readthemanual 0.0.1 → 0.0.2

package/README.md

@@ -11,15 +11,23 @@ Documentation lives in repos. Searching it means context-switching to a browser,
 ## Install
 
 ```bash
-git clone https://github.com/rgr4y/rtm.git
-cd rtm
-npm install && npm run build
-npm link   # makes `rtm` available globally
+# Run it without installing globally
+npx readthemanual --help
+
+# Or install the short command globally
+npm install -g readthemanual
+rtm --help
 ```
 
 ## Quick start
 
 ```bash
+# Run directly from npm
+npx readthemanual add react facebook/react -p docs/
+npx readthemanual ingest -s react -v
+npx readthemanual "concurrent rendering"
+
+# Or use the global short alias after installing
 # Add a source (any public GitHub repo with markdown docs)
 rtm add react facebook/react -p docs/
 

package/dist/cli.js

@@ -1,5 +1,38 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -11,13 +44,14 @@ const mcp_1 = require("./mcp");
 const db_1 = require("./db");
 const config_1 = require("./config");
 const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
 const config = (0, config_1.loadConfig)();
 const defaultDb = (0, config_1.getDbPath)(config);
 const program = new commander_1.Command();
 program
     .name("rtm")
     .description("Read the Manual — fast local full-text search for documentation")
-    .version("0.0.1");
+    .version("0.0.2");
 program
     .command("ingest")
     .description("Fetch and index docs from configured GitHub sources")
@@ -147,14 +181,39 @@ program
     console.log(`\nShowing ${result.docs.length} of ${result.total} total sections`);
 });
 program
-    .command("add <name> <repo>")
-    .description("Add a GitHub repo as a doc source (repo = owner/repo)")
-    .option("-b, --branch <branch>", "Branch to index", "main")
-    .option("-p, --prefix <prefix>", "Path prefix for docs in the repo", "docs/")
-    .action((name, repo, opts) => {
-    (0, config_1.addSource)({ name, repo, branch: opts.branch, docsPrefix: opts.prefix });
-    console.log(`Added source "${name}" → ${repo}@${opts.branch} (prefix: ${opts.prefix})`);
-    console.log(`Run \`rtm ingest -s ${name}\` to index it.`);
+    .command("add <name> <source>")
+    .description("Add a doc source: local path, or owner/repo for GitHub")
+    .option("-b, --branch <branch>", "Branch (GitHub sources only)", "main")
+    .option("-p, --prefix <prefix>", "Docs path prefix (GitHub sources only)", "docs/")
+    .action(async (name, source, opts) => {
+    // Strip optional git: prefix
+    const stripped = source.startsWith("git:") ? source.slice(4) : source;
+    // 1. Try local path first
+    const resolved = path_1.default.resolve(stripped);
+    if (fs_1.default.existsSync(resolved)) {
+        (0, config_1.addSource)({ name, localPath: resolved });
+        console.log(`Added local source "${name}" → ${resolved}`);
+        console.log(`Run \`rtm ingest -s ${name}\` to index it.`);
+        return;
+    }
+    // 2. Looks like owner/repo?
+    if (/^[\w.-]+\/[\w.-]+$/.test(stripped)) {
+        const repo = stripped;
+        const { createInterface } = await Promise.resolve().then(() => __importStar(require("readline")));
+        const rl = createInterface({ input: process.stdin, output: process.stdout });
+        const answer = await new Promise((resolve) => rl.question(`Add GitHub source ${repo}@${opts.branch} (prefix: ${opts.prefix})? [y/N] `, resolve));
+        rl.close();
+        if (answer.trim().toLowerCase() !== "y") {
+            console.log("Aborted.");
+            return;
+        }
+        (0, config_1.addSource)({ name, repo, branch: opts.branch, docsPrefix: opts.prefix });
+        console.log(`Added source "${name}" → ${repo}@${opts.branch} (prefix: ${opts.prefix})`);
+        console.log(`Run \`rtm ingest -s ${name}\` to index it.`);
+        return;
+    }
+    console.error(`Cannot resolve "${source}" as a local path or a GitHub owner/repo.`);
+    process.exit(1);
 });
 program
     .command("remove <name>")
@@ -194,7 +253,10 @@ program
     console.log(`Sources (${cfg.sources.length}):`);
     for (const s of cfg.sources) {
         const marker = s.name === (0, config_1.getDefaultSource)(cfg) ? " *" : "";
-        console.log(`  - ${s.name}: ${s.repo}@${s.branch ?? "main"} (prefix: ${s.docsPrefix ?? "docs/"})${marker}`);
+        const location = s.localPath
+            ? `local:${s.localPath}`
+            : `${s.repo}@${s.branch ?? "main"} (prefix: ${s.docsPrefix ?? "docs/"})`;
+        console.log(`  - ${s.name}: ${location}${marker}`);
     }
 });
 // Default: bare args with no subcommand → search

package/dist/config.d.ts

@@ -1,8 +1,9 @@
 export interface SourceConfig {
     name: string;
-    repo: string;
+    repo?: string;
     branch?: string;
     docsPrefix?: string;
+    localPath?: string;
 }
 export interface Config {
     sources: SourceConfig[];

package/dist/ingest.js

@@ -65,7 +65,56 @@ function splitByHeadings(markdown) {
     }
     return sections;
 }
+function walkMarkdownFiles(dir) {
+    const results = [];
+    for (const entry of fs_1.default.readdirSync(dir, { withFileTypes: true })) {
+        const full = path_1.default.join(dir, entry.name);
+        if (entry.isDirectory()) {
+            results.push(...walkMarkdownFiles(full));
+        }
+        else if (entry.isFile() && entry.name.endsWith(".md")) {
+            results.push(full);
+        }
+    }
+    return results;
+}
+async function ingestLocalSource(db, source, opts) {
+    const log = opts.verbose ? console.log : () => { };
+    const localPath = source.localPath;
+    if (!fs_1.default.existsSync(localPath)) {
+        throw new Error(`Local path does not exist: ${localPath}`);
+    }
+    const mdFiles = walkMarkdownFiles(localPath);
+    log(`[${source.name}] Found ${mdFiles.length} markdown files in ${localPath}`);
+    const allSections = [];
+    let filesProcessed = 0;
+    for (const filePath of mdFiles) {
+        const content = fs_1.default.readFileSync(filePath, "utf-8");
+        const relativePath = path_1.default.relative(localPath, filePath);
+        const sections = splitByHeadings(content);
+        for (const section of sections) {
+            allSections.push({
+                file_path: `${source.name}/${relativePath}`,
+                heading: section.heading,
+                content: section.content,
+                language: "en",
+            });
+        }
+        filesProcessed++;
+        log(`  [${filesProcessed}/${mdFiles.length}] ${relativePath} (${sections.length} sections)`);
+    }
+    const insertMany = db.transaction((sections) => {
+        for (const s of sections) {
+            (0, db_1.insertSection)(db, s);
+        }
+    });
+    insertMany(allSections);
+    return { filesProcessed, sectionsInserted: allSections.length };
+}
 async function ingestSource(db, source, opts) {
+    if (source.localPath) {
+        return ingestLocalSource(db, source, opts);
+    }
     const log = opts.verbose ? console.log : () => { };
     const repo = source.repo;
     const branch = source.branch ?? "main";

package/package.json

@@ -1,15 +1,21 @@
 {
   "name": "readthemanual",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Read the Manual — fast local full-text search for any project's docs",
   "main": "dist/cli.js",
   "bin": {
+    "readthemanual": "dist/cli.js",
     "rtm": "dist/cli.js"
   },
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "scripts": {
     "build": "tsc",
     "dev": "tsx src/cli.ts",
-    "start": "node dist/cli.js"
+    "start": "node dist/cli.js",
+    "prepare": "npm run build"
   },
   "keywords": [],
   "author": "",