Files
Alfred/docs/user/usage.md

2.8 KiB
Raw Blame History

快速开始

本文档说明如何安装和配置 Alfred·阿福。

1. 安装依赖

bun install

2. 准备配置文件

cp config.example.yaml config.yaml

按需编辑 config.yaml 中的监听地址、日志、存储路径等配置。配置文件为启动时的必传参数。

3. 启动开发模式

bun run dev config.yaml

访问 http://127.0.0.1:5173 查看应用。

下一步

功能介绍

功能 路径 说明
总览 / Admin 管理台总览,展示运行时元信息
项目管理 /projects 创建、编辑、归档、恢复和永久删除项目
模型管理 /models 配置 AI 供应商和模型,供后续 AI 功能使用
工作台总览 /workbench/:projectId Workbench 工作台总览,按项目维度查看信息
用户管理 /users 页面建设中
系统设置 /settings 页面建设中

平台提供两个入口:

  • Admin管理台:全局管理视角,包含总览和项目管理。默认入口,访问 / 即可进入。
  • Workbench工作台:项目维度视角,通过 /workbench/:projectId 进入指定项目的工作台。URL 可保存为浏览器书签,下次直接进入。仅 active 状态的项目可进入工作台archived 项目不可访问。

从项目管理页面的 active 项目行可点击"工作台"跳转到对应项目的工作台。

模型管理

在 Admin 侧栏进入 /models 后,页面通过两个标签页管理 AI 基础配置:

  • 供应商:新增、编辑、删除 OpenAI、Anthropic 或 OpenAI 兼容供应商。新建供应商时类型默认是 openai-compatiblebaseURL 和 API Key 由用户填写。
  • 模型:为供应商新增模型,填写模型显示名称、实际调用用的 modelId、能力标签以及可选的上下文长度和最大输出 token。

供应商表单提供“测试连接”操作:系统先测试 Base URL 是否可达,再尝试请求 /models 验证 API Key 和模型列表接口。若服务不支持 /models,页面会提示接口可达但可能不支持模型列表;该结果只作为提醒,不会阻止保存供应商或模型。删除供应商前必须先删除或迁移其关联模型,否则系统会拒绝删除以避免误删模型配置。