kcode-cli 1.3.21 → 1.3.22

package/README.md

@@ -0,0 +1,105 @@
+# KCode CLI
+
+`kcode-cli` 会启动 KCode 的本地服务，并在默认模式下同时提供内置的 Web UI。
+
+## 环境要求
+
+- Node.js `>= 20`
+- 推荐使用 npm 全局安装
+
+## 安装
+
+```bash
+npm install -g kcode-cli
+```
+
+安装完成后可直接使用 `kcode` 命令。
+
+如果只想临时运行一次，也可以使用：
+
+```bash
+npx kcode-cli
+```
+
+## 快速开始
+
+默认模式会同时启动 API 和打包好的 Web UI：
+
+```bash
+kcode
+```
+
+默认监听地址如下：
+
+- Host: `127.0.0.1`
+- Port: `4096`
+- Directory: 当前工作目录
+
+只启动 API 服务时使用：
+
+```bash
+kcode serve
+```
+
+显式指定目录和端口时使用：
+
+```bash
+kcode web --directory E:\\project\\demo --port 4310
+```
+
+## 启动模式
+
+### `kcode web`
+
+- 默认模式
+- 启动 API 服务
+- 暴露内置 Web UI
+
+### `kcode serve`
+
+- 只启动 API 服务
+- 不挂载内置 Web UI
+
+## 常用参数
+
+```text
+Usage: kcode [web|serve] [options]
+
+Options:
+  --hostname <host>    Bind address (default: 127.0.0.1)
+  --port <port>        Bind port (default: 4096)
+  --directory <path>   Override project directory
+  --log-level <level>  Accepted for SDK compatibility
+  -h, --help           Show help
+```
+
+查看帮助：
+
+```bash
+kcode --help
+```
+
+## 默认行为
+
+- 不传子命令时，等价于 `kcode web`
+- `--directory` 未设置时，默认使用当前工作目录
+- `--hostname` 未设置时，默认使用 `127.0.0.1`
+- `--port` 未设置时，默认使用 `4096`
+- 也支持通过环境变量覆盖默认值：
+  - `KCODE_DIRECTORY`
+  - `KCODE_SERVER_HOST`
+  - `KCODE_SERVER_PORT`
+- `--log-level` 仅为 SDK 兼容场景保留，当前不会改变 CLI 的输出行为
+
+## postinstall 说明
+
+安装完成后会执行一个轻量 `postinstall` 脚本：
+
+- 在非 Windows 平台为内置 `ripgrep` 二进制补充可执行权限
+- 在 macOS 上尝试移除隔离属性
+- 该步骤失败不会阻塞安装
+
+## 相关文档
+
+- 仓库内的开发文档入口：`docs/README.md`
+- 仓库内的前端说明：`apps/web/README.md`

package/dist/cli.js

@@ -122659,6 +122659,84 @@ function formatHelp() {
   ].join("\n");
 }
 
+// src/startup-output.ts
+var COLORS = {
+  badge: [213, 162, 106],
+  label: [145, 163, 184],
+  logoAccent: [213, 162, 106],
+  logoStrong: [130, 175, 216],
+  logoWeak: [91, 126, 164],
+  title: [237, 243, 250],
+  value: [157, 193, 231]
+};
+function createAnsiStyle(color, options2 = {}) {
+  const prefixes = [];
+  if (options2.bold) {
+    prefixes.push("\x1B[1m");
+  }
+  if (options2.dim) {
+    prefixes.push("\x1B[2m");
+  }
+  prefixes.push(`\x1B[38;2;${color[0]};${color[1]};${color[2]}m`);
+  return (value) => `${prefixes.join("")}${value}\x1B[0m`;
+}
+function buildPlainLines(input) {
+  const lines = [`KCode [${input.mode}]`, `server: ${input.address}`, `directory: ${input.defaultDirectory}`];
+  if (input.mode === "web") {
+    lines.push(`web: ${input.address}`);
+  }
+  return lines;
+}
+function buildRichLines(input) {
+  const logo = [
+    createAnsiStyle(COLORS.logoStrong, { bold: true })("|\\ ".padEnd(3)),
+    createAnsiStyle(COLORS.logoAccent, { bold: true })("| >"),
+    createAnsiStyle(COLORS.logoWeak, { bold: true })("|/ ".padEnd(3))
+  ];
+  const title = createAnsiStyle(COLORS.title, { bold: true })("KCode");
+  const badge = createAnsiStyle(COLORS.badge, { bold: true })(`[${input.mode}]`);
+  const label = createAnsiStyle(COLORS.label, { dim: true });
+  const value = createAnsiStyle(COLORS.value, { bold: true });
+  const lines = [
+    `${logo[0]}  ${title} ${badge}`,
+    `${logo[1]}  ${label("server".padEnd(9))} ${value(input.address)}`,
+    `${logo[2]}  ${label("directory".padEnd(9))} ${value(input.defaultDirectory)}`
+  ];
+  if (input.mode === "web") {
+    lines.push(`${" ".repeat(5)}${label("web".padEnd(9))} ${value(input.address)}`);
+  }
+  return lines;
+}
+function supportsRichStartupOutput(env = process.env, output2 = process.stdout) {
+  if (output2.isTTY !== true) {
+    return false;
+  }
+  if ((env.TERM ?? "").toLowerCase() === "dumb") {
+    return false;
+  }
+  if ("NO_COLOR" in env) {
+    return false;
+  }
+  if (env.FORCE_COLOR === "0") {
+    return false;
+  }
+  return true;
+}
+function formatPlainStartupOutput(input) {
+  return buildPlainLines(input).join("\n");
+}
+function formatRichStartupOutput(input) {
+  return buildRichLines(input).join("\n");
+}
+function formatStartupOutput(input, options2 = {}) {
+  const env = options2.env ?? process.env;
+  const output2 = { isTTY: options2.isTTY ?? process.stdout.isTTY };
+  if (!supportsRichStartupOutput(env, output2)) {
+    return formatPlainStartupOutput(input);
+  }
+  return formatRichStartupOutput(input);
+}
+
 // src/cli.ts
 function addCandidate(set2, input) {
   if (!input) {
@@ -122728,11 +122806,13 @@ async function main() {
       port: input.port,
       quiet: true
     });
-    console.log(`kcode server listening on ${address}`);
-    if (input.mode === "web") {
-      console.log(`kcode web ui available at ${address}`);
-    }
-    console.log(`kcode default directory: ${runtime.DEFAULT_DIRECTORY}`);
+    console.log(
+      formatStartupOutput({
+        address,
+        defaultDirectory: runtime.DEFAULT_DIRECTORY,
+        mode: input.mode
+      })
+    );
   } catch (error2) {
     const message2 = error2 instanceof Error ? error2.message : String(error2);
     console.error(`[kcode] ${message2}`);
@@ -122752,4 +122832,3 @@ undici/lib/web/websocket/frame.js:
 chokidar/esm/index.js:
   (*! chokidar - MIT License (c) 2012 Paul Miller (paulmillr.com) *)
 */
-//# sourceMappingURL=cli.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kcode-cli",
-  "version": "1.3.21",
+  "version": "1.3.22",
   "description": "KCode CLI",
   "license": "MIT",
   "type": "module",
@@ -9,7 +9,8 @@
   },
   "files": [
     "dist",
-    "script/postinstall.js"
+    "script/postinstall.js",
+    "README.md"
   ],
   "engines": {
     "node": ">=20"