快速开始

本文档将帮助您快速安装并开始使用 Kode 开发环境管理工具。

computer 系统要求

check_circle操作系统: Windows 10 或 Windows 11
check_circle磁盘空间: 至少 500MB 可用空间
check_circle网络: 需要网络连接以下载开发环境

download 安装步骤

01

获取安装包

从官方发布页面下载最新版本的安装包（.exe 文件）。

02

运行安装程序

双击下载的安装包，按照安装向导提示完成安装。

03

启动应用

双击桌面快捷方式，或从开始菜单找到 Kode 并启动。

play_arrow 首次使用

启动界面

首次启动 Kode 时，您将看到欢迎界面，显示应用 Logo 和版本信息。几秒钟后将自动跳转到登录页面。

登录账号

在登录页面，您可以选择以下登录方式：

database

本地账号登录

输入用户名（密码可选），点击"登录"按钮

hub

GitHub 登录

点击 GitHub 图标，在浏览器中完成授权

chat

钉钉登录

点击钉钉图标，扫码完成授权

初始配置

1

配置应用目录（可选）

进入"设置"页面，在"基础设置"中配置应用数据存储目录。默认为用户目录下的 kode 文件夹。

2

安装开发环境

进入"设置"页面，选择需要的环境类型（JDK、Maven、Node.js、Git），点击"安装"按钮进行一键安装。

3

创建第一个项目

进入"项目管理"页面，点击"新建项目"按钮，填写项目名称和路径，配置项目使用的开发环境。

用户认证

了解如何通过本地、GitHub 或钉钉进行身份验证，以及如何高效地管理您的用户个人资料与安全退出流程。

login 登录方式

Kode 支持多种身份验证驱动程序，以满足不同组织的安全需求。

database

本地登录

使用存储在您自己数据库中的用户名和加密密码进行传统验证。本地账号仅存储在本地，不进行云端同步。

hub

GitHub OAuth

支持使用 GitHub 账号快速登录，适用于开源项目及开发者社区。授权信息存储在本地。

chat

钉钉扫码

企业级认证首选，支持钉钉扫码一键登录，完美集成企业组织架构。

person 用户数据

每个用户拥有独立的数据存储空间。认证成功后，Kode 会自动注入一个全局 user 对象，包含以下核心字段：

字段名	类型	描述
id	string	用户唯一识别符
nickname	string	用户展示名称
avatar	url	用户头像链接
roles	string[]	分配给该用户的权限角色列表

数据目录结构

%USERPROFILE%\kode\{username}\
├── global.json          # 全局配置
└── {projectId}.project.json  # 项目配置

{appDir}\{username}\
├── config.json          # 环境配置
├── agents\              # 智能体配置
├── skills\              # 技能配置
└── *.project.json       # 项目配置文件

logout 退出登录

点击侧边栏底部的用户头像，在弹出的菜单中选择"退出登录"。系统将清除当前登录状态，返回登录页面。退出登录不会删除用户数据，重新登录后可恢复所有配置。

shield

安全建议

在公共终端上使用 Kode 时，请务必执行"退出登录"操作。系统会在闲置 30 分钟后自动断开连接。

控制台

控制台是 Kode 的首页，提供系统概览和快捷操作入口。

history 最近项目

最近项目区域显示您最近编辑过的项目列表，方便快速访问。每个项目卡片显示项目名称、编辑时间和环境标签。

项目卡片信息

信息	说明
项目图标	文件夹图标
项目名称	项目名称
编辑时间	相对时间显示（如"刚刚"、"2小时前编辑"）
环境标签	显示项目配置的开发环境（如 "Java 17"、"Node 18"）

grid_view

网格视图

以卡片形式展示，适合浏览

view_list

列表视图

以列表形式展示，信息更紧凑

bolt 快捷操作

terminal

打开终端

快速启动系统终端，将在用户主目录下打开。使用设置中配置的默认终端（CMD 或 PowerShell）。

settings

环境设置

快速跳转到设置页面，配置开发环境。

monitoring 系统占用

实时显示系统资源使用情况，包括 CPU 使用率和内存使用率。数据每 5 秒更新一次。

system_update 自动更新

Kode 启动时会自动检查是否有新版本可用。当检测到新版本时，将弹出更新提示对话框，显示新版本号、更新说明和当前版本号。

check_circle

立即更新

开始下载更新包，完成后自动安装

schedule

稍后再说

关闭提示，下次启动时再次提醒

项目管理

项目管理是 Kode 的核心功能，提供项目的创建、配置、初始化和运行等完整生命周期管理。

add_circle 创建项目

点击页面右上角的"新建项目"按钮，在弹出的对话框中选择创建方式。

方式	说明	项目状态
创建新项目	在空白目录创建，需要后续初始化	未初始化
选择已有项目	导入已有代码的项目	开发中

