Skip to content

快速开始 ​

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


1. 安装 JeikCode ​

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


2. 启动 JeikCode 的四种方式 ​

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

方式一:桌面客户端启动 (Desktop,推荐) ​

如果你更习惯图形桌面环境,安装官方桌面端后直接双击图标启动即可:

  • 开箱即用图形窗口:无需任何前置命令,打开即是完整的全功能操作界面;
  • 全网监听与随机 Token:桌面端后台默认自动监听 0.0.0.0(支持公网/局域网跨设备协同),并自动生成一个专属的高强度随机访问 Token;
  • 跨端协作:不仅本地窗口无感秒开,还会在界面或终端提示远程链接。在同一局域网的手机、平板或笔记本浏览器中打开对应链接输入该 Token,即可实现多端协同。

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

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

bash
jeikcode

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

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

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

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

输入 jeikcode 进入终端交互后,如果你想随时切换到浏览器 Web 视图,可以在输入框中输入斜杠命令:

text
/webui

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


方式四:后台常驻与远程管理 (Daemon) ​

如果你希望将 JeikCode 作为全天候开机自启的守护服务,或在云服务器/局域网软路由中长期部署,只需在命令行统一输入:

bash
# 启动后台服务并按向导一键注册开机自启
jeikcode --host 0.0.0.0 --port 13457 --token sk-your-secret-token

终端会根据你的操作系统特征(Linux、macOS、Windows、OpenWrt)自动配置对应的开机自启后台服务,并打印出 WebUI 远程管理地址。

💡 详细配置与多端协同:更多关于跨平台 CLI 开机自启机制与桌面端内置监听的介绍,请参阅下一节专门的 开机自启与远程访问。


3. 代码图谱与语义探索 ​

💡 独立章节:更多关于代码图谱的双语词林、AST 拓扑原理及多语言支持,请参阅专门的 代码图谱 页面。

代码图谱是 JeikCode 区别于传统 AI 编码助手的一大核心利器。它通过对代码库建立深度抽象语法树(AST)与符号调用拓扑网络,让 Agent 拥有整仓级的“上帝视角”。

通常情况下,如果你处于一个普通的项目文件夹中进行代码开发,一般无需你手动建立索引,Agent 会自动受指引在合适的时候帮你建立索引且保持自动更新。但是,如果你运行在一个多仓库目录,且这个多仓库目录不是属于同一个项目,强烈建议你手动创建索引(更推荐分别进入每一个独立的子项目仓库目录下建立索引,以避免跨项目全局索引产生巨大的检索噪音与混淆;除非你的多仓库本身就是一个项目的前后端,此时联合建索引才是有意义且高效的)。

手动创建索引的方式如下:

手动构建代码图谱 ​

在目标项目根目录下执行以下命令,秒级完成全仓语法分析并生成图谱缓存:

bash
# 首次或增量构建索引
jeikcode init

# 强制全量重新扫描整个仓库
jeikcode init --force

核心特性优势 ​

  1. 主流语言全覆盖:
    • 深度内置 Tree-Sitter 语法解析引擎,原生支持 Rust、TypeScript、JavaScript、Python、Go、Java、C、C++、C#、Vue、PHP、Ruby 等 12+ 种主流编程语言;
  2. 极低资源开销与无感增量监听:
    • 构建后常驻占用极低,不消耗昂贵的后台 CPU;
    • 支持智能文件监听与单文件增量 Patch(单文件变动仅需 1~3ms 极速差量更新),后续全程不用管,自动监听代码变更,无需反复手动重建;
  3. 超越传统工具:支持自然语言与纯业务语言检索:
    • 传统的代码检索工具通常仅支持死板的符号、类名或方法名等 AST 匹配;
    • JeikCode 代码图谱深度融合了领域双语词林(thesaurus)与语义拓扑。最强的是,它能够支持直接用纯日常自然语言或业务语言提问(如:“订单超时未支付如何自动取消”、“鉴权拦截器在哪里生效”、“多协议流式响应怎么转换”),Agent 即可通过多级语义扩展与调用链追踪,直接检索到高质量的所有相关核心代码与完整上下游调用链,彻底打破中英文命名与业务黑话的鸿沟!

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

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

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

5. 下一步建议 ​

Released under the Apache-2.0 / MIT License.