@shiori-sh/cli 0.2.3 → 0.4.0

package/README.md

@@ -51,6 +51,13 @@ shiori delete <id>                 # Move to trash
 shiori trash                       # List trashed links
 shiori trash --empty               # Permanently delete all trash
 
+shiori subscriptions list           # List RSS subscriptions
+shiori subscriptions add <url>     # Subscribe to an RSS feed
+shiori subscriptions add <url> --sync  # Subscribe and sync recent items
+shiori subscriptions remove <id>   # Remove a subscription
+shiori subscriptions sync <id>     # Sync a subscription now
+shiori subscriptions sync <id> --limit 5  # Sync with item limit
+
 shiori me                          # Show account info
 shiori auth --status               # Check auth status
 shiori auth --logout               # Remove stored credentials

package/dist/index.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 
 // src/commands/auth.ts
+import { exec } from "child_process";
+import { hostname } from "os";
 import { createInterface } from "readline";
 
 // src/config.ts
@@ -87,16 +89,120 @@ function promptSecret(question) {
     stdin.on("data", onData);
   });
 }
+function openUrl(url) {
+  const platform = process.platform;
+  const cmd = platform === "darwin" ? "open" : platform === "win32" ? "start" : "xdg-open";
+  exec(`${cmd} ${JSON.stringify(url)}`);
+}
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function browserAuth() {
+  const baseUrl = getBaseUrl();
+  process.stdout.write("Starting browser authentication... ");
+  const deviceName = hostname();
+  const startRes = await fetch(`${baseUrl}/api/auth/cli/start`, {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({ device_name: deviceName })
+  });
+  if (!startRes.ok) {
+    console.error("failed.");
+    console.error("Could not start browser auth. Try `shiori auth --api-key` instead.");
+    process.exit(1);
+  }
+  const { code, auth_url } = await startRes.json();
+  console.log("done.\n");
+  console.log(`  Your code: ${code}
+`);
+  console.log(`  ${auth_url}
+`);
+  await prompt("Press Enter to open in browser (or open the URL above manually)...");
+  openUrl(auth_url);
+  console.log("\nWaiting for authorization...");
+  const POLL_INTERVAL = 2e3;
+  const MAX_POLLS = 150;
+  let polls = 0;
+  while (polls < MAX_POLLS) {
+    await sleep(POLL_INTERVAL);
+    polls++;
+    try {
+      const pollRes = await fetch(`${baseUrl}/api/auth/cli/poll?code=${code}`);
+      if (!pollRes.ok) {
+        console.error("\nAuthorization failed. The code may have expired.");
+        process.exit(1);
+      }
+      const data = await pollRes.json();
+      if (data.status === "approved" && data.api_key) {
+        const meRes = await fetch(`${baseUrl}/api/user/me`, {
+          headers: { Authorization: `Bearer ${data.api_key}` }
+        });
+        if (!meRes.ok) {
+          console.error("\nReceived API key but verification failed.");
+          process.exit(1);
+        }
+        const meData = await meRes.json();
+        writeConfig({ ...readConfig(), api_key: data.api_key });
+        console.log(`
+Authenticated as ${meData.user?.full_name || meData.user?.id}`);
+        console.log("API key saved to ~/.shiori/config.json");
+        return;
+      }
+      if (data.status === "expired") {
+        console.error("\nAuthorization code expired. Please try again.");
+        process.exit(1);
+      }
+      if (data.status === "consumed") {
+        console.error("\nAuthorization code already used. Please try again.");
+        process.exit(1);
+      }
+    } catch {
+    }
+  }
+  console.error("\nTimed out waiting for authorization. Please try again.");
+  process.exit(1);
+}
+async function apiKeyAuth() {
+  console.log("\nTo authenticate, you need an API key from Shiori.\n");
+  console.log("  1. Open https://www.shiori.sh/home -> Settings");
+  console.log("  2. Create and copy your API key");
+  console.log("  3. Paste it below\n");
+  const key = await promptSecret("API key: ");
+  const trimmed = key.trim();
+  if (!trimmed.startsWith("shk_")) {
+    console.error("\nInvalid API key format. Keys start with 'shk_'.");
+    process.exit(1);
+  }
+  process.stdout.write("\nVerifying... ");
+  const baseUrl = getBaseUrl();
+  const res = await fetch(`${baseUrl}/api/user/me`, {
+    headers: { Authorization: `Bearer ${trimmed}` }
+  });
+  if (!res.ok) {
+    console.error("failed.\nAuthentication failed. Check your API key and try again.");
+    process.exit(1);
+  }
+  const data = await res.json();
+  writeConfig({ ...readConfig(), api_key: trimmed });
+  console.log(`done.
+
+Authenticated as ${data.user?.full_name || data.user?.id}`);
+  console.log("API key saved to ~/.shiori/config.json");
+}
 async function run(args) {
   if (args.includes("--help") || args.includes("-h")) {
-    console.log(`shiori auth - Authenticate with your Shiori API key
+    console.log(`shiori auth - Authenticate with Shiori
 
 Usage: shiori auth [options]
 
 Options:
+  --api-key   Authenticate by pasting an API key manually
   --status    Show current authentication status
   --logout    Remove stored credentials
-  --help, -h  Show this help`);
+  --help, -h  Show this help
+
+By default, opens your browser for a quick sign-in.
+Use --api-key if you prefer to paste a key manually or are on a headless machine.`);
     return;
   }
   if (args.includes("--status")) {
@@ -122,31 +228,11 @@ Options:
     const answer = await prompt("You are already authenticated. Replace existing key? (y/N) ");
     if (answer.trim().toLowerCase() !== "y") return;
   }
-  console.log("\nTo authenticate, you need an API key from Shiori.\n");
-  console.log("  1. Open https://www.shiori.sh/home -> Settings");
-  console.log("  2. Create and copy your API key");
-  console.log("  3. Paste it below\n");
-  const key = await promptSecret("API key: ");
-  const trimmed = key.trim();
-  if (!trimmed.startsWith("shk_")) {
-    console.error("\nInvalid API key format. Keys start with 'shk_'.");
-    process.exit(1);
-  }
-  process.stdout.write("\nVerifying... ");
-  const baseUrl = getBaseUrl();
-  const res = await fetch(`${baseUrl}/api/user/me`, {
-    headers: { Authorization: `Bearer ${trimmed}` }
-  });
-  if (!res.ok) {
-    console.error("failed.\nAuthentication failed. Check your API key and try again.");
-    process.exit(1);
+  if (args.includes("--api-key")) {
+    await apiKeyAuth();
+  } else {
+    await browserAuth();
   }
-  const data = await res.json();
-  writeConfig({ ...readConfig(), api_key: trimmed });
-  console.log(`done.
-
-Authenticated as ${data.user?.full_name || data.user?.id}`);
-  console.log("API key saved to ~/.shiori/config.json");
 }
 
 // src/api.ts
@@ -196,9 +282,16 @@ function hasFlag(args, ...names) {
 function getPositional(args) {
   for (let i = 0; i < args.length; i++) {
     if (args[i].startsWith("--")) {
-      if (i + 1 < args.length && !args[i + 1].startsWith("--") && ["--limit", "--offset", "--sort", "--read", "--title", "--summary", "--since"].includes(
-        args[i]
-      )) {
+      if (i + 1 < args.length && !args[i + 1].startsWith("--") && [
+        "--limit",
+        "--offset",
+        "--sort",
+        "--read",
+        "--title",
+        "--summary",
+        "--since",
+        "--format"
+      ].includes(args[i])) {
         i++;
       }
       continue;
@@ -492,8 +585,167 @@ Results: ${data.links.length} of ${data.total} matches
   console.log();
 }
 
-// src/commands/trash.ts
+// src/commands/subscriptions.ts
+var HELP = `shiori subscriptions - Manage RSS subscriptions
+
+Usage: shiori subscriptions <subcommand> [options]
+
+Subcommands:
+  list                   List your subscriptions
+  add <url>              Subscribe to an RSS feed
+  remove <id>            Remove a subscription
+  sync <id>              Sync a subscription now
+
+Options:
+  --json                 Output raw JSON
+  --help, -h             Show this help
+
+Examples:
+  shiori subscriptions list
+  shiori subscriptions add https://example.com/feed.xml
+  shiori subscriptions add https://example.com --sync
+  shiori subscriptions remove <id>
+  shiori subscriptions sync <id> --limit 5`;
 async function run9(args) {
+  if (hasFlag(args, "--help", "-h") && !args[0]) {
+    console.log(HELP);
+    return;
+  }
+  const subcommand = args[0];
+  const subArgs = args.slice(1);
+  switch (subcommand) {
+    case "list":
+    case "ls":
+      return listSubscriptions(subArgs);
+    case "add":
+      return addSubscription(subArgs);
+    case "remove":
+    case "rm":
+      return removeSubscription(subArgs);
+    case "sync":
+      return syncSubscription(subArgs);
+    default:
+      if (subcommand) {
+        console.error(`Unknown subcommand: ${subcommand}
+`);
+      }
+      console.log(HELP);
+      if (subcommand) process.exit(1);
+  }
+}
+async function listSubscriptions(args) {
+  if (hasFlag(args, "--help", "-h")) {
+    console.log(`shiori subscriptions list - List your RSS subscriptions
+
+Usage: shiori subscriptions list [options]
+
+Options:
+  --json        Output raw JSON
+  --help, -h    Show this help`);
+    return;
+  }
+  const { data } = await api("GET", "/api/subscriptions/");
+  if (hasFlag(args, "--json")) {
+    console.log(JSON.stringify(data, null, 2));
+    return;
+  }
+  const subs = data.subscriptions;
+  if (subs.length === 0) {
+    console.log("\n  No subscriptions. Add one with: shiori subscriptions add <url>\n");
+    return;
+  }
+  console.log(`
+Subscriptions: ${subs.length}
+`);
+  for (const sub of subs) {
+    const title = truncate(sub.title || sub.feed_url, 50);
+    const synced = sub.last_synced_at ? `synced ${formatDate(sub.last_synced_at)}` : "never synced";
+    console.log(`  ${sub.id}  ${title}  ${synced}`);
+  }
+  console.log();
+}
+async function addSubscription(args) {
+  if (hasFlag(args, "--help", "-h")) {
+    console.log(`shiori subscriptions add - Subscribe to an RSS feed
+
+Usage: shiori subscriptions add <url> [options]
+
+Options:
+  --sync        Sync the 3 most recent items immediately
+  --json        Output raw JSON
+  --help, -h    Show this help`);
+    return;
+  }
+  const url = getPositional(args);
+  if (!url) {
+    console.error("Usage: shiori subscriptions add <url>");
+    process.exit(1);
+  }
+  const body = { feedUrl: url };
+  if (hasFlag(args, "--sync")) {
+    body.initialSync = true;
+  }
+  const { data } = await api("POST", "/api/subscriptions/", body);
+  if (hasFlag(args, "--json")) {
+    console.log(JSON.stringify(data, null, 2));
+    return;
+  }
+  const sub = data.subscription;
+  console.log(`Subscribed: ${sub.title || sub.feed_url} (${sub.id})`);
+}
+async function removeSubscription(args) {
+  if (hasFlag(args, "--help", "-h")) {
+    console.log(`shiori subscriptions remove - Remove a subscription
+
+Usage: shiori subscriptions remove <id> [options]
+
+Options:
+  --json        Output raw JSON
+  --help, -h    Show this help`);
+    return;
+  }
+  const id = getPositional(args);
+  if (!id) {
+    console.error("Usage: shiori subscriptions remove <id>");
+    process.exit(1);
+  }
+  const { data } = await api("DELETE", `/api/subscriptions/${id}`);
+  if (hasFlag(args, "--json")) {
+    console.log(JSON.stringify(data, null, 2));
+    return;
+  }
+  console.log("Subscription removed.");
+}
+async function syncSubscription(args) {
+  if (hasFlag(args, "--help", "-h")) {
+    console.log(`shiori subscriptions sync - Sync a subscription now
+
+Usage: shiori subscriptions sync <id> [options]
+
+Options:
+  --limit <n>   Max items to sync (1-100)
+  --json        Output raw JSON
+  --help, -h    Show this help`);
+    return;
+  }
+  const id = getPositional(args);
+  if (!id) {
+    console.error("Usage: shiori subscriptions sync <id>");
+    process.exit(1);
+  }
+  const body = {};
+  const limit = getFlag(args, "--limit");
+  if (limit) body.limit = Number(limit);
+  const { data } = await api("POST", `/api/subscriptions/sync/${id}`, body);
+  if (hasFlag(args, "--json")) {
+    console.log(JSON.stringify(data, null, 2));
+    return;
+  }
+  console.log(`Synced: ${data.newItems} new, ${data.skipped} skipped, ${data.errors} errors`);
+}
+
+// src/commands/trash.ts
+async function run10(args) {
   if (hasFlag(args, "--help", "-h")) {
     console.log(`shiori trash - List or empty the trash
 
@@ -544,7 +796,7 @@ Trashed links: ${data.links.length} of ${data.total} total
 }
 
 // src/commands/update.ts
-async function run10(args) {
+async function run11(args) {
   if (hasFlag(args, "--help", "-h")) {
     console.log(`shiori update - Update a link
 
@@ -602,7 +854,7 @@ function reportError(command, error) {
     method: "POST",
     headers: { "Content-Type": "application/json" },
     body: JSON.stringify({
-      version: "0.2.3",
+      version: "0.4.0",
       command,
       error: message,
       platform: process.platform
@@ -642,15 +894,16 @@ async function checkForUpdate(currentVersion, isJson) {
 
 // src/index.ts
 var COMMANDS = {
-  auth: { run, desc: "Authenticate with your Shiori API key" },
+  auth: { run, desc: "Authenticate with Shiori (browser or API key)" },
   list: { run: run5, desc: "List saved links" },
   search: { run: run8, desc: "Search saved links" },
   get: { run: run4, desc: "Get a link by ID (includes content)" },
   content: { run: run2, desc: "Print link content as markdown" },
   save: { run: run7, desc: "Save a new link" },
-  update: { run: run10, desc: "Update a link" },
+  update: { run: run11, desc: "Update a link" },
   delete: { run: run3, desc: "Delete a link (move to trash)" },
-  trash: { run: run9, desc: "List or empty the trash" },
+  trash: { run: run10, desc: "List or empty the trash" },
+  subscriptions: { run: run9, desc: "Manage RSS subscriptions" },
   me: { run: run6, desc: "Show current user info" }
 };
 function printHelp() {
@@ -666,7 +919,7 @@ Options:
   --version, -v    Show version
 
 Get started:
-  shiori auth            Authenticate with your API key
+  shiori auth            Sign in via your browser
   shiori list            List your recent links
   shiori save <url>      Save a new link
   shiori search <query>  Search your links
@@ -680,7 +933,7 @@ async function main() {
     return;
   }
   if (command === "--version" || command === "-v") {
-    console.log("0.2.3");
+    console.log("0.4.0");
     return;
   }
   const cmd = COMMANDS[command];
@@ -693,7 +946,7 @@ async function main() {
   const cmdArgs = args.slice(1);
   const isJson = cmdArgs.includes("--json");
   await cmd.run(cmdArgs);
-  checkForUpdate("0.2.3", isJson).catch(() => {
+  checkForUpdate("0.4.0", isJson).catch(() => {
   });
 }
 main().catch((err) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shiori-sh/cli",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "description": "CLI for managing your Shiori link library",
   "author": "Brian Lovin",
   "license": "MIT",