@tenyokjs/devdevian-cli 0.0.0-stage → 0.1.0-alpha.1

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# Devdevian CLI · Alpha
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+An official terminal client for [Devdevian](https://devdevian.vercel.app), the open-source developer forum. Use the same account, discussions and community permissions as the web app. Requires **Node.js 24 or newer**.
+
+```sh
+npm install -g @tenyokjs/devdevian-cli@alpha
+devdevian login
+devdevian
+```
+
+Login opens a browser. Compare the code shown in the terminal, sign in to Devdevian, then authorize the terminal. Google, GitHub and email login happen on the website; no provider credentials are collected by this package. Use `--no-open` to open the printed address yourself, including when connecting over SSH.
+
+## Everyday commands
+
+```sh
+devdevian whoami
+devdevian inbox --page 1
+devdevian feed --topic web
+devdevian search "bounded retries"
+devdevian conversation open 142
+devdevian ask --title "How should I retry requests?" --body-file question.md --topic web
+devdevian reply 142 --editor
+devdevian review create --file src/retry.ts --lines 20:65 --title "Review my retry strategy" --focus "Timeouts, retries and idempotency" --editor
+devdevian review list 142 --status open
+devdevian review comment 142 --start-line 2 --end-line 4 --body "Handle the timeout here."
+devdevian review thread 142 12
+devdevian review reply 142 12 --body "Would a deadline address this?"
+devdevian review resolve 142 12
+devdevian review reopen 142 12
+devdevian communities
+devdevian logout
+```
+
+Commands are examples; replace IDs, file paths and topic IDs with your own. Run `devdevian --help` for flags. Selected file ranges are published as standalone snippets; subsequent review line numbers refer to that published snippet, beginning at 1.
+
+A selected file is read only when explicitly named. Before publication, the client previews the payload and audience and asks for confirmation. Use `--community ID` for an approved private community, `--json` for machine-readable API output and `--yes` to explicitly publish without a prompt. Noninteractive publishing requires the relevant text flags and `--yes`. No repository discovery or background file collection runs.
+
+`--editor` uses `$VISUAL`, then `$EDITOR`, then `vi` (`notepad` on Windows). The editor is launched without a shell. File, body and API limits also apply in the terminal. This client uses ordinary HTTPS API calls, not a direct database connection, and sends no background polling traffic when idle. Device login polls every five seconds for at most ten minutes.
+
+## Connected devices and credentials
+
+Access expires after 30 days. Revoke a terminal from **Settings → Connected terminals** or run `devdevian logout`. Password reset revokes CLI sessions alongside browser sessions. Terminal authorization requests approved before a password change cannot mint a new session afterwards.
+
+The credential file is `~/.config/devdevian/credentials.json`, with mode `0600` and a new directory with mode `0700` on Unix. This alpha uses a local token file rather than an OS keychain. On Windows, protect your user profile with appropriate account permissions; Unix permission bits are not equivalent to Windows ACLs. Do not share or commit the credential file. Tokens are never printed by login, including with `--json`.
+
+For local development use `devdevian login --host http://127.0.0.1:4173`. Remote origins require HTTPS. Credentials stay bound to the selected origin; a different `--host` cannot reuse them. HTTP redirects are rejected instead of forwarding credentials. `DEVDEVIAN_CONFIG_DIR` overrides the local credentials directory for isolated testing. `NO_COLOR=1` disables terminal accents.
+
+## Alpha scope
+
+This first release covers login/logout, inbox, paginated feeds and search, discussions and replies, questions, code review creation, line feedback and feedback threads/status, and community discovery/private publication. Profile/media editing, events administration and moderation remain available in the browser. There is no offline mode or automatic GitHub repository synchronization.
+
+Source, contributions and issue reporting: [Tenyokj/devdevian](https://github.com/Tenyokj/devdevian). Report security issues through the repository's [security policy](https://github.com/Tenyokj/devdevian/blob/main/SECURITY.md), not a public issue containing private data. Licensed GPL-3.0-only.

package/bin/devdevian.mjs

@@ -0,0 +1,525 @@
+#!/usr/bin/env node
+import { parseArgs } from "node:util";
+import { readFile, writeFile, mkdtemp, rm } from "node:fs/promises";
+import { hostname, tmpdir } from "node:os";
+import { join } from "node:path";
+import { spawn, spawnSync } from "node:child_process";
+import { createInterface } from "node:readline/promises";
+import { setTimeout as delay } from "node:timers/promises";
+import {
+  client,
+  originOf,
+  loadConfig,
+  saveConfig,
+  removeConfig,
+  clean,
+} from "../lib/client.mjs";
+const version = "0.1.0-alpha.1";
+const options = {
+  host: { type: "string" },
+  page: { type: "string" },
+  topic: { type: "string" },
+  community: { type: "string" },
+  title: { type: "string" },
+  body: { type: "string" },
+  "body-file": { type: "string" },
+  file: { type: "string" },
+  lines: { type: "string" },
+  focus: { type: "string" },
+  "start-line": { type: "string" },
+  "end-line": { type: "string" },
+  status: { type: "string" },
+  revision: { type: "string" },
+  "reply-id": { type: "string" },
+  name: { type: "string" },
+  yes: { type: "boolean" },
+  json: { type: "boolean" },
+  editor: { type: "boolean" },
+  "no-open": { type: "boolean" },
+  help: { type: "boolean", short: "h" },
+  version: { type: "boolean", short: "v" },
+};
+let terminal;
+const prompt = async (question, fallback = "") => {
+  if (!process.stdin.isTTY)
+    throw Error(
+      "Interactive input needs a terminal. Provide command flags instead.",
+    );
+  terminal ??= createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  const answer = await terminal.question(
+    question + (fallback ? ` [${fallback}]` : "") + ": ",
+  );
+  return answer.trim() || fallback;
+};
+const out = (value) => {
+  const text = clean(value);
+  process.stdout.write(
+    (process.stdout.isTTY &&
+    !process.env.NO_COLOR &&
+    /^(DEVDEVIAN|Devdevian ·|Publication preview)/.test(text.trimStart())
+      ? "\x1b[38;5;141m" + text + "\x1b[0m"
+      : text) + "\n",
+  );
+};
+const positive = (value, label = "ID") => {
+  if (!/^[1-9]\d*$/.test(String(value)) || !Number.isSafeInteger(Number(value)))
+    throw Error(label + " must be a positive integer.");
+  return Number(value);
+};
+const help = `Devdevian CLI ${version} · alpha
+
+  devdevian                       Interactive menu
+  devdevian login                 Authorize in your browser
+  devdevian logout                Revoke this terminal
+  devdevian whoami
+  devdevian inbox [--page 2]
+  devdevian feed [--topic web] [--page 2]
+  devdevian search "retry strategies"
+  devdevian conversation open POST_ID
+  devdevian ask --title "..." --body-file question.md --topic web
+  devdevian reply POST_ID --body "..." [--editor]
+  devdevian review create --file src/retry.ts --lines 20:65 --title "..." --focus "..."
+  devdevian review list POST_ID [--status open]
+  devdevian review comment POST_ID --start-line 2 --end-line 4 --body "..."
+  devdevian review thread POST_ID REVIEW_ID [--page 2]
+  devdevian review reply POST_ID REVIEW_ID --body "..."
+  devdevian review resolve POST_ID REVIEW_ID
+  devdevian review reopen POST_ID REVIEW_ID
+  devdevian communities [--page 2]
+
+  --community ID     Publish to an approved private community
+  --editor           Write text in $VISUAL / $EDITOR
+  --json             Machine-readable output
+  --yes              Explicitly publish without an interactive confirmation
+  --host ORIGIN      Select server when logging in (HTTPS; loopback HTTP for development)
+
+Only files you explicitly select are read. Code/text is previewed before publishing.
+Credentials are stored locally with restricted file permissions; revoke access in Settings.
+`;
+async function editor(initial = "") {
+  if (!process.stdin.isTTY || !process.stdout.isTTY)
+    throw Error("--editor needs an interactive terminal.");
+  terminal?.pause();
+  const directory = await mkdtemp(join(tmpdir(), "devdevian-editor-")),
+    file = join(directory, "message.md");
+  try {
+    await writeFile(file, initial, { mode: 0o600 });
+    const command =
+      process.env.VISUAL ||
+      process.env.EDITOR ||
+      (process.platform === "win32" ? "notepad" : "vi");
+    // No shell: metacharacters in content or filenames cannot become commands.
+    const parts =
+      command
+        .match(/(?:[^\s"']+|"[^"]*"|'[^']*')+/g)
+        ?.map((p) => p.replace(/^(['"])(.*)\1$/, "$2")) || [];
+    if (!parts.length) throw Error("Set EDITOR to your text editor.");
+    const result = spawnSync(parts[0], [...parts.slice(1), file], {
+      stdio: "inherit",
+      shell: false,
+    });
+    if (result.error || result.status !== 0)
+      throw Error("The editor did not finish successfully.");
+    return await readFile(file, "utf8");
+  } finally {
+    terminal?.resume();
+    await rm(directory, { recursive: true, force: true });
+  }
+}
+async function boundedFile(file, max) {
+  const data = await readFile(file);
+  if (data.length > max * 4)
+    throw Error(`File is too large (limit ${max} characters).`);
+  const text = data.toString("utf8");
+  if (text.includes("\u0000") || text.includes("\ufffd") || text.length > max)
+    throw Error(`Choose a UTF-8 text file with at most ${max} characters.`);
+  return text;
+}
+async function message(flags, initial = "") {
+  if (flags["body-file"]) return boundedFile(flags["body-file"], 15000);
+  if (flags.editor || (!flags.body && process.stdin.isTTY))
+    return editor(flags.body || initial);
+  if (!flags.body) throw Error("Provide --body, --body-file, or --editor.");
+  return flags.body;
+}
+function show(data, json, kind = "posts") {
+  if (json) {
+    process.stdout.write(JSON.stringify(data) + "\n");
+    return;
+  }
+  const items = data.items || data;
+  if (Array.isArray(items)) {
+    if (!items.length) out("Nothing here yet.");
+    for (const item of items) {
+      if (kind === "inbox")
+        out(
+          `${item.read_at ? " " : "●"} #${item.id} ${item.actor_name} · ${item.type}\n  ${item.post_title || ""}\n  ${item.post_id ? "Post " + item.post_id : ""}${item.code_review_id ? " · review " + item.code_review_id : ""}${item.feedback_reply_id ? " · reply " + item.feedback_reply_id : ""}`,
+        );
+      else if (kind === "reviews")
+        out(
+          `#${item.id} · ${item.resolved ? "resolved" : "open"} · lines ${item.start_line}–${item.end_line}${item.outdated ? " · earlier snippet" : ""}\n${item.deleted_at ? "[deleted]" : item.body}\n${item.quote || ""}`,
+        );
+      else if (kind === "replies")
+        out(
+          `#${item.id} · ${item.name || ""}\n${item.deleted_at ? "[deleted]" : item.body}`,
+        );
+      else
+        out(
+          `#${item.id} ${item.title || item.name || ""}${item.kind ? " · " + item.kind : ""}${item.topic ? " · #" + item.topic : ""}`,
+        );
+    }
+    if (data.pagination)
+      out(
+        `Page ${data.pagination.page}/${data.pagination.pages || 1} · ${data.pagination.total} results`,
+      );
+  } else if (data.title) {
+    out(`#${data.id} · ${data.kind}\n${data.title}\n\n${data.body}`);
+    if (data.code) out("\nCode:\n" + data.code);
+  } else out(JSON.stringify(data, null, 2));
+}
+async function confirm(payload, flags) {
+  if (flags.yes) return;
+  out("\nPublication preview");
+  out(JSON.stringify(payload, null, 2));
+  out(
+    "Audience: " +
+      (payload.community_id
+        ? "private community " + payload.community_id
+        : "PUBLIC feed"),
+  );
+  if (
+    (await prompt("Publish this content? (yes/no)", "no")).toLowerCase() !==
+    "yes"
+  )
+    throw Error("Cancelled. Nothing was published.");
+}
+function openBrowser(url) {
+  const args =
+    process.platform === "darwin"
+      ? ["open", [url]]
+      : process.platform === "win32"
+        ? ["rundll32", ["url.dll,FileProtocolHandler", url]]
+        : ["xdg-open", [url]];
+  const child = spawn(args[0], args[1], {
+    stdio: "ignore",
+    detached: true,
+    shell: false,
+  });
+  child.on("error", () => {});
+  child.unref();
+}
+async function login(flags) {
+  const origin = originOf(flags.host || "https://devdevian.vercel.app"),
+    api = client(origin);
+  const device = await api("/cli/device", {
+    method: "POST",
+    body: { name: flags.name || `Devdevian CLI · ${hostname()}` },
+  });
+  if (new URL(device.verification_uri).origin !== origin)
+    throw Error("The server returned an unexpected authorization address.");
+  out(
+    `Open ${device.verification_uri}\nConfirm code: ${device.user_code}\nWaiting for browser approval…`,
+  );
+  if (!flags["no-open"]) openBrowser(device.verification_uri);
+  const until = Date.now() + Math.min(device.expires_in, 600) * 1000;
+  while (Date.now() < until) {
+    await delay(Math.max(5, Number(device.interval) || 5) * 1000);
+    const result = await api("/cli/token", {
+      method: "POST",
+      body: { device_code: device.device_code },
+    });
+    if (result.pending) continue;
+    await saveConfig({
+      origin,
+      token: result.access_token,
+      expires_at: result.expires_at,
+    });
+    out("Connected. Run devdevian to open your workspace.");
+    return;
+  }
+  throw Error("Login expired. Run devdevian login again.");
+}
+async function execute(args, flags) {
+  if (flags.help) {
+    out(help);
+    return;
+  }
+  if (flags.version) {
+    out(version);
+    return;
+  }
+  const command = args[0];
+  if (command === "login") return login(flags);
+  const config = await loadConfig();
+  if (!config) throw Error("Sign in first: devdevian login");
+  if (flags.host && originOf(flags.host) !== config.origin)
+    throw Error(
+      "Saved credentials belong to a different server. Run login --host for that server.",
+    );
+  const api = client(config.origin, config.token),
+    page = positive(flags.page || "1", "Page");
+  if (command === "logout") {
+    try {
+      await api("/cli/logout", { method: "POST", body: {} });
+    } catch (e) {
+      if (e.status !== 401) throw e;
+    }
+    await removeConfig();
+    out("This terminal has been disconnected.");
+    return;
+  }
+  if (command === "whoami") {
+    const data = await api("/me");
+    show(
+      flags.json
+        ? data
+        : {
+            account: "@" + data.user.username,
+            name: data.user.name,
+            server: config.origin,
+          },
+      flags.json,
+    );
+    return;
+  }
+  if (command === "inbox") {
+    show(await api("/notifications?page=" + page), flags.json, "inbox");
+    return;
+  }
+  if (command === "feed") {
+    const query = new URLSearchParams({
+      page: String(page),
+      limit: "12",
+      ...(flags.topic ? { topic: flags.topic } : {}),
+    });
+    show(await api("/posts?" + query), flags.json);
+    return;
+  }
+  if (command === "communities") {
+    show(await api("/communities?page=" + page + "&limit=12"), flags.json);
+    return;
+  }
+  if (command === "search") {
+    const query = args.slice(1).join(" ") || (await prompt("Search"));
+    show(
+      await api("/search?q=" + encodeURIComponent(query) + "&page=" + page),
+      flags.json,
+    );
+    return;
+  }
+  if (command === "conversation" && args[1] === "open") {
+    const id = positive(args[2]);
+    show(await api("/posts/" + id), flags.json);
+    if (!flags.json) {
+      out("\nReplies:");
+      show(await api(`/posts/${id}/replies?page=${page}`), false, "replies");
+    }
+    return;
+  }
+  if (command === "ask" || (command === "review" && args[1] === "create")) {
+    const review = command === "review";
+    let code = "";
+    if (review) {
+      const file = flags.file || (await prompt("Code file"));
+      code = await boundedFile(file, 20000);
+      if (flags.lines) {
+        const m = flags.lines.match(/^(\d+):(\d+)$/);
+        if (!m) throw Error("Use --lines START:END.");
+        const lines = code.split("\n"),
+          start = positive(m[1]),
+          end = positive(m[2]);
+        if (end < start || end > lines.length)
+          throw Error("The selected range is outside the file.");
+        code = lines.slice(start - 1, end).join("\n");
+      }
+    }
+    const payload = {
+      kind: review ? "review" : "question",
+      topic: flags.topic || (await prompt("Topic ID", "web")),
+      title: flags.title || (await prompt("Title")),
+      body: await message(
+        flags,
+        review
+          ? "Explain what the code does and the help you need."
+          : "Describe the problem, expected behavior, and what you tried.",
+      ),
+      ...(flags.community ? { community_id: flags.community } : {}),
+    };
+    if (review) {
+      payload.code = code;
+      payload.review_focus =
+        flags.focus || (await prompt("What should reviewers focus on?"));
+    }
+    await confirm(payload, flags);
+    const result = await api("/posts", { method: "POST", body: payload });
+    show(result, flags.json);
+    if (!flags.json) out(config.origin + "/app#post/" + result.id);
+    return;
+  }
+  if (command === "reply") {
+    const id = positive(args[1]),
+      body = await message(flags);
+    const parent = await api("/posts/" + id);
+    await confirm(
+      { post_id: id, community_id: parent.community_id || null, body },
+      flags,
+    );
+    show(
+      await api(`/posts/${id}/replies`, { method: "POST", body: { body } }),
+      flags.json,
+    );
+    return;
+  }
+  if (command === "review") {
+    const action = args[1],
+      post = positive(args[2]);
+    if (action === "list") {
+      show(
+        await api(
+          `/posts/${post}/code-reviews?page=${page}${flags.status ? "&status=" + encodeURIComponent(flags.status) : ""}`,
+        ),
+        flags.json,
+        "reviews",
+      );
+      return;
+    }
+    if (action === "comment") {
+      const current = await api(`/posts/${post}/code-reviews`),
+        payload = {
+          body: await message(flags),
+          start_line: positive(flags["start-line"], "Start line"),
+          end_line: positive(
+            flags["end-line"] || flags["start-line"],
+            "End line",
+          ),
+          snippet_hash: current.snippet_hash,
+        };
+      const parent = await api("/posts/" + post);
+      await confirm(
+        {
+          post_id: post,
+          community_id: parent.community_id || null,
+          ...payload,
+        },
+        flags,
+      );
+      show(
+        await api(`/posts/${post}/code-reviews`, {
+          method: "POST",
+          body: payload,
+        }),
+        flags.json,
+      );
+      return;
+    }
+    const id = positive(args[3]),
+      url = `/posts/${post}/code-reviews/${id}`;
+    if (action === "thread") {
+      show(await api(url + "/replies?page=" + page), flags.json, "replies");
+      return;
+    }
+    if (action === "reply") {
+      const body = await message(flags);
+      const parent = await api("/posts/" + post);
+      await confirm(
+        {
+          post_id: post,
+          community_id: parent.community_id || null,
+          review_id: id,
+          body,
+        },
+        flags,
+      );
+      show(
+        await api(url + "/replies", { method: "POST", body: { body } }),
+        flags.json,
+      );
+      return;
+    }
+    if (["resolve", "reopen"].includes(action)) {
+      const data = await api(`/posts/${post}/code-reviews?target_id=${id}`),
+        item = data.items.find((c) => c.id === id);
+      if (!item) throw Error("Feedback not found.");
+      show(
+        await api(url, {
+          method: "PATCH",
+          body: { revision: item.revision, resolved: action === "resolve" },
+        }),
+        flags.json,
+      );
+      return;
+    }
+  }
+  throw Error("Unknown command. Run devdevian --help.");
+}
+async function menu(flags) {
+  const config = await loadConfig();
+  if (!config) {
+    out("Devdevian · developer commons");
+    if (
+      (await prompt("Connect your account? (yes/no)", "yes")).toLowerCase() !==
+      "yes"
+    )
+      return;
+    await login(flags);
+  }
+  const identityConfig = await loadConfig(),
+    identity = await client(identityConfig.origin, identityConfig.token)("/me");
+  while (true) {
+    out(
+      `\nDEVDEVIAN · @${identity.user.username}\n  1  Inbox\n  2  Public feed\n  3  Open conversation\n  4  Ask a question\n  5  Request code review\n  6  Communities\n  7  Review feedback\n  8  Search\n  9  Reply to a conversation\n  0  Exit`,
+    );
+    const choice = await prompt("Choose", "0");
+    if (choice === "0") return;
+    try {
+      if (choice === "1") await execute(["inbox"], flags);
+      else if (choice === "2") await execute(["feed"], flags);
+      else if (choice === "3")
+        await execute(["conversation", "open", await prompt("Post ID")], flags);
+      else if (choice === "4") await execute(["ask"], flags);
+      else if (choice === "5") await execute(["review", "create"], flags);
+      else if (choice === "6") await execute(["communities"], flags);
+      else if (choice === "7") {
+        const post = await prompt("Review post ID");
+        await execute(["review", "list", post], flags);
+        const action = await prompt(
+          "Action: thread / comment / reply / resolve / reopen / back",
+          "back",
+        );
+        if (action !== "back") {
+          const id = action === "comment" ? null : await prompt("Feedback ID");
+          const next = { ...flags };
+          if (action === "comment") {
+            next["start-line"] = await prompt("Start line");
+            next["end-line"] = await prompt("End line", next["start-line"]);
+          }
+          await execute(["review", action, post, ...(id ? [id] : [])], next);
+        }
+      } else if (choice === "9")
+        await execute(["reply", await prompt("Post ID")], flags);
+      else if (choice === "8")
+        await execute(["search", await prompt("Search")], flags);
+      else out("Choose one of the listed actions.");
+    } catch (e) {
+      out("Error: " + e.message);
+    }
+  }
+}
+try {
+  const { values, positionals } = parseArgs({
+    options,
+    allowPositionals: true,
+    strict: true,
+  });
+  if (!positionals.length && !values.help && !values.version)
+    await menu(values);
+  else await execute(positionals, values);
+} catch (e) {
+  process.stderr.write("Devdevian: " + clean(e.message) + "\n");
+  process.exitCode = 1;
+} finally {
+  terminal?.close();
+}