README.md
This commit is contained in:
548
README.md
548
README.md
@@ -1,202 +1,295 @@
|
|||||||
|
# Claudia - Claude Code 桌面客户端
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="https://github.com/user-attachments/assets/92fd93ed-e71b-4b94-b270-50684323dd00" alt="Claudia Logo" width="120" height="120">
|
<img src="https://github.com/user-attachments/assets/92fd93ed-e71b-4b94-b270-50684323dd00" alt="Claudia Logo" width="120" height="120">
|
||||||
|
|
||||||
<a href="https://claudiacode.com"><h1>Claudia</h1></a>
|
<a href="https://claudiacode.com"><h1>Claudia</h1></a>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<strong>A powerful GUI app and Toolkit for Claude Code</strong>
|
<strong>强大的 Claude Code GUI 应用和工具包</strong>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<strong>Create custom agents, manage interactive Claude Code sessions, run secure background agents, and more.</strong>
|
<strong>创建自定义代理、管理交互式 Claude Code 会话、运行安全的后台代理等功能</strong>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<a href="#features"><img src="https://img.shields.io/badge/Features-✨-blue?style=for-the-badge" alt="Features"></a>
|
<a href="#features"><img src="https://img.shields.io/badge/功能-✨-blue?style=for-the-badge" alt="Features"></a>
|
||||||
<a href="#installation"><img src="https://img.shields.io/badge/Install-🚀-green?style=for-the-badge" alt="Installation"></a>
|
<a href="#installation"><img src="https://img.shields.io/badge/安装-🚀-green?style=for-the-badge" alt="Installation"></a>
|
||||||
<a href="#usage"><img src="https://img.shields.io/badge/Usage-📖-purple?style=for-the-badge" alt="Usage"></a>
|
<a href="#usage"><img src="https://img.shields.io/badge/使用-📖-purple?style=for-the-badge" alt="Usage"></a>
|
||||||
<a href="#development"><img src="https://img.shields.io/badge/Develop-🛠️-orange?style=for-the-badge" alt="Development"></a>
|
<a href="#development"><img src="https://img.shields.io/badge/开发-🛠️-orange?style=for-the-badge" alt="Development"></a>
|
||||||
</p>
|
</p>
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
https://github.com/user-attachments/assets/bf0bdf9d-ba91-45af-9ac4-7274f57075cf
|
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> **⭐ Star the repo and follow [@getAsterisk](https://x.com/getAsterisk) on X for early access to `asteria-swe-v0`**.
|
|
||||||
|
|
||||||
## 🌟 Overview
|
|
||||||
|
|
||||||
**Claudia** is a powerful desktop application that transforms how you interact with Claude Code. Built with Tauri 2, it provides a beautiful GUI for managing your Claude Code sessions, creating custom agents, tracking usage, and much more.
|
|
||||||
|
|
||||||
Think of Claudia as your command center for Claude Code - bridging the gap between the command-line tool and a visual experience that makes AI-assisted development more intuitive and productive.
|
|
||||||
|
|
||||||
## 📋 Table of Contents
|
|
||||||
|
|
||||||
- [🌟 Overview](#-overview)
|
|
||||||
- [✨ Features](#-features)
|
|
||||||
- [🗂️ Project & Session Management](#️-project--session-management)
|
|
||||||
- [🤖 CC Agents](#-cc-agents)
|
|
||||||
|
|
||||||
- [📊 Usage Analytics Dashboard](#-usage-analytics-dashboard)
|
|
||||||
- [🔌 MCP Server Management](#-mcp-server-management)
|
|
||||||
- [⏰ Timeline & Checkpoints](#-timeline--checkpoints)
|
|
||||||
- [📝 CLAUDE.md Management](#-claudemd-management)
|
|
||||||
- [📖 Usage](#-usage)
|
|
||||||
- [Getting Started](#getting-started)
|
|
||||||
- [Managing Projects](#managing-projects)
|
|
||||||
- [Creating Agents](#creating-agents)
|
|
||||||
- [Tracking Usage](#tracking-usage)
|
|
||||||
- [Working with MCP Servers](#working-with-mcp-servers)
|
|
||||||
- [🚀 Installation](#-installation)
|
|
||||||
- [🔨 Build from Source](#-build-from-source)
|
|
||||||
- [🛠️ Development](#️-development)
|
|
||||||
- [🔒 Security](#-security)
|
|
||||||
- [🤝 Contributing](#-contributing)
|
|
||||||
- [📄 License](#-license)
|
|
||||||
- [🙏 Acknowledgments](#-acknowledgments)
|
|
||||||
|
|
||||||
## ✨ Features
|
|
||||||
|
|
||||||
### 🗂️ **Project & Session Management**
|
|
||||||
- **Visual Project Browser**: Navigate through all your Claude Code projects in `~/.claude/projects/`
|
|
||||||
- **Session History**: View and resume past coding sessions with full context
|
|
||||||
- **Smart Search**: Find projects and sessions quickly with built-in search
|
|
||||||
- **Session Insights**: See first messages, timestamps, and session metadata at a glance
|
|
||||||
|
|
||||||
### 🤖 **CC Agents**
|
|
||||||
- **Custom AI Agents**: Create specialized agents with custom system prompts and behaviors
|
|
||||||
- **Agent Library**: Build a collection of purpose-built agents for different tasks
|
|
||||||
- **Background Execution**: Run agents in separate processes for non-blocking operations
|
|
||||||
- **Execution History**: Track all agent runs with detailed logs and performance metrics
|
|
||||||
|
|
||||||
|
|
||||||
|
## 🎯 项目背景
|
||||||
|
|
||||||
### 📊 **Usage Analytics Dashboard**
|
> **为什么要重复造轮子？**
|
||||||
- **Cost Tracking**: Monitor your Claude API usage and costs in real-time
|
>
|
||||||
- **Token Analytics**: Detailed breakdown by model, project, and time period
|
> 因为原版 Claudia-Suita 在我的电脑上无法正常运行，所以决定基于原项目进行改进和优化。虽然是"重复造轮子"，但这个轮子更适合我的使用场景，也希望能帮助到有类似需求的朋友。
|
||||||
- **Visual Charts**: Beautiful charts showing usage trends and patterns
|
|
||||||
- **Export Data**: Export usage data for accounting and analysis
|
|
||||||
|
|
||||||
### 🔌 **MCP Server Management**
|
本项目基于 [Asterisk 的 Claudia](https://github.com/getAsterisk/claudia) 改进，并参考了以下优秀项目：
|
||||||
- **Server Registry**: Manage Model Context Protocol servers from a central UI
|
- [Claude Suite](https://github.com/xinhai-ai/claude-suite) - Claude-Suite 中转站
|
||||||
- **Easy Configuration**: Add servers via UI or import from existing configs
|
- [PackyCode Cost](https://github.com/94mashiro/packycode-cost) - PackyCode 额度查询
|
||||||
- **Connection Testing**: Verify server connectivity before use
|
|
||||||
- **Claude Desktop Import**: Import server configurations from Claude Desktop
|
|
||||||
|
|
||||||
### ⏰ **Timeline & Checkpoints**
|
## 🌟 概述
|
||||||
- **Session Versioning**: Create checkpoints at any point in your coding session
|
|
||||||
- **Visual Timeline**: Navigate through your session history with a branching timeline
|
|
||||||
- **Instant Restore**: Jump back to any checkpoint with one click
|
|
||||||
- **Fork Sessions**: Create new branches from existing checkpoints
|
|
||||||
- **Diff Viewer**: See exactly what changed between checkpoints
|
|
||||||
|
|
||||||
### 📝 **CLAUDE.md Management**
|
**Claudia** 是一个功能强大的桌面应用程序，它改变了您与 Claude Code 交互的方式。基于 Tauri 2 构建，它为管理您的 Claude Code 会话、创建自定义代理、跟踪使用情况等提供了美观的图形界面。
|
||||||
- **Built-in Editor**: Edit CLAUDE.md files directly within the app
|
|
||||||
- **Live Preview**: See your markdown rendered in real-time
|
|
||||||
- **Project Scanner**: Find all CLAUDE.md files in your projects
|
|
||||||
- **Syntax Highlighting**: Full markdown support with syntax highlighting
|
|
||||||
|
|
||||||
## 📖 Usage
|
将 Claudia 视为您的 Claude Code 指挥中心 - 在命令行工具和视觉体验之间架起桥梁，使 AI 辅助开发更加直观和高效。
|
||||||
|
|
||||||
### Getting Started
|
## 📋 目录
|
||||||
|
|
||||||
1. **Launch Claudia**: Open the application after installation
|
- [🎯 项目背景](#-项目背景)
|
||||||
2. **Welcome Screen**: Choose between CC Agents or CC Projects
|
- [🌟 概述](#-概述)
|
||||||
3. **First Time Setup**: Claudia will automatically detect your `~/.claude` directory
|
- [✨ 功能特性](#-功能特性)
|
||||||
|
- [🗂️ 项目和会话管理](#️-项目和会话管理)
|
||||||
|
- [🤖 CC 代理](#-cc-代理)
|
||||||
|
- [🔗 API 中转站管理](#-api-中转站管理)
|
||||||
|
- [📊 使用分析仪表板](#-使用分析仪表板)
|
||||||
|
- [🔌 MCP 服务器管理](#-mcp-服务器管理)
|
||||||
|
- [⏰ 时间线和检查点](#-时间线和检查点)
|
||||||
|
- [📝 CLAUDE.md 管理](#-claudemd-管理)
|
||||||
|
- [📖 使用指南](#-使用指南)
|
||||||
|
- [🚀 安装](#-安装)
|
||||||
|
- [🔨 从源码构建](#-从源码构建)
|
||||||
|
- [🛠️ 开发](#️-开发)
|
||||||
|
- [🔒 安全性](#-安全性)
|
||||||
|
- [🤝 贡献](#-贡献)
|
||||||
|
- [📄 许可证](#-许可证)
|
||||||
|
- [🙏 致谢](#-致谢)
|
||||||
|
|
||||||
### Managing Projects
|
## 🆕 主要改进
|
||||||
|
|
||||||
|
相比原版 Claudia，本版本主要新增和改进了以下功能：
|
||||||
|
|
||||||
|
### ✅ 已完成功能
|
||||||
|
|
||||||
|
1. **API 中转站管理系统（代理商切换）**
|
||||||
|
- ✅ 完整实现 PackyCode 中转站支持（滴滴车/公交车服务）
|
||||||
|
- ✅ Custom 自定义中转站配置
|
||||||
|
- ✅ 实时额度查询和管理
|
||||||
|
- ✅ 多中转站切换管理（一键切换不同代理商）
|
||||||
|
- ✅ 自动配置同步到 Claude 设置文件
|
||||||
|
|
||||||
|
2. **优化的费用计算**
|
||||||
|
- ✅ 更精确的 Token 费用计算算法
|
||||||
|
- ✅ 支持缓存费用单独统计
|
||||||
|
- ✅ 不同模型费率差异化处理
|
||||||
|
- ✅ 实时费用追踪和成本分析
|
||||||
|
- ✅ 按项目、模型、日期多维度统计
|
||||||
|
|
||||||
|
3. **完整的国际化（i18n）**
|
||||||
|
- ✅ 全面的中文界面支持
|
||||||
|
- ✅ 中英文一键切换
|
||||||
|
- ✅ 前后端统一的国际化系统
|
||||||
|
- ✅ 本地化的提示、错误信息和说明
|
||||||
|
- ✅ 语言设置持久化存储
|
||||||
|
|
||||||
|
4. **Bug 修复和性能优化**
|
||||||
|
- ✅ 修复了原版在某些环境下无法运行的问题
|
||||||
|
- ✅ 修复了 JSON 配置文件解析错误
|
||||||
|
- ✅ 优化了数据库操作性能
|
||||||
|
- ✅ 改进了界面响应速度
|
||||||
|
- ✅ 解决了中转站配置同步问题
|
||||||
|
|
||||||
|
## ✨ 功能特性
|
||||||
|
|
||||||
|
### 🗂️ **项目和会话管理**
|
||||||
|
- **可视化项目浏览器**：浏览 `~/.claude/projects/` 中的所有 Claude Code 项目
|
||||||
|
- **会话历史**：查看并恢复带有完整上下文的过往编码会话
|
||||||
|
- **智能搜索**：通过内置搜索快速查找项目和会话
|
||||||
|
- **会话洞察**：一目了然地查看首条消息、时间戳和会话元数据
|
||||||
|
|
||||||
|
### 🤖 **CC 代理**
|
||||||
|
- **自定义 AI 代理**：创建具有自定义系统提示和行为的专门代理
|
||||||
|
- **代理库**：为不同任务构建专用代理集合
|
||||||
|
- **后台执行**：在独立进程中运行代理，实现非阻塞操作
|
||||||
|
- **执行历史**：跟踪所有代理运行，包含详细日志和性能指标
|
||||||
|
|
||||||
|
### 🔗 **API 中转站管理** 🆕
|
||||||
|
全新的 API 中转站功能，支持多种中转服务，让您灵活选择 API 提供商：
|
||||||
|
|
||||||
|
#### ✅ 已实现功能
|
||||||
|
- **PackyCode 中转站**
|
||||||
|
- 🚗 **滴滴车服务** - 共享 API，经济实惠
|
||||||
|
- 支持实时额度查询
|
||||||
|
- 显示账户余额、套餐信息
|
||||||
|
- 日/月使用量统计
|
||||||
|
- 🚌 **公交车服务** - 独享线路，稳定快速
|
||||||
|
- 多节点选择（直连、备用、紧急节点）
|
||||||
|
- 实时额度查询
|
||||||
|
- 智能节点切换
|
||||||
|
- 📊 **额度管理功能**
|
||||||
|
- 实时查询 API 使用额度
|
||||||
|
- 可视化展示日/月预算使用情况
|
||||||
|
- 账户余额和套餐信息一目了然
|
||||||
|
- 支持多账户管理
|
||||||
|
- 自动刷新和手动刷新
|
||||||
|
- 无需启用即可查询额度
|
||||||
|
|
||||||
|
- **Custom 自定义中转站** ✅
|
||||||
|
- 支持自定义 API URL 和认证方式
|
||||||
|
- 灵活配置各种兼容的 API 服务
|
||||||
|
- 适用于私有部署或其他第三方服务
|
||||||
|
|
||||||
|
#### 🚧 开发中功能
|
||||||
|
- **NewAPI** - 兼容 NewAPI 平台（开发中）
|
||||||
|
- **OneAPI** - 支持 OneAPI 标准（开发中）
|
||||||
|
- **YourAPI** - YourAPI 平台集成（开发中）
|
||||||
|
|
||||||
|
### 📊 **使用分析仪表板**
|
||||||
|
- **成本跟踪**：实时监控您的 Claude API 使用和成本
|
||||||
|
- **Token 分析**：按模型、项目和时间段的详细分类
|
||||||
|
- **可视化图表**：展示使用趋势和模式的精美图表
|
||||||
|
- **数据导出**：导出使用数据用于会计和分析
|
||||||
|
- **费用计算优化** 🆕：
|
||||||
|
- 精确的 Token 费用计算
|
||||||
|
- 支持不同模型的费率差异
|
||||||
|
- 缓存费用单独统计
|
||||||
|
- 参考了 [PackyCode Cost](https://github.com/94mashiro/packycode-cost) 的计算逻辑
|
||||||
|
|
||||||
|
### 🔌 **MCP 服务器管理**
|
||||||
|
- **服务器注册**：从中央 UI 管理模型上下文协议服务器
|
||||||
|
- **简单配置**：通过 UI 添加服务器或从现有配置导入
|
||||||
|
- **连接测试**：使用前验证服务器连接性
|
||||||
|
- **Claude Desktop 导入**：从 Claude Desktop 导入服务器配置
|
||||||
|
|
||||||
|
### ⏰ **时间线和检查点**
|
||||||
|
- **会话版本控制**：在编码会话的任何时点创建检查点
|
||||||
|
- **可视化时间线**：通过分支时间线浏览您的会话历史
|
||||||
|
- **即时恢复**：一键跳转到任何检查点
|
||||||
|
- **分叉会话**：从现有检查点创建新分支
|
||||||
|
- **差异查看器**：查看检查点之间的确切更改
|
||||||
|
|
||||||
|
### 📝 **CLAUDE.md 管理**
|
||||||
|
- **内置编辑器**：直接在应用内编辑 CLAUDE.md 文件
|
||||||
|
- **实时预览**：实时查看渲染的 Markdown
|
||||||
|
- **项目扫描器**：查找项目中的所有 CLAUDE.md 文件
|
||||||
|
- **语法高亮**：完整的 Markdown 支持和语法高亮
|
||||||
|
|
||||||
|
## 📖 使用指南
|
||||||
|
|
||||||
|
### 快速开始
|
||||||
|
|
||||||
|
1. **启动 Claudia**：安装后打开应用程序
|
||||||
|
2. **欢迎界面**：选择 CC 代理或 CC 项目
|
||||||
|
3. **首次设置**：Claudia 将自动检测您的 `~/.claude` 目录
|
||||||
|
|
||||||
|
### 管理项目
|
||||||
|
|
||||||
```
|
```
|
||||||
CC Projects → Select Project → View Sessions → Resume or Start New
|
CC 项目 → 选择项目 → 查看会话 → 恢复或开始新会话
|
||||||
```
|
```
|
||||||
|
|
||||||
- Click on any project to view its sessions
|
- 点击任何项目查看其会话
|
||||||
- Each session shows the first message and timestamp
|
- 每个会话显示第一条消息和时间戳
|
||||||
- Resume sessions directly or start new ones
|
- 直接恢复会话或开始新会话
|
||||||
|
|
||||||
### Creating Agents
|
### 创建代理
|
||||||
|
|
||||||
```
|
```
|
||||||
CC Agents → Create Agent → Configure → Execute
|
CC 代理 → 创建代理 → 配置 → 执行
|
||||||
```
|
```
|
||||||
|
|
||||||
1. **Design Your Agent**: Set name, icon, and system prompt
|
1. **设计您的代理**：设置名称、图标和系统提示
|
||||||
2. **Configure Model**: Choose between available Claude models
|
2. **配置模型**：在可用的 Claude 模型之间选择
|
||||||
3. **Set Permissions**: Configure file read/write and network access
|
3. **设置权限**：配置文件读写和网络访问
|
||||||
4. **Execute Tasks**: Run your agent on any project
|
4. **执行任务**：在任何项目上运行您的代理
|
||||||
|
|
||||||
### Tracking Usage
|
### 配置中转站
|
||||||
|
|
||||||
```
|
```
|
||||||
Menu → Usage Dashboard → View Analytics
|
菜单 → 中转站管理 → 创建中转站 → 配置
|
||||||
```
|
```
|
||||||
|
|
||||||
- Monitor costs by model, project, and date
|
1. **创建中转站**：
|
||||||
- Export data for reports
|
- 点击"创建中转站"按钮
|
||||||
- Set up usage alerts (coming soon)
|
- 选择适配器类型（如 PackyCode）
|
||||||
|
- 选择服务类型（滴滴车或公交车）
|
||||||
|
- 输入 API Token
|
||||||
|
- 保存配置
|
||||||
|
|
||||||
### Working with MCP Servers
|
2. **查看额度**：
|
||||||
|
- PackyCode 中转站自动显示额度信息
|
||||||
|
- 包含账户余额、日/月使用量、套餐信息
|
||||||
|
- 支持手动刷新
|
||||||
|
- 无需启用即可查询
|
||||||
|
|
||||||
|
3. **管理中转站**：
|
||||||
|
- 启用/禁用中转站（同时只能启用一个）
|
||||||
|
- 编辑配置信息
|
||||||
|
- 删除不需要的中转站
|
||||||
|
|
||||||
|
### 跟踪使用情况
|
||||||
|
|
||||||
```
|
```
|
||||||
Menu → MCP Manager → Add Server → Configure
|
菜单 → 使用仪表板 → 查看分析
|
||||||
```
|
```
|
||||||
|
|
||||||
- Add servers manually or via JSON
|
- 按模型、项目和日期监控成本
|
||||||
- Import from Claude Desktop configuration
|
- 导出数据用于报告
|
||||||
- Test connections before using
|
- 设置使用警报（即将推出）
|
||||||
|
|
||||||
## 🚀 Installation
|
### 使用 MCP 服务器
|
||||||
|
|
||||||
### Prerequisites
|
```
|
||||||
|
菜单 → MCP 管理器 → 添加服务器 → 配置
|
||||||
|
```
|
||||||
|
|
||||||
- **Claude Code CLI**: Install from [Claude's official site](https://claude.ai/code)
|
- 手动或通过 JSON 添加服务器
|
||||||
|
- 从 Claude Desktop 配置导入
|
||||||
|
- 使用前测试连接
|
||||||
|
|
||||||
### Release Executables Will Be Published Soon
|
## 🚀 安装
|
||||||
|
|
||||||
## 🔨 Build from Source
|
### 前提条件
|
||||||
|
|
||||||
### Prerequisites
|
- **Claude Code CLI**：从 [Claude 官方网站](https://claude.ai/code) 安装
|
||||||
|
|
||||||
Before building Claudia from source, ensure you have the following installed:
|
### 发布版本即将推出
|
||||||
|
|
||||||
#### System Requirements
|
## 🔨 从源码构建
|
||||||
|
|
||||||
- **Operating System**: Windows 10/11, macOS 11+, or Linux (Ubuntu 20.04+)
|
### 前提条件
|
||||||
- **RAM**: Minimum 4GB (8GB recommended)
|
|
||||||
- **Storage**: At least 1GB free space
|
|
||||||
|
|
||||||
#### Required Tools
|
在从源码构建 Claudia 之前，请确保您已安装以下内容：
|
||||||
|
|
||||||
1. **Rust** (1.70.0 or later)
|
#### 系统要求
|
||||||
|
|
||||||
|
- **操作系统**：Windows 10/11、macOS 11+ 或 Linux（Ubuntu 20.04+）
|
||||||
|
- **内存**：最低 4GB（推荐 8GB）
|
||||||
|
- **存储**：至少 1GB 可用空间
|
||||||
|
|
||||||
|
#### 必需工具
|
||||||
|
|
||||||
|
1. **Rust**（1.70.0 或更高版本）
|
||||||
```bash
|
```bash
|
||||||
# Install via rustup
|
# 通过 rustup 安装
|
||||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Bun** (latest version)
|
2. **Bun**（最新版本）
|
||||||
```bash
|
```bash
|
||||||
# Install bun
|
# 安装 bun
|
||||||
curl -fsSL https://bun.sh/install | bash
|
curl -fsSL https://bun.sh/install | bash
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Git**
|
3. **Git**
|
||||||
```bash
|
```bash
|
||||||
# Usually pre-installed, but if not:
|
# 通常已预装，如果没有：
|
||||||
# Ubuntu/Debian: sudo apt install git
|
# Ubuntu/Debian: sudo apt install git
|
||||||
# macOS: brew install git
|
# macOS: brew install git
|
||||||
# Windows: Download from https://git-scm.com
|
# Windows: 从 https://git-scm.com 下载
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Claude Code CLI**
|
4. **Claude Code CLI**
|
||||||
- Download and install from [Claude's official site](https://claude.ai/code)
|
- 从 [Claude 官方网站](https://claude.ai/code) 下载并安装
|
||||||
- Ensure `claude` is available in your PATH
|
- 确保 `claude` 在您的 PATH 中可用
|
||||||
|
|
||||||
#### Platform-Specific Dependencies
|
#### 平台特定依赖
|
||||||
|
|
||||||
**Linux (Ubuntu/Debian)**
|
**Linux (Ubuntu/Debian)**
|
||||||
```bash
|
```bash
|
||||||
# Install system dependencies
|
# 安装系统依赖
|
||||||
sudo apt update
|
sudo apt update
|
||||||
sudo apt install -y \
|
sudo apt install -y \
|
||||||
libwebkit2gtk-4.1-dev \
|
libwebkit2gtk-4.1-dev \
|
||||||
@@ -216,203 +309,150 @@ sudo apt install -y \
|
|||||||
|
|
||||||
**macOS**
|
**macOS**
|
||||||
```bash
|
```bash
|
||||||
# Install Xcode Command Line Tools
|
# 安装 Xcode 命令行工具
|
||||||
xcode-select --install
|
xcode-select --install
|
||||||
|
|
||||||
# Install additional dependencies via Homebrew (optional)
|
# 通过 Homebrew 安装其他依赖（可选）
|
||||||
brew install pkg-config
|
brew install pkg-config
|
||||||
```
|
```
|
||||||
|
|
||||||
**Windows**
|
**Windows**
|
||||||
- Install [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
|
- 安装 [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
|
||||||
- Install [WebView2](https://developer.microsoft.com/microsoft-edge/webview2/) (usually pre-installed on Windows 11)
|
- 安装 [WebView2](https://developer.microsoft.com/microsoft-edge/webview2/)（Windows 11 通常已预装）
|
||||||
|
|
||||||
### Build Steps
|
### 构建步骤
|
||||||
|
|
||||||
1. **Clone the Repository**
|
1. **克隆仓库**
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/getAsterisk/claudia.git
|
git clone https://github.com/yovinchen/claudia.git
|
||||||
cd claudia
|
cd claudia
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Install Frontend Dependencies**
|
2. **安装前端依赖**
|
||||||
```bash
|
```bash
|
||||||
bun install
|
bun install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Build the Application**
|
3. **构建应用程序**
|
||||||
|
|
||||||
**For Development (with hot reload)**
|
**开发环境（带热重载）**
|
||||||
```bash
|
```bash
|
||||||
bun run tauri dev
|
bun run tauri dev
|
||||||
```
|
```
|
||||||
|
|
||||||
**For Production Build**
|
**生产构建**
|
||||||
```bash
|
```bash
|
||||||
# Build the application
|
# 构建应用程序
|
||||||
bun run tauri build
|
bun run tauri build
|
||||||
|
|
||||||
# The built executable will be in:
|
# 构建的可执行文件位于：
|
||||||
# - Linux: src-tauri/target/release/
|
# - Linux: src-tauri/target/release/
|
||||||
# - macOS: src-tauri/target/release/
|
# - macOS: src-tauri/target/release/
|
||||||
# - Windows: src-tauri/target/release/
|
# - Windows: src-tauri/target/release/
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Platform-Specific Build Options**
|
## 🛠️ 开发
|
||||||
|
|
||||||
**Debug Build (faster compilation, larger binary)**
|
|
||||||
```bash
|
|
||||||
bun run tauri build --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
**Universal Binary for macOS (Intel + Apple Silicon)**
|
|
||||||
```bash
|
|
||||||
bun run tauri build --target universal-apple-darwin
|
|
||||||
```
|
|
||||||
|
|
||||||
### Troubleshooting
|
### 技术栈
|
||||||
|
|
||||||
#### Common Issues
|
- **前端**：React 18 + TypeScript + Vite 6
|
||||||
|
- **后端**：Rust with Tauri 2
|
||||||
|
- **UI 框架**：Tailwind CSS v4 + shadcn/ui
|
||||||
|
- **数据库**：SQLite（通过 rusqlite）
|
||||||
|
- **包管理器**：Bun
|
||||||
|
- **国际化**：i18next（支持中英文切换）
|
||||||
|
|
||||||
1. **"cargo not found" error**
|
### 项目结构
|
||||||
- Ensure Rust is installed and `~/.cargo/bin` is in your PATH
|
|
||||||
- Run `source ~/.cargo/env` or restart your terminal
|
|
||||||
|
|
||||||
2. **Linux: "webkit2gtk not found" error**
|
|
||||||
- Install the webkit2gtk development packages listed above
|
|
||||||
- On newer Ubuntu versions, you might need `libwebkit2gtk-4.0-dev`
|
|
||||||
|
|
||||||
3. **Windows: "MSVC not found" error**
|
|
||||||
- Install Visual Studio Build Tools with C++ support
|
|
||||||
- Restart your terminal after installation
|
|
||||||
|
|
||||||
4. **"claude command not found" error**
|
|
||||||
- Ensure Claude Code CLI is installed and in your PATH
|
|
||||||
- Test with `claude --version`
|
|
||||||
|
|
||||||
5. **Build fails with "out of memory"**
|
|
||||||
- Try building with fewer parallel jobs: `cargo build -j 2`
|
|
||||||
- Close other applications to free up RAM
|
|
||||||
|
|
||||||
#### Verify Your Build
|
|
||||||
|
|
||||||
After building, you can verify the application works:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Run the built executable directly
|
|
||||||
# Linux/macOS
|
|
||||||
./src-tauri/target/release/claudia
|
|
||||||
|
|
||||||
# Windows
|
|
||||||
./src-tauri/target/release/claudia.exe
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build Artifacts
|
|
||||||
|
|
||||||
The build process creates several artifacts:
|
|
||||||
|
|
||||||
- **Executable**: The main Claudia application
|
|
||||||
- **Installers** (when using `tauri build`):
|
|
||||||
- `.deb` package (Linux)
|
|
||||||
- `.AppImage` (Linux)
|
|
||||||
- `.dmg` installer (macOS)
|
|
||||||
- `.msi` installer (Windows)
|
|
||||||
- `.exe` installer (Windows)
|
|
||||||
|
|
||||||
All artifacts are located in `src-tauri/target/release/`.
|
|
||||||
|
|
||||||
## 🛠️ Development
|
|
||||||
|
|
||||||
### Tech Stack
|
|
||||||
|
|
||||||
- **Frontend**: React 18 + TypeScript + Vite 6
|
|
||||||
- **Backend**: Rust with Tauri 2
|
|
||||||
- **UI Framework**: Tailwind CSS v4 + shadcn/ui
|
|
||||||
- **Database**: SQLite (via rusqlite)
|
|
||||||
- **Package Manager**: Bun
|
|
||||||
|
|
||||||
### Project Structure
|
|
||||||
|
|
||||||
```
|
```
|
||||||
claudia/
|
claudia/
|
||||||
├── src/ # React frontend
|
├── src/ # React 前端
|
||||||
│ ├── components/ # UI components
|
│ ├── components/ # UI 组件
|
||||||
│ ├── lib/ # API client & utilities
|
│ │ └── RelayStationManager.tsx # 中转站管理组件
|
||||||
│ └── assets/ # Static assets
|
│ ├── lib/ # API 客户端和工具
|
||||||
├── src-tauri/ # Rust backend
|
│ ├── locales/ # 国际化文件
|
||||||
|
│ └── assets/ # 静态资源
|
||||||
|
├── src-tauri/ # Rust 后端
|
||||||
│ ├── src/
|
│ ├── src/
|
||||||
│ │ ├── commands/ # Tauri command handlers
|
│ │ ├── commands/ # Tauri 命令处理器
|
||||||
│ │ ├── checkpoint/ # Timeline management
|
│ │ │ ├── relay_stations.rs # 中转站管理
|
||||||
│ │ └── process/ # Process management
|
│ │ │ └── relay_adapters.rs # 中转站适配器
|
||||||
│ └── tests/ # Rust test suite
|
│ │ ├── checkpoint/ # 时间线管理
|
||||||
└── public/ # Public assets
|
│ │ └── process/ # 进程管理
|
||||||
|
│ └── tests/ # Rust 测试套件
|
||||||
|
└── public/ # 公共资源
|
||||||
```
|
```
|
||||||
|
|
||||||
### Development Commands
|
### 开发命令
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Start development server
|
# 启动开发服务器
|
||||||
bun run tauri dev
|
bun run tauri dev
|
||||||
|
|
||||||
# Run frontend only
|
# 仅运行前端
|
||||||
bun run dev
|
bun run dev
|
||||||
|
|
||||||
# Type checking
|
# 类型检查
|
||||||
bunx tsc --noEmit
|
bunx tsc --noEmit
|
||||||
|
|
||||||
# Run Rust tests
|
# 运行 Rust 测试
|
||||||
cd src-tauri && cargo test
|
cd src-tauri && cargo test
|
||||||
|
|
||||||
# Format code
|
# 格式化代码
|
||||||
cd src-tauri && cargo fmt
|
cd src-tauri && cargo fmt
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔒 Security
|
## 🔒 安全性
|
||||||
|
|
||||||
Claudia prioritizes your privacy and security:
|
Claudia 优先考虑您的隐私和安全：
|
||||||
|
|
||||||
1. **Process Isolation**: Agents run in separate processes
|
1. **进程隔离**：代理在独立进程中运行
|
||||||
2. **Permission Control**: Configure file and network access per agent
|
2. **权限控制**：为每个代理配置文件和网络访问
|
||||||
3. **Local Storage**: All data stays on your machine
|
3. **本地存储**：所有数据都保存在您的机器上
|
||||||
4. **No Telemetry**: No data collection or tracking
|
4. **无遥测**：无数据收集或跟踪
|
||||||
5. **Open Source**: Full transparency through open source code
|
5. **开源**：通过开源代码实现完全透明
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 贡献
|
||||||
|
|
||||||
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
我们欢迎贡献！请查看我们的[贡献指南](CONTRIBUTING.md)了解详情。
|
||||||
|
|
||||||
### Areas for Contribution
|
### 贡献领域
|
||||||
|
|
||||||
- 🐛 Bug fixes and improvements
|
- 🐛 Bug 修复和改进
|
||||||
- ✨ New features and enhancements
|
- ✨ 新功能和增强
|
||||||
- 📚 Documentation improvements
|
- 📚 文档改进
|
||||||
- 🎨 UI/UX enhancements
|
- 🎨 UI/UX 增强
|
||||||
- 🧪 Test coverage
|
- 🧪 测试覆盖
|
||||||
- 🌐 Internationalization
|
- 🌐 国际化
|
||||||
|
|
||||||
## 📄 License
|
## 📄 许可证
|
||||||
|
|
||||||
This project is licensed under the AGPL License - see the [LICENSE](LICENSE) file for details.
|
本项目根据 AGPL 许可证授权 - 有关详细信息，请参阅 [LICENSE](LICENSE) 文件。
|
||||||
|
|
||||||
## 🙏 Acknowledgments
|
## 🙏 致谢
|
||||||
|
|
||||||
- Built with [Tauri](https://tauri.app/) - The secure framework for building desktop apps
|
- 使用 [Tauri](https://tauri.app/) 构建 - 用于构建桌面应用的安全框架
|
||||||
- [Claude](https://claude.ai) by Anthropic
|
- [Claude](https://claude.ai) by Anthropic
|
||||||
|
- 原始项目 by [Asterisk 的 Claudia](https://github.com/getAsterisk/claudia)
|
||||||
|
- 参考项目：
|
||||||
|
- [Claude Suite](https://github.com/xinhai-ai/claude-suite) - Claude-Suite 中转站
|
||||||
|
- [PackyCode Cost](https://github.com/94mashiro/packycode-cost) - PackyCode 额度查询
|
||||||
|
- 中文化和新功能 by [YovinChen](https://github.com/yovinchen)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<p>
|
<p>
|
||||||
<strong>Made with ❤️ by the <a href="https://asterisk.so/">Asterisk</a></strong>
|
<strong>由 <a href="https://github.com/yovinchen">YovinChen</a> 基于 <a href="https://asterisk.so/">Asterisk</a> 的项目改进 ❤️</strong>
|
||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<a href="https://github.com/getAsterisk/claudia/issues">Report Bug</a>
|
<a href="https://github.com/yovinchen/claudia/issues">报告 Bug</a>
|
||||||
·
|
·
|
||||||
<a href="https://github.com/getAsterisk/claudia/issues">Request Feature</a>
|
<a href="https://github.com/yovinchen/claudia/issues">请求功能</a>
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
## Star History
|
## Star History
|
||||||
|
|
||||||
[](https://www.star-history.com/#getAsterisk/claudia&Date)
|
[](https://www.star-history.com/#yovinchen/claudia&Date)
|
||||||
|
|||||||
Reference in New Issue
Block a user