配置内容：

chevron_right项目名称与项目路径
chevron_right开发环境（JDK / Node.js / Maven 版本）
chevron_right代码仓库地址和凭证（前端/后端）

build 项目初始化

对于"未初始化"状态的项目，需要进行初始化才能使用。系统将自动克隆代码仓库并配置环境。

1

克隆后端代码仓库

2

克隆前端代码仓库

3

克隆沙箱前端代码仓库

4

清理 .git 目录，项目状态变为"开发中"

注意：必须先在"环境设置"中配置 Git，确保网络连接正常且有足够磁盘空间。

play_circle 项目运行

运行模式

模式	说明	运行内容
开发模式	完整开发环境	前端 + 后端
沙箱模式	仅前端 Mock 环境	仅前端

终端窗口

项目运行时，底部会显示嵌入式终端窗口，实时显示运行日志。开发模式下左右分栏显示前后端日志，沙箱模式下全宽显示前端日志。

进程状态指示灯

运行中

已退出

已停止

tune 运行时配置

在项目详情页面可配置数据库、Redis、MinIO 等运行时环境参数，配置自动保存。

storage

数据库配置

类型、地址、用户名、密码、Schema

memory

Redis 配置

服务器地址、访问密码

cloud_upload

MinIO 配置

服务器地址、用户名、密码

环境设置

管理本地开发环境，包括 JDK、Maven、Node.js、Git 等工具的安装与配置。

tune 基础设置

应用目录

Kode 的数据存储目录，所有用户数据、项目配置都将存储在此目录下。

默认：%USERPROFILE%\kode

默认终端

打开终端时使用的默认程序：CMD（命令提示符）或 PowerShell。

终端初始命令

打开终端后自动执行的命令。系统会自动检测命令是否可用。

示例：pnpm、nvm use 18

默认 IDE

系统会自动检测已安装的 IDE（Trae、Qoder），也可手动输入 IDE 路径。

检查更新

手动检查 Kode 是否有新版本可用，如有新版本将显示更新提示。

settings_input_component 环境管理

JJDK 管理

支持 JDK 8、11、17、21 版本的一键安装。可手动添加已安装的 JDK。

- 安装 / 选择已有 JDK
- 设置默认版本
- 自动配置 JAVA_HOME

MMaven 管理

支持 Maven 3.8.x、3.9.x 版本。推荐使用 3.9.x 版本。

- 安装 / 选择已有 Maven
- 设置默认版本
- 自动配置 MAVEN_HOME

NNode.js 管理

支持 LTS 和 Current 版本的安装管理。

- 安装 / 选择已有 Node.js
- 设置默认版本
- 自动配置 PATH

GGit 管理

项目初始化的必要工具，请确保至少配置一个 Git。

- 安装 / 选择已有 Git
- 自动检测版本

提示：环境变量仅在 Kode 启动的进程中生效，不会修改系统环境变量。

cloud_upload 发布设置

配置远程服务器信息，便于项目部署。

服务器配置项

参数	说明
名称	服务器显示名称（可选）
服务器 IP	服务器地址
SSH 端口	SSH 服务端口，默认 22
SSH 用户名	登录用户名
SSH 密码	登录密码

AI 市场

管理智能体（Agent）、技能（Skill）和 AI 工具，为项目提供 AI 辅助能力。

smart_toy 智能体管理

智能体（Agent）是具有特定能力的 AI 助手，可以执行特定类型的任务。

智能体分类

类型	说明	操作
内置智能体	系统预置的智能体	查看、管理
自定义智能体	用户创建的智能体	查看、编辑、删除、管理

创建智能体

填写中文名称、英文名称、Git 仓库地址，并选择关联的技能。更新操作会将智能体代码同步到所有项目目录。

psychology 技能管理

技能（Skill）是智能体的能力模块，提供特定功能的实现。支持内置技能和自定义技能。

visibility

查看技能

查看中文名称、英文名称、Git 仓库地址

add_circle

创建技能

填写名称和 Git 地址即可创建

sync

更新技能

从 Git 仓库拉取最新代码，同步到所有项目

build_circle 工具管理

管理 AI 开发工具，包括 IDE 和 CLI 两类工具。

IDE 工具

Q

Qoder

AI 驱动的 IDE 开发工具

T

Trae

字节跳动推出的 AI IDE

CLI 工具

Q

Qoder CLI

Qoder 命令行工具

C

Claude Code

Anthropic 的 Claude 命令行工具

工具状态

已安装工具已安装并检测到路径

未安装工具未安装

link 与项目关联

通过管理对话框将智能体/技能安装到指定项目，或从项目中卸载。更新时系统会自动同步到所有项目。

项目配置结构

{project_path}\
├── .ai\
│   ├── agents\
│   │   └── {agent_name_en}\
│   └── skills\
│       └── {skill_name_en}\