@robin7331/papyrus-cli 0.1.6 → 0.1.7

package/README.md

@@ -27,20 +27,20 @@ papyrus --help
 # Show installed CLI version
 papyrus --version
 
-# Single file (auto mode; if no API key is found, Papyrus prompts you to paste one)
+# Single file (default behavior; if no API key is found, Papyrus prompts you to paste one)
 papyrus ./path/to/input.pdf
 
 # Single file with explicit format/output/model
 papyrus ./path/to/input.pdf --format md --output ./out/result.md --model gpt-4o-mini
 
-# Auto mode with extra instructions
+# Default conversion with extra instructions
 papyrus ./path/to/input.pdf --instructions "Prioritize table accuracy." --format txt
 
-# Prompt mode (inline prompt)
-papyrus ./path/to/input.pdf --mode prompt --prompt "Extract all invoice line items as bullet points." --format md
+# Prompt conversion (inline prompt)
+papyrus ./path/to/input.pdf --prompt "Extract all invoice line items as bullet points." --format md
 
-# Prompt mode (prompt file)
-papyrus ./path/to/input.pdf --mode prompt --prompt-file ./my-prompt.txt --format txt
+# Prompt conversion (prompt file)
+papyrus ./path/to/input.pdf --prompt-file ./my-prompt.txt --format txt
 
 # Folder mode (recursive scan, asks for confirmation)
 papyrus ./path/to/folder
@@ -132,46 +132,34 @@ Example:
 papyrus ./docs --output ./converted
 ```
 
-### `--mode <mode>`
-
-Conversion mode:
-- `auto` (default): built-in conversion behavior.
-- `prompt`: use your own prompt via `--prompt` or `--prompt-file`.
-
-Example:
-
-```bash
-papyrus ./docs/invoice.pdf --mode prompt --prompt "Extract all line items."
-```
-
 ### `--instructions <text>`
 
-Additional conversion instructions in `auto` mode only.
+Additional conversion instructions for default conversion behavior. Cannot be combined with `--prompt` or `--prompt-file`.
 
 Example:
 
 ```bash
-papyrus ./docs/invoice.pdf --mode auto --instructions "Keep table columns aligned."
+papyrus ./docs/invoice.pdf --instructions "Keep table columns aligned."
 ```
 
 ### `--prompt <text>`
 
-Inline prompt text for `prompt` mode. Must be non-empty. In `prompt` mode, use exactly one of `--prompt` or `--prompt-file`.
+Inline prompt text for prompt-based conversion. Must be non-empty. Use exactly one of `--prompt` or `--prompt-file`.
 
 Example:
 
 ```bash
-papyrus ./docs/invoice.pdf --mode prompt --prompt "Summarize payment terms."
+papyrus ./docs/invoice.pdf --prompt "Summarize payment terms."
 ```
 
 ### `--prompt-file <path>`
 
-Path to a text file containing the prompt for `prompt` mode. File must contain non-empty text. In `prompt` mode, use exactly one of `--prompt` or `--prompt-file`.
+Path to a text file containing the prompt for prompt-based conversion. File must contain non-empty text. Use exactly one of `--prompt` or `--prompt-file`.
 
 Example:
 
 ```bash
