Skip to content

快速开始 ​

本教程将带领你从零开始体验 JeikCode 的核心开发工作流。


1. 安装 JeikCode ​

在开始使用之前,请先参考 快速安装指南 完成 JeikCode 的安装。


2. 启动 JeikCode 的三种方式 ​

JeikCode 支持根据你的开发偏好与网络场景选择以下三种启动方式:

方式一:终端交互命令行 (TUI) ​

如果你偏好命令行,请直接在你开发的工程目录下打开终端,输入 jeikcode 并按回车:

bash
jeikcode

如果是首次运行,JeikCode 会引导你完成基础模型配置。你也可以在启动时传入目标路径或具体任务:

bash
# 进入指定项目的交互终端
jeikcode /path/to/my-project

# 非交互模式直接执行单个提问或任务
jeikcode run "帮我分析当前项目的依赖并输出安全风险报告"

方式二:从终端一键唤起 WebUI 面板 ​

输入 jeikcode 进入终端交互后,如果你想用 WebUI,可以在输入框中输入:

text
/webui

系统会自动在本地启动 Web 服务并自动打开浏览器窗口。浏览器界面和终端保持 实时双向同步(Live Sync)。若需停止 WebUI 服务,在终端输入 /webui stop。

方式三:局域网 / 公网远程访问 WebUI 服务 ​

如果你想要让该 WebUI 可以在局域网或公网访问(例如远程服务器部署、手机平板跨设备协同),你可以在命令行中直接指定主机地址、端口与鉴权 Token:

bash
# 局域网/公网监听并设置安全 Token(推荐)
jeikcode --host 0.0.0.0 --port 13457 --token your-token

# 免密访问模式(仅建议在受信任的内部私有局域网使用)
jeikcode --host 0.0.0.0 --port 13457 --no-token

启动后,在任意设备的浏览器中打开形如 http://<服务器IP>:13457/?token=your-token 的链接即可开始远程协同编程。


3. 认识交互终端 (TUI) ​

启动进入终端后,你将体验 JeikCode 的富文本终端环境:

text
┌────────────────────────────────────────────────────────┐
│ JeikCode v7.1.x                [Model: claude-3-7-sonnet]│
├────────────────────────────────────────────────────────┤
│ > 你好!我是 JeikCode。已就绪,请输入你的需求。           │
│                                                        │
├────────────────────────────────────────────────────────┤
│ 输入你的问题或任务,按 Enter 发送;输入 / 唤出斜杠命令  │
└────────────────────────────────────────────────────────┘
  • 底部输入框:输入自然语言指令(如:“将用户认证逻辑从 JWT 改为 Session”)。
  • 斜杠命令:输入 / 会弹出可用的指令面板(例如 /help、/webui、/model、/clear 等)。
  • 实时工具卡片:Agent 执行读写文件、执行命令、搜索代码等动作时,终端会实时展示折叠式卡片。

4. 下一步建议 ​

Released under the Apache-2.0 / MIT License.