dev 命令用于在本地启动开发服务器,方便开发者快速测试和调试 Agent 应用。支持热重载、自定义端口和环境变量配置。
| 参数 | 简写 | 说明 | 默认值 |
|---|---|---|---|
--port |
-p |
服务器端口 | 8080 |
--host |
-h |
服务器主机地址 | 0.0.0.0 |
--reload |
- | 启用热重载(代码变更自动重启) | False |
--config |
-c |
配置文件路径 | .agentarts_config.yaml |
--env |
-e |
环境变量(格式:KEY=VALUE),可多次使用 | 从配置文件读取 |
使用 --env 或 -e 参数直接传递环境变量:
agentarts dev --env OPENAI_API_KEY=sk-xxx --env OPENAI_MODEL_NAME=gpt-4o在 .agentarts_config.yaml 中配置环境变量:
runtime:
environment_variables:
- key: OPENAI_API_KEY
value: "your-api-key"
- key: OPENAI_MODEL_NAME
value: "gpt-4o-mini"
- key: OPENAI_BASE_URL
value: ""命令行 --env 参数优先级高于配置文件,相同变量会使用命令行传入的值。
启动开发服务器后,会显示以下信息:
╭──────────────────────────────────────────────────────────────────────────────╮
│ Development Server │
│ Host: 0.0.0.0 │
│ Port: 8080 │
│ Config: .agentarts_config.yaml │
│ Entrypoint: agent:create_app │
│ Auto-reload: enabled │
│ Environment Variables: │
│ OPENAI_API_KEY=sk-xxxx****xxxx (CLI) │
│ OPENAI_MODEL_NAME=gpt-4o (CLI) │
╰──────────────────────────────────────────────────────────────────────────────╯
Invocation Endpoint: POST http://0.0.0.0:8080/invocations
Health Check: GET http://0.0.0.0:8080/ping
agentarts devagentarts dev --port 3000agentarts dev --reloadagentarts dev --env OPENAI_API_KEY=sk-xxx --env OPENAI_MODEL_NAME=gpt-4oagentarts dev -p 3000 -e OPENAI_API_KEY=sk-xxx -e OPENAI_MODEL_NAME=gpt-4oagentarts dev --config ./config/agentarts_config.yamlagentarts dev \
--port 3000 \
--host 127.0.0.1 \
--reload \
--env OPENAI_API_KEY=sk-xxx \
--env OPENAI_MODEL_NAME=gpt-4o \
--env OPENAI_BASE_URL=https://api.openai.com/v1开发服务器启动后,提供以下端点:
| 端点 | 方法 | 说明 |
|---|---|---|
/invocations |
POST | Agent 调用入口 |
/ping |
GET | 健康检查 |
curl -X POST http://localhost:8080/invocations \
-H "Content-Type: application/json" \
-d '{"message": "Hello, Agent!"}'curl http://localhost:8080/ping启用 --reload 参数后,当检测到代码文件变更时,服务器会自动重启:
agentarts dev --reload适用于开发阶段快速迭代。
- 环境变量安全: 敏感信息(如 API Key)在显示时会被脱敏处理
- 端口占用: 确保指定端口未被其他程序占用
- 配置文件: 默认读取当前目录下的
.agentarts_config.yaml - 模块路径: 确保
entrypoint指向的模块文件存在 - 依赖安装: 启动前请确保已安装所有依赖
pip install -r requirements.txt