首页/文档/安装与运行

开始使用

安装与运行

用 kcode-cli 在目标仓库目录里启动本地服务和内置 Web UI。

第一版公开使用路径先围绕 kcode-cli 展开。默认命令会同时启动本地服务和内置 Web UI,所以第一次使用时不需要先理解完整架构,只需要先跑通入口。

安装 CLI

推荐全局安装:

npm install -g kcode-cli

如果你只是临时体验一次,也可以直接运行:

npx kcode-cli

在目标仓库目录里启动

进入你真正要协作的项目目录,然后执行:

kcode

默认行为等价于 kcode web,它会同时:

  • 启动本地 API 服务。
  • 暴露内置 Web UI。
  • 把当前工作目录作为默认 directory

默认地址是什么

  • Host: 127.0.0.1
  • Port: 4096
  • Web UI: http://127.0.0.1:4096

如果你没有显式覆盖,浏览器里打开的就是这组默认地址。

什么时候只用 kcode serve

如果你只想跑服务层,不挂内置 Web UI,可以使用:

kcode serve

这适合两类场景:

  • 你已经有其他前端入口。
  • 你想单独验证服务层或调试连接链路。

常用参数

Usage: kcode [web|serve] [options]

Options:
  --hostname <host>
  --port <port>
  --directory <path>
  --log-level <level>
  -h, --help

下一步建议