快速开始

这份快速开始把你从一个新克隆的仓库带到可打开的本地 Jarvis 实例。主路径面向本机浏览器访问，默认使用本地 HTTP。

如果你要在没有桌面浏览器的 Linux 服务器上部署后端，使用无头 Linux 后端。

前置条件

本机需要：

git
Python 3.11+
Node.js 20.19+
bash 或 zsh 等 POSIX shell

如果你准备马上启动编码会话，还需要安装并登录至少一个运行时 CLI，例如 Claude Code、Codex 或 OpenCode。

1. 克隆仓库

git clone https://github.com/CAKE-math/jarvis.git
cd jarvis

2. 创建 Python 环境并安装后端依赖

python3 -m venv .venv
.venv/bin/python -m pip install -e 'backend/[dev]'

可编辑安装会让后端直接使用当前工作树中的代码，同时把项目脚本暴露到本地虚拟环境。

3. 安装前端依赖

cd frontend
npm install
cd ..

4. 创建本地环境文件

cp .env.example .env
printf '\nJARVIS_FORCE_HTTP=1\n' >> .env

JARVIS_FORCE_HTTP=1 让本地快速开始固定走 http://127.0.0.1:8888。如果你的机器已有 Tailscale 证书或其他本地 TLS 配置，这个开关可以避免第一次启动时自动切到 HTTPS，导致浏览器或健康检查连错协议。之后如果你明确要配置本地 HTTPS，再移除它。

5. 启动 Jarvis

./restart.sh

成功后，脚本会启动后端、完成必要的本地初始化，并打印监听地址。默认本地 UI 地址是 http://127.0.0.1:8888。

6. 生成 API 密钥

另开一个终端，在仓库根目录运行：

.venv/bin/jarvis genkey -d "本地浏览器"

打开 http://127.0.0.1:8888，把生成的密钥粘贴到 Jarvis UI 中。以后访问本地 API 或远程入口时也会用到它。

7. 可选：验证健康状态

如果 ./restart.sh 已经打印启动成功，可以直接打开 UI。需要排查时再运行：

curl --noproxy '*' http://127.0.0.1:8888/api/v1/health

预期返回 JSON，且包含健康状态和版本信息。

8. 下一步

要启动工作会话，继续阅读第一次编码会话。
要配置模型，阅读配置模型提供商。
启动失败时，阅读排障。