fotric-claw 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FOTRIC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,276 @@
+# FotricCalw 安装与配置指南
+
+FotricCalw 是一个轻量级、透明的 AI Agent 系统，支持命令行安装和配置。
+
+## 系统要求
+
+- Node.js >= 18.0.0
+- npm >= 9.0.0
+
+## 安装方式
+
+### 方式一：从 npm 安装（待开发）
+
+```bash
+npm install -g fotric-claw
+```
+
+> 注：此方式暂不可用，请使用源码安装。
+
+### 方式二：从源码安装
+
+#### 步骤 1：克隆项目
+
+```bash
+git clone https://github.com/fotric/fotric-claw.git
+cd fotric-claw
+```
+
+#### 步骤 2：安装依赖
+
+```bash
+npm run install:all
+```
+
+该命令会自动安装前端和后端的所有依赖。
+
+也可以手动安装：
+
+```bash
+cd backend && npm install
+cd ../frontend && npm install
+```
+
+#### 步骤 3：配置环境变量
+
+复制环境变量模板：
+
+```bash
+cp backend/.env.example backend/.env
+```
+
+或使用命令行配置工具（配置将保存到 `backend/.env`）：
+
+```bash
+node bin/fotric-claw.js config
+```
+
+#### 步骤 4：启动服务
+
+**方式一：使用命令行工具（推荐）**
+
+(由于方式一的命令行工具暂未开发，此处仅展示手动启动的方式)
+```bash
+fotric-claw start
+```
+使用该方案,等效于上述命令
+```bash
+node bin/fotric-claw.js start
+```
+
+该命令将自动启动后端和前端服务。
+
+**方式二：手动启动**
+
+```bash
+# 启动后端服务
+npm run backend
+
+# 在新终端窗口启动前端服务
+npm run frontend
+```
+
+#### 步骤 5：访问应用
+
+打开浏览器访问 http://localhost:3000
+
+## 命令行配置
+
+FotricCalw 提供了交互式命令行配置工具，方便用户设置 LLM API 参数。
+
+### 查看帮助
+
+```bash
+fotric-claw help
+```
+
+输出：
+```
+FotricCalw CLI
+
+Usage:
+  fotric-claw <command> [options]
+
+Commands:
+  start       Start backend and frontend services (dev mode)
+  start:prod  Start backend and frontend services (production mode)
+  build       Build backend and frontend for production
+  config      Configure LLM API settings
+  help        Show this help message
+
+Examples:
+  fotric-claw start
+  fotric-claw start:prod
+  fotric-claw build
+  fotric-claw config
+  fotric-claw help
+```
+
+### 配置 LLM API
+
+运行配置命令：
+
+```bash
+fotric-claw config
+```
+
+系统将显示当前配置并引导您输入新的配置值：
+
+```
+🔧 FotricCalw Configuration
+
+Current configuration:
+  API Key: sk-a****bcd
+  API Base URL: https://api.openai.com/v1
+  Model Name: gpt-4o
+
+Enter API Key (sk-abcd1234):
+Enter API Base URL (https://api.openai.com/v1):
+Enter Model Name (gpt-4o):
+
+✅ Configuration saved to .env file
+   Please restart the server for changes to take effect.
+```
+
+### 配置参数说明
+
+| 参数 | 环境变量 | 说明 | 默认值 |
+|------|----------|------|--------|
+| API Key | `FOTRIC_API_KEY` | LLM API 密钥 | - |
+| API Base URL | `FOTRIC_API_BASE_URL` | API 基础地址 | `https://api.openai.com/v1` |
+| Model Name | `FOTRIC_MODEL_NAME` | 模型名称 | `gpt-4o` |
+
+## 环境变量配置
+
+除了使用命令行工具，您也可以直接编辑 `backend/.env` 文件：
+
+```env
+# 服务器配置
+PORT=8002
+NODE_ENV=development
+
+# LLM API 配置（支持 OpenAI 兼容接口）
+FOTRIC_API_KEY=your_api_key_here
+FOTRIC_API_BASE_URL=https://api.openai.com/v1
+FOTRIC_MODEL_NAME=gpt-4o
+
+# 项目路径配置
+FOTRIC_ROOT_DIR=./
+FOTRIC_SKILLS_DIR=./src/skills
+FOTRIC_WORKSPACE_DIR=./src/workspace
+FOTRIC_SESSIONS_DIR=./src/sessions
+FOTRIC_KNOWLEDGE_DIR=../knowledge
+FOTRIC_STORAGE_DIR=../storage
+
+# 内存配置
+FOTRIC_MAX_MEMORY_CHARS=20000
+FOTRIC_MAX_TOKENS=128000
+
+# 工具配置
+FOTRIC_SHELL_TIMEOUT=30000
+FOTRIC_REPL_TIMEOUT=15000
+```
+
+## 启动服务
+
+### 开发模式
+
+```bash
+# 启动后端服务
+npm run backend
+
+# 启动前端服务（新终端窗口）
+npm run frontend
+```
+
+### 生产模式
+
+**方式一：使用命令行工具（推荐）**
+
+```bash
+# 构建项目
+fotric-claw build
+
+# 启动生产服务
+fotric-claw start:prod
+```
+
+**方式二：手动操作**
+
+```bash
+# 构建项目
+npm run build:backend
+npm run build:frontend
+
+# 启动后端
+cd backend && npm run start:prod
+
+# 启动前端
+cd frontend && npm run start
+```
+
+## 访问服务
+
+启动成功后：
+
+- **前端界面**: http://localhost:3000
+- **后端 API**: http://localhost:8002
+- **配置接口**: http://localhost:8002/api/config
+
+## 常见问题
+
+### 1. 端口被占用
+
+如果默认端口被占用，可以修改 `backend/.env` 中的 `PORT` 配置：
+
+```env
+PORT=8003
+```
+
+### 2. API Key 未配置
+
+如果未配置 API Key，后端服务仍可启动，但 AI 对话功能将无法使用。请通过以下方式配置：
+
+```bash
+fotric-claw config
+```
+
+或在前端界面的设置页面配置。
+
+### 3. 使用其他 LLM 提供商
+
+FotricCalw 支持所有 OpenAI 兼容的 API 接口，例如：
+
+**Azure OpenAI:**
+```env
+FOTRIC_API_BASE_URL=https://your-resource.openai.azure.com/openai/deployments/your-deployment
+FOTRIC_API_KEY=your-azure-key
+```
+
+**国内 API 代理:**
+```env
+FOTRIC_API_BASE_URL=https://your-proxy.com/v1
+FOTRIC_API_KEY=your-api-key
+```
+
+**本地部署模型:**
+```env
+FOTRIC_API_BASE_URL=http://localhost:11434/v1
+FOTRIC_API_KEY=ollama
+FOTRIC_MODEL_NAME=llama2
+```
+
+## 技术支持
+
+- GitHub: https://github.com/fotric/fotric-claw
+- 官网: https://www.fotric.cn/

package/backend/.env.example

@@ -0,0 +1,26 @@
+# FotricCalw Backend Configuration
+
+# Server
+PORT=8002
+NODE_ENV=development
+
+# LLM API Configuration (支持 OpenAI 兼容接口)
+FOTRIC_API_KEY=your_api_key_here
+FOTRIC_API_BASE_URL=https://api.openai.com/v1
+FOTRIC_MODEL_NAME=gpt-4o
+
+# Project Paths
+FOTRIC_ROOT_DIR=./
+FOTRIC_SKILLS_DIR=./src/skills
+FOTRIC_WORKSPACE_DIR=./src/workspace
+FOTRIC_SESSIONS_DIR=./src/sessions
+FOTRIC_KNOWLEDGE_DIR=../knowledge
+FOTRIC_STORAGE_DIR=../storage
+
+# Memory Configuration
+FOTRIC_MAX_MEMORY_CHARS=20000
+FOTRIC_MAX_TOKENS=128000
+
+# Tool Configuration
+FOTRIC_SHELL_TIMEOUT=30000
+FOTRIC_REPL_TIMEOUT=15000

package/backend/nest-cli.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true
+  }
+}