CLI 参考
查看 `kcode-cli` 的命令结构、默认模式和常用参数。
kcode-cli 是当前最直接的公开使用入口。第一次使用时,你通常只会接触三个层面的信息:默认命令、子命令差异,以及覆盖默认值的常用参数。
基本用法
kcode [web|serve] [options]
不传子命令时,等价于:
kcode web
子命令分别做什么
kcode web
- 启动本地 API 服务。
- 暴露内置 Web UI。
- 适合日常直接使用。
kcode serve
- 只启动 API 服务。
- 不挂载内置 Web UI。
- 适合你已经有其他前端入口,或只想调服务层时使用。
常用参数
| 参数 | 作用 | 默认值 |
|---|---|---|
--hostname <host> |
服务监听地址 | 127.0.0.1 |
--port <port> |
服务监听端口 | 4096 |
--directory <path> |
覆盖默认项目目录 | 当前工作目录 |
--log-level <level> |
为 SDK 兼容保留 | 不改变当前输出行为 |
-h, --help |
查看帮助 | 无 |
常见示例
指定目录和端口:
kcode web --directory /path/to/project --port 4310
只跑 API:
kcode serve --port 4310
查看帮助:
kcode --help