-papyrus ./docs/invoice.pdf --mode prompt --prompt-file ./my-prompt.txt
+papyrus ./docs/invoice.pdf --prompt-file ./my-prompt.txt
 ```
 
 ### `-m, --model <model>`
@@ -206,7 +194,7 @@ papyrus ./docs --yes
 
 ## Notes
 
-- In `auto` mode without `--format`, the model returns structured JSON with `format` + `content`.
+- In default conversion (without `--prompt`/`--prompt-file`) and without `--format`, the model returns structured JSON with `format` + `content`.
 - Single-file input now also shows a live worker lane (spinner in TTY) while conversion is running.
 - Folder input is scanned recursively for `.pdf` files and processed in parallel.
 - In folder mode, `--output` must be a directory path and mirrored subfolders are preserved.

package/dist/cli.js

@@ -6,7 +6,7 @@ import { dirname, join, relative, resolve } from "node:path";
 import { Command } from "commander";
 import { clearStoredApiKey, getConfigFilePath, getStoredApiKey, maskApiKey, setStoredApiKey } from "./config.js";
 import { convertPdf } from "./openaiPdfToMarkdown.js";
-import { defaultOutputPath, formatDurationMs, isPdfPath, looksLikeFileOutput, parseConcurrency, parseFormat, parseMode, resolveFolderOutputPath, truncate, validateOptionCombination } from "./cliHelpers.js";
+import { defaultOutputPath, formatDurationMs, isPdfPath, looksLikeFileOutput, parseConcurrency, parseFormat, resolveFolderOutputPath, truncate, validateOptionCombination } from "./cliHelpers.js";
 const program = new Command();
 const configFilePath = getConfigFilePath();
 const OPENAI_API_KEYS_URL = "https://platform.openai.com/settings/organization/api-keys";
@@ -20,24 +20,24 @@ program
     .option("-m, --model <model>", "OpenAI model to use", "gpt-4o-mini")
     .option("--concurrency <n>", "Max parallel workers for folder input (default: 10)", parseConcurrency)
     .option("-y, --yes", "Skip confirmation prompt in folder mode")
-    .option("--mode <mode>", "Conversion mode: auto or prompt", parseMode, "auto")
     .option("--format <format>", "Output format override: md or txt", parseFormat)
-    .option("--instructions <text>", "Additional conversion instructions for auto mode")
-    .option("--prompt <text>", "Custom prompt text for prompt mode")
-    .option("--prompt-file <path>", "Path to file containing prompt text for prompt mode")
+    .option("--instructions <text>", "Additional conversion instructions (only when not using --prompt/--prompt-file)")
+    .option("--prompt <text>", "Custom prompt text (enables prompt mode)")
+    .option("--prompt-file <path>", "Path to file containing prompt text (enables prompt mode)")
     .action(async (input, options) => {
     const inputPath = resolve(input);
     const startedAt = Date.now();
     try {
         validateOptionCombination(options);
         const promptText = await resolvePromptText(options);
+        const conversionMode = resolveConversionMode(promptText);
         const inputKind = await detectInputKind(inputPath);
         let usageTotals = emptyUsage();
         if (inputKind === "file") {
-            usageTotals = await processSingleFile(inputPath, options, promptText);
+            usageTotals = await processSingleFile(inputPath, options, conversionMode, promptText);
         }
         else {
-            const summary = await processFolder(inputPath, options, promptText);
+            const summary = await processFolder(inputPath, options, conversionMode, promptText);
             usageTotals = summary.usage;
             if (!summary.cancelled && summary.failed > 0) {
                 process.exitCode = 1;
@@ -112,7 +112,7 @@ program.parseAsync(process.argv).catch((error) => {
     console.error(`Command failed: ${message}`);
     process.exitCode = 1;
 });
-async function processSingleFile(inputPath, options, promptText) {
+async function processSingleFile(inputPath, options, mode, promptText) {
     if (!isPdfPath(inputPath)) {
         throw new Error("Input file must have a .pdf extension.");
     }
@@ -131,7 +131,7 @@ async function processSingleFile(inputPath, options, promptText) {
         const result = await convertPdf({
             inputPath,
             model: options.model,
-            mode: options.mode,
+            mode,
             format: options.format,
             instructions: options.instructions,
             promptText
@@ -164,7 +164,7 @@ async function processSingleFile(inputPath, options, promptText) {
         workerDashboard?.stop();
     }
 }
-async function processFolder(inputDir, options, promptText) {
+async function processFolder(inputDir, options, mode, promptText) {
     if (options.output && looksLikeFileOutput(options.output)) {
         throw new Error("In folder mode, --output must be a directory path (not a .md/.txt file path).");
     }
@@ -200,7 +200,7 @@ async function processFolder(inputDir, options, promptText) {
                 const result = await convertPdf({
                     inputPath: filePath,
                     model: options.model,
-                    mode: options.mode,
+                    mode,
                     format: options.format,
                     instructions: options.instructions,
                     promptText
@@ -250,9 +250,6 @@ async function processFolder(inputDir, options, promptText) {
     return { total: files.length, succeeded, failed, cancelled: false, usage };
 }
 async function resolvePromptText(options) {
-    if (options.mode !== "prompt") {
-        return undefined;
-    }
     if (options.prompt) {
         const prompt = options.prompt.trim();
         if (!prompt) {
@@ -270,6 +267,9 @@ async function resolvePromptText(options) {
     }
     return promptFromFile;
 }
+function resolveConversionMode(promptText) {
+    return promptText ? "prompt" : "auto";
+}
 async function handleConfigInit(options) {
     const existingKey = await getStoredApiKey();
     if (existingKey && !options.force) {

package/dist/cliHelpers.d.ts

@@ -1,16 +1,14 @@
-import { type ConversionMode, type OutputFormat } from "./openaiPdfToMarkdown.js";
+import { type OutputFormat } from "./openaiPdfToMarkdown.js";
 export type CliOptions = {
     output?: string;
     model: string;
     concurrency?: number;
     yes?: boolean;
-    mode: ConversionMode;
     format?: OutputFormat;
     instructions?: string;
     prompt?: string;
     promptFile?: string;
 };
-export declare function parseMode(value: string): ConversionMode;
 export declare function parseFormat(value: string): OutputFormat;
 export declare function parseConcurrency(value: string): number;
 export declare function validateOptionCombination(options: CliOptions): void;

package/dist/cliHelpers.js

@@ -1,11 +1,5 @@
 import { InvalidArgumentError } from "commander";
 import { basename, dirname, extname, join, relative } from "node:path";
-export function parseMode(value) {
-    if (value === "auto" || value === "prompt") {
-        return value;
-    }
-    throw new InvalidArgumentError("Mode must be either 'auto' or 'prompt'.");
-}
 export function parseFormat(value) {
     if (value === "md" || value === "txt") {
         return value;
@@ -20,18 +14,12 @@ export function parseConcurrency(value) {
     return parsed;
 }
 export function validateOptionCombination(options) {
-    if (options.mode === "prompt") {
-        const promptSourceCount = Number(Boolean(options.prompt)) + Number(Boolean(options.promptFile));
-        if (promptSourceCount !== 1) {
-            throw new Error("Prompt mode requires exactly one of --prompt or --prompt-file.");
-        }
-        if (options.instructions) {
-            throw new Error("--instructions is only supported in auto mode.");
-        }
-        return;
+    const promptSourceCount = Number(Boolean(options.prompt)) + Number(Boolean(options.promptFile));
+    if (promptSourceCount > 1) {
+        throw new Error("Use exactly one of --prompt or --prompt-file.");
     }
-    if (options.prompt || options.promptFile) {
-        throw new Error("--prompt and --prompt-file are only supported in prompt mode.");
+    if (promptSourceCount === 1 && options.instructions) {
+        throw new Error("--instructions cannot be combined with --prompt or --prompt-file.");
     }
 }
 export function defaultOutputPath(inputPath, format) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robin7331/papyrus-cli",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "private": false,
   "description": "Convert PDF to markdown or text with the OpenAI Agents SDK",
   "repository": {

package/src/cli.ts

@@ -14,6 +14,7 @@ import {
 } from "./config.js";
 import {
   convertPdf,
+  type ConversionMode,
   type ConvertUsage
 } from "./openaiPdfToMarkdown.js";
 import {
@@ -23,7 +24,6 @@ import {
   looksLikeFileOutput,
   parseConcurrency,
   parseFormat,
-  parseMode,
   resolveFolderOutputPath,
   truncate,
   type CliOptions,
@@ -52,14 +52,13 @@ program
     parseConcurrency
   )
   .option("-y, --yes", "Skip confirmation prompt in folder mode")
-  .option("--mode <mode>", "Conversion mode: auto or prompt", parseMode, "auto")
   .option("--format <format>", "Output format override: md or txt", parseFormat)
   .option(
     "--instructions <text>",
-    "Additional conversion instructions for auto mode"
+    "Additional conversion instructions (only when not using --prompt/--prompt-file)"
   )
-  .option("--prompt <text>", "Custom prompt text for prompt mode")
-  .option("--prompt-file <path>", "Path to file containing prompt text for prompt mode")
+  .option("--prompt <text>", "Custom prompt text (enables prompt mode)")
+  .option("--prompt-file <path>", "Path to file containing prompt text (enables prompt mode)")
   .action(async (input: string, options: CliOptions) => {
     const inputPath = resolve(input);
     const startedAt = Date.now();
@@ -68,13 +67,14 @@ program
       validateOptionCombination(options);
 
       const promptText = await resolvePromptText(options);
+      const conversionMode = resolveConversionMode(promptText);
       const inputKind = await detectInputKind(inputPath);
       let usageTotals: ConvertUsage = emptyUsage();
 
       if (inputKind === "file") {
-        usageTotals = await processSingleFile(inputPath, options, promptText);
+        usageTotals = await processSingleFile(inputPath, options, conversionMode, promptText);
       } else {
-        const summary = await processFolder(inputPath, options, promptText);
+        const summary = await processFolder(inputPath, options, conversionMode, promptText);
         usageTotals = summary.usage;
         if (!summary.cancelled && summary.failed > 0) {
           process.exitCode = 1;
@@ -157,6 +157,7 @@ program.parseAsync(process.argv).catch((error: unknown) => {
 async function processSingleFile(
   inputPath: string,
   options: CliOptions,
+  mode: ConversionMode,
   promptText?: string
 ): Promise<ConvertUsage> {
   if (!isPdfPath(inputPath)) {
@@ -180,7 +181,7 @@ async function processSingleFile(
     const result = await convertPdf({
       inputPath,
       model: options.model,
-      mode: options.mode,
+      mode,
       format: options.format,
       instructions: options.instructions,
       promptText
@@ -237,6 +238,7 @@ type FolderSummary = {
 async function processFolder(
   inputDir: string,
   options: CliOptions,
+  mode: ConversionMode,
   promptText?: string
 ): Promise<FolderSummary> {
   if (options.output && looksLikeFileOutput(options.output)) {
@@ -282,7 +284,7 @@ async function processFolder(
         const result = await convertPdf({
           inputPath: filePath,
           model: options.model,
-          mode: options.mode,
+          mode,
           format: options.format,
           instructions: options.instructions,
           promptText
@@ -347,10 +349,6 @@ async function processFolder(
 }
 
 async function resolvePromptText(options: CliOptions): Promise<string | undefined> {
-  if (options.mode !== "prompt") {
-    return undefined;
-  }
-
   if (options.prompt) {
     const prompt = options.prompt.trim();
     if (!prompt) {
@@ -373,6 +371,10 @@ async function resolvePromptText(options: CliOptions): Promise<string | undefine
   return promptFromFile;
 }
 
+function resolveConversionMode(promptText: string | undefined): ConversionMode {
+  return promptText ? "prompt" : "auto";
+}
+
 async function handleConfigInit(options: ConfigInitOptions): Promise<void> {
   const existingKey = await getStoredApiKey();
   if (existingKey && !options.force) {

package/src/cliHelpers.ts

@@ -1,27 +1,18 @@
 import { InvalidArgumentError } from "commander";
 import { basename, dirname, extname, join, relative } from "node:path";
-import { type ConversionMode, type OutputFormat } from "./openaiPdfToMarkdown.js";
+import { type OutputFormat } from "./openaiPdfToMarkdown.js";
 
 export type CliOptions = {
   output?: string;
   model: string;
   concurrency?: number;
   yes?: boolean;
-  mode: ConversionMode;
   format?: OutputFormat;
   instructions?: string;
   prompt?: string;
   promptFile?: string;
 };
 
-export function parseMode(value: string): ConversionMode {
-  if (value === "auto" || value === "prompt") {
-    return value;
-  }
-
-  throw new InvalidArgumentError("Mode must be either 'auto' or 'prompt'.");
-}
-
 export function parseFormat(value: string): OutputFormat {
   if (value === "md" || value === "txt") {
     return value;
@@ -40,21 +31,13 @@ export function parseConcurrency(value: string): number {
 }
 
 export function validateOptionCombination(options: CliOptions): void {
-  if (options.mode === "prompt") {
-    const promptSourceCount = Number(Boolean(options.prompt)) + Number(Boolean(options.promptFile));
-    if (promptSourceCount !== 1) {
-      throw new Error("Prompt mode requires exactly one of --prompt or --prompt-file.");
-    }
-
-    if (options.instructions) {
-      throw new Error("--instructions is only supported in auto mode.");
-    }
-
-    return;
+  const promptSourceCount = Number(Boolean(options.prompt)) + Number(Boolean(options.promptFile));
+  if (promptSourceCount > 1) {
+    throw new Error("Use exactly one of --prompt or --prompt-file.");
   }
 
-  if (options.prompt || options.promptFile) {
-    throw new Error("--prompt and --prompt-file are only supported in prompt mode.");
+  if (promptSourceCount === 1 && options.instructions) {
+    throw new Error("--instructions cannot be combined with --prompt or --prompt-file.");
   }
 }
 

package/test/cliHelpers.test.ts

@@ -8,22 +8,12 @@ import {
   looksLikeFileOutput,
   parseConcurrency,
   parseFormat,
-  parseMode,
   resolveFolderOutputPath,
   truncate,
   validateOptionCombination,
   type CliOptions
 } from "../src/cliHelpers.js";
 
-test("parseMode accepts valid values", () => {
-  assert.equal(parseMode("auto"), "auto");
-  assert.equal(parseMode("prompt"), "prompt");
-});
-
-test("parseMode rejects invalid values", () => {
-  assert.throws(() => parseMode("invalid"), InvalidArgumentError);
-});
-
 test("parseFormat accepts valid values", () => {
   assert.equal(parseFormat("md"), "md");
   assert.equal(parseFormat("txt"), "txt");
@@ -45,42 +35,40 @@ test("parseConcurrency rejects invalid values", () => {
   assert.throws(() => parseConcurrency("abc"), InvalidArgumentError);
 });
 
-test("validateOptionCombination enforces prompt mode requirements", () => {
+test("validateOptionCombination allows default auto behavior without prompt flags", () => {
   const base: CliOptions = {
-    model: "gpt-4o-mini",
-    mode: "prompt"
+    model: "gpt-4o-mini"
   };
 
-  assert.throws(
-    () => validateOptionCombination(base),
-    /Prompt mode requires exactly one of --prompt or --prompt-file\./
-  );
-  assert.doesNotThrow(() => validateOptionCombination({ ...base, prompt: "Convert this" }));
+  assert.doesNotThrow(() => validateOptionCombination(base));
+  assert.doesNotThrow(() => validateOptionCombination({ ...base, instructions: "Extra formatting rules" }));
+});
+
+test("validateOptionCombination treats --prompt and --prompt-file as mutually exclusive", () => {
+  const base: CliOptions = {
+    model: "gpt-4o-mini"
+  };
+
+  assert.doesNotThrow(() => validateOptionCombination({ ...base, prompt: "Convert" }));
   assert.doesNotThrow(() => validateOptionCombination({ ...base, promptFile: "./prompt.txt" }));
   assert.throws(
     () => validateOptionCombination({ ...base, prompt: "x", promptFile: "./prompt.txt" }),
-    /Prompt mode requires exactly one of --prompt or --prompt-file\./
-  );
-  assert.throws(
-    () => validateOptionCombination({ ...base, prompt: "x", instructions: "Extra" }),
-    /--instructions is only supported in auto mode\./
+    /Use exactly one of --prompt or --prompt-file\./
   );
 });
 
-test("validateOptionCombination rejects prompt flags in auto mode", () => {
+test("validateOptionCombination rejects --instructions with prompt flags", () => {
   const base: CliOptions = {
-    model: "gpt-4o-mini",
-    mode: "auto"
+    model: "gpt-4o-mini"
   };
 
-  assert.doesNotThrow(() => validateOptionCombination(base));
   assert.throws(
-    () => validateOptionCombination({ ...base, prompt: "Convert" }),
-    /--prompt and --prompt-file are only supported in prompt mode\./
+    () => validateOptionCombination({ ...base, prompt: "x", instructions: "Extra" }),
+    /--instructions cannot be combined with --prompt or --prompt-file\./
   );
   assert.throws(
-    () => validateOptionCombination({ ...base, promptFile: "./prompt.txt" }),
-    /--prompt and --prompt-file are only supported in prompt mode\./
+    () => validateOptionCombination({ ...base, promptFile: "./prompt.txt", instructions: "Extra" }),
+    /--instructions cannot be combined with --prompt or --prompt-file\./
   );
 });