@readwise/cli 0.3.0 → 0.5.0

package/README.md

@@ -7,10 +7,7 @@ Commands are auto-discovered from the Readwise API, so the CLI stays up to date
 ## Install
 
 ```bash
-git clone <repo-url> && cd readwise
-npm install
-npm run build
-npm link
+npm install -g @readwise/cli
 ```
 
 ## Setup
@@ -67,6 +64,8 @@ readwise reader-get-document-details --document-id <document-id>
 readwise reader-get-document-highlights --document-id <document-id>
 ```
 
+> **Tip: seen vs unseen documents.** In the response, `firstOpenedAt: null` means the document is **unseen** (never opened). A non-null `firstOpenedAt` means it has been opened/seen. Use `reader-edit-document-metadata --seen true` to mark a document as seen.
+
 ### Save a document
 
 ```bash
@@ -91,6 +90,7 @@ readwise reader-move-document --document-id <id> --location archive
 
 # Edit metadata
 readwise reader-edit-document-metadata --document-id <id> --title "Better Title"
+readwise reader-edit-document-metadata --document-id <id> --seen true  # mark as seen/opened
 readwise reader-set-document-notes --document-id <id> --notes "Updated notes"
 ```
 
@@ -125,16 +125,17 @@ Pipe results to `jq`:
 readwise reader-list-documents --limit 3 --json | jq '.results[].title'
 ```
 
+## How it works
+
+The CLI connects to the [Readwise MCP server](https://mcp2.readwise.io) internally, auto-discovers available tools, and exposes each one as a CLI command. The tool list is cached locally for 24 hours.
+
 ## Development
 
 ```bash
+git clone https://github.com/readwise/readwise-cli && cd readwise-cli
+npm install
+npm run build
+
 # Run without building
 npx tsx src/index.ts --help
-
-# Build
-npm run build
 ```
-
-## How it works
-
-The CLI connects to the [Readwise MCP server](https://mcp2.readwise.io) internally, auto-discovers available tools, and exposes each one as a CLI command. The tool list is cached locally for 24 hours.

package/dist/config.d.ts

@@ -15,6 +15,7 @@ export interface SchemaProperty {
     enum?: string[];
     items?: SchemaProperty;
     default?: unknown;
+    examples?: unknown[];
     anyOf?: SchemaProperty[];
     $ref?: string;
     properties?: Record<string, SchemaProperty>;

package/dist/index.js

@@ -2,8 +2,8 @@
 import { createInterface } from "node:readline";
 import { Command } from "commander";
 import { login, loginWithToken, ensureValidToken } from "./auth.js";
-import { getTools, callTool } from "./mcp.js";
-import { registerTools, displayResult } from "./commands.js";
+import { getTools } from "./mcp.js";
+import { registerTools } from "./commands.js";
 import { loadConfig } from "./config.js";
 import { VERSION } from "./version.js";
 function readHiddenInput(prompt) {
@@ -85,62 +85,14 @@ program
         process.exitCode = 1;
     }
 });
-program
-    .command("search <query>")
-    .description("Search across Reader documents and Readwise highlights")
-    .option("--limit <n>", "Max results per source (default: 10)")
-    .action(async (query, options) => {
-    try {
-        const { token, authType } = await ensureValidToken();
-        const limit = options.limit ? Number(options.limit) : 10;
-        const json = program.opts().json || false;
-        const [readerResult, highlightsResult] = await Promise.all([
-            callTool(token, authType, "reader_search_documents", { query, limit }),
-            callTool(token, authType, "readwise_search_highlights", { vector_search_term: query, limit }),
-        ]);
-        if (json) {
-            const combined = {};
-            for (const item of readerResult.content) {
-                if (item.type === "text" && item.text) {
-                    try {
-                        combined.reader = JSON.parse(item.text);
-                    }
-                    catch {
-                        combined.reader = item.text;
-                    }
-                }
-            }
-            for (const item of highlightsResult.content) {
-                if (item.type === "text" && item.text) {
-                    try {
-                        combined.highlights = JSON.parse(item.text);
-                    }
-                    catch {
-                        combined.highlights = item.text;
-                    }
-                }
-            }
-            process.stdout.write(JSON.stringify(combined) + "\n");
-        }
-        else {
-            console.log("\x1b[1m\x1b[36m── Reader Documents ──\x1b[0m\n");
-            displayResult(readerResult, false);
-            console.log("\n\x1b[1m\x1b[36m── Readwise Highlights ──\x1b[0m\n");
-            displayResult(highlightsResult, false);
-        }
-    }
-    catch (err) {
-        process.stderr.write(`\x1b[31m${err.message}\x1b[0m\n`);
-        process.exitCode = 1;
-    }
-});
 async function main() {
     const config = await loadConfig();
     const forceRefresh = process.argv.includes("--refresh");
     const positionalArgs = process.argv.slice(2).filter((a) => !a.startsWith("--"));
     const hasSubcommand = positionalArgs.length > 0;
-    // If no subcommand, TTY, and authenticated → launch TUI
-    if (!hasSubcommand && process.stdout.isTTY && config.access_token) {
+    const wantsHelp = process.argv.includes("--help") || process.argv.includes("-h");
+    // If no subcommand, TTY, and authenticated → launch TUI (unless --help)
+    if (!hasSubcommand && !wantsHelp && process.stdout.isTTY && config.access_token) {
         try {
             const { token, authType } = await ensureValidToken();
             const tools = await getTools(token, authType, forceRefresh);
@@ -159,6 +111,12 @@ async function main() {
         console.log("\nRun `readwise login` or `readwise login-with-token` to authenticate.");
         return;
     }
+    // If not authenticated and trying a non-login command, tell user to log in
+    if (!config.access_token && hasSubcommand && positionalArgs[0] !== "login" && positionalArgs[0] !== "login-with-token") {
+        process.stderr.write("\x1b[31mNot logged in.\x1b[0m Run `readwise login` or `readwise login-with-token` to authenticate.\n");
+        process.exitCode = 1;
+        return;
+    }
     // Try to load tools if we have a token (for subcommand mode)
     if (config.access_token) {
         try {
@@ -168,7 +126,6 @@ async function main() {
         }
         catch (err) {
             // Don't fail — login command should still work
-            // Only warn if user is trying to run a non-login command
             if (hasSubcommand && positionalArgs[0] !== "login" && positionalArgs[0] !== "login-with-token") {
                 process.stderr.write(`\x1b[33mWarning: Could not fetch tools: ${err.message}\x1b[0m\n`);
             }