@evanbobo/colco 0.12.0 → 0.18.0

package/README.md

@@ -59,6 +59,20 @@ How the numbers are counted:
 Token fields: `input` excludes cache reads and writes, `output` includes reasoning, and `total` is input,
 output, cache read and cache write added together.
 
+## Finding the project for a code directory
+
+```bash
+colco project          # projects that use this directory's repository; * marks the current branch
+colco project --json   # the same as JSON
+```
+
+The command reads the directory's git remote (`origin`, or the first remote when there is no origin) and
+the current branch, removes any user name, password or token from the remote, and asks Colco which of your
+projects use that repository. Projects that use the current branch come first. Repositories belong to the
+whole organization, so one repository can serve several projects, each on its own branch. A project owner
+links them on the project's 仓库 tab or with `link_repository`. When nothing matches, the command says so
+and points to `list_projects`.
+
 ## Other commands
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanbobo/colco",
-  "version": "0.12.0",
+  "version": "0.18.0",
   "description": "Colco (叩叩) collaboration skill for coding agents, with per-task model and token reporting from local session logs",
   "type": "module",
   "bin": {

package/src/cli.mjs

@@ -5,6 +5,7 @@ import { callTool, ColcoError, VERSION } from "./api.mjs";
 import { configPath, normaliseServer, readConfig, resolveConnection, TOKEN_ENV, writeConfig } from "./config.mjs";
 import { homeDir } from "./home.mjs";
 import { applyInstall, applyRemove, inspect, planInstall } from "./install.mjs";
+import { project, runGit } from "./project.mjs";
 import { cliConfirmation, readMarkers, recordMarker, TASK_STATUSES } from "./usage/markers.mjs";
 import { buildReports, sendReports, totalTokens } from "./usage/report.mjs";
 import { ask, askSecret, choose, multiSelect } from "./prompt.mjs";
@@ -13,7 +14,7 @@ import { ask, askSecret, choose, multiSelect } from "./prompt.mjs";
  * The colco command. `add`, `list` and `remove` manage the skill for the chosen agents; `task start|done`
  * move a task, record where it starts or ends in Colco's marker file and, on done, report the session's
  * usage; `report` reports (or previews) without moving anything; `call` runs any Colco tool with the saved
- * API key.
+ * API key; `project` finds the projects that use this directory's git repository.
  */
 
 const HELP = `colco ${VERSION} — Colco（叩叩）协作的 Agent Skill 与用量上报
@@ -30,6 +31,7 @@ const HELP = `colco ${VERSION} — Colco（叩叩）协作的 Agent Skill 与用
   colco report [--task <id>] [--dry-run] [--agent <name> --session <id>]
                                 重新统计本会话并上报；--dry-run 只预览
   colco call <tool> ['<json>']  用已保存的 API Key 调用任意 Colco 工具
+  colco project [--json]        按当前目录的 git 远程地址和分支找到对应的 Colco 项目
   colco whoami                  检查连接
 
 选项:
@@ -38,6 +40,7 @@ const HELP = `colco ${VERSION} — Colco（叩叩）协作的 Agent Skill 与用
   --copy               复制文件而不是创建链接
   -y, --yes            不提问，使用默认值
   --server <url>       Colco 服务地址（也可设置 COLCO_SERVER）
+  --json               colco project 以 JSON 输出
   API Key 读取 ${TOKEN_ENV}，或 colco add 时保存在 ~/.colco/config.json（仅本人可读）。`;
 
 /** Splits argv into positionals and flags; repeated flags collect into arrays. */
@@ -45,7 +48,7 @@ export function parseArgs(argv) {
   const positionals = [];
   const flags = { agent: [] };
   const valued = new Map([["-a", "agent"], ["--agent", "agent"], ["--server", "server"], ["--task", "task"], ["--session", "session"], ["--status", "status"]]);
-  const booleans = new Map([["-p", "project"], ["--project", "project"], ["-g", "global"], ["--global", "global"], ["--copy", "copy"], ["-y", "yes"], ["--yes", "yes"], ["--force", "force"], ["--dry-run", "dryRun"], ["-h", "help"], ["--help", "help"], ["-v", "version"], ["--version", "version"]]);
+  const booleans = new Map([["-p", "project"], ["--project", "project"], ["-g", "global"], ["--global", "global"], ["--copy", "copy"], ["-y", "yes"], ["--yes", "yes"], ["--force", "force"], ["--dry-run", "dryRun"], ["--json", "json"], ["-h", "help"], ["--help", "help"], ["-v", "version"], ["--version", "version"]]);
   for (let index = 0; index < argv.length; index += 1) {
     const arg = argv[index];
     const [name, inline] = arg.startsWith("--") && arg.includes("=") ? [arg.slice(0, arg.indexOf("=")), arg.slice(arg.indexOf("=") + 1)] : [arg, undefined];
@@ -236,12 +239,13 @@ async function task(positionals, flags, io) {
   return report(flags, io, { found });
 }
 
-/** Runs the CLI; returns the exit code. `io` carries output and the fetch used for every request. */
+/** Runs the CLI; returns the exit code. `io` carries output, the fetch used for every request and the git runner. */
 export async function main(argv, output = {}) {
   const io = {
     out: (line) => process.stdout.write(`${line}\n`),
     err: (line) => process.stderr.write(`${line}\n`),
     fetch: (...args) => fetch(...args),
+    git: runGit,
     ...output,
   };
   try {
@@ -268,6 +272,8 @@ export async function main(argv, output = {}) {
         return await task(rest, flags, io);
       case "report":
         return await report(flags, io, { onlyTask: flags.task === undefined ? null : taskIdOf(flags.task) });
+      case "project":
+        return await project(flags, io, resolveConnection());
       case "whoami": {
         const me = await callTool(resolveConnection(), "whoami", {}, io.fetch);
         io.out(`${me.displayName || me.username}（${me.username}）`);

package/src/project.mjs

@@ -0,0 +1,78 @@
+import { execFile } from "node:child_process";
+import { callTool, ColcoError } from "./api.mjs";
+
+/*
+ * `colco project`: which Colco projects use the code in this directory. It reads the git remote (origin,
+ * else the first remote) and the current branch, and asks Colco's find_projects_by_repository. Git runs
+ * through execFile with an argument list, never a shell, so nothing in a remote or branch name is executed.
+ */
+
+const NOT_A_REPOSITORY = "当前目录不是 git 仓库：请在代码目录中运行 colco project";
+
+/** Runs git with `args` in the current directory; resolves trimmed stdout, rejects with git's error. */
+export function runGit(args) {
+  return new Promise((resolve, reject) => {
+    execFile("git", args, { encoding: "utf8", timeout: 10_000, maxBuffer: 1024 * 1024, windowsHide: true }, (error, stdout) => {
+      if (error) reject(error);
+      else resolve(String(stdout).trim());
+    });
+  });
+}
+
+/**
+ * Removes `user:password@`, query and fragment from a URL-style remote, so no credential leaves the machine or
+ * reaches the screen. scp-style remotes (`git@host:path`) are left as they are; their user is not a secret.
+ */
+export function stripCredentials(remote) {
+  if (!/^[a-z][a-z0-9+.-]*:\/\//i.test(remote)) return remote;
+  return remote.replace(/^([a-z][a-z0-9+.-]*:\/\/)[^/]*@/i, "$1").replace(/[?#].*$/, "");
+}
+
+/** The directory's remote URL and current branch (null when HEAD is detached or has no commit yet). */
+export async function readGitContext(git) {
+  let inside;
+  try {
+    inside = await git(["rev-parse", "--is-inside-work-tree"]);
+  } catch (error) {
+    if (error?.code === "ENOENT") throw new ColcoError("没有找到 git 命令：请先安装 git");
+    throw new ColcoError(NOT_A_REPOSITORY);
+  }
+  if (inside !== "true") throw new ColcoError(NOT_A_REPOSITORY);
+  let remote = await git(["remote", "get-url", "origin"]).catch(() => "");
+  if (!remote) {
+    const [first] = (await git(["remote"]).catch(() => "")).split("\n").map((name) => name.trim()).filter(Boolean);
+    if (first) remote = await git(["remote", "get-url", "--", first]).catch(() => "");
+  }
+  if (!remote) throw new ColcoError("这个 git 仓库还没有远程地址（git remote），Colco 无法据此找到项目");
+  const head = await git(["rev-parse", "--abbrev-ref", "HEAD"]).catch(() => "");
+  return { remote: stripCredentials(remote), branch: head && head !== "HEAD" ? head : null };
+}
+
+/** Prints the projects that use this directory's repository, or why there are none; `--json` prints the data. */
+export async function project(flags, io, connection) {
+  const { remote, branch } = await readGitContext(io.git);
+  const data = await callTool(connection, "find_projects_by_repository", { url: remote, ...(branch ? { branch } : {}) }, io.fetch);
+  if (flags.json) {
+    io.out(JSON.stringify({ remote, branch, ...data }, null, 2));
+    return 0;
+  }
+  io.out(`仓库：${data.repository?.url ?? remote}${branch ? `（当前分支 ${branch}）` : ""}`);
+  if (!data.repository) {
+    io.out("这个仓库还没有登记到 Colco，没有项目使用它。");
+    io.out("用 colco call list_projects 查看你的项目；项目负责人可以用 link_repository 把仓库关联到项目。");
+    return 0;
+  }
+  if (data.projects.length === 0) {
+    io.out(`仓库「${data.repository.name}」已登记，但你能访问的项目都没有使用它。`);
+    io.out("用 colco call list_projects 查看你的项目。");
+    return 0;
+  }
+  const idWidth = Math.max(...data.projects.map((item) => String(item.projectId).length));
+  const nameWidth = Math.max(...data.projects.map((item) => item.projectName.length));
+  for (const item of data.projects) {
+    const archived = item.projectStatus === "archived" ? "（已归档）" : "";
+    io.out(`${item.branchMatched ? "*" : " "} ${String(item.projectId).padStart(idWidth)}  ${item.projectName.padEnd(nameWidth)}  ${item.branch}${archived}`);
+  }
+  if (data.projects.some((item) => item.branchMatched)) io.out("* 项目使用的就是当前分支");
+  return 0;
+}