owner stringclasses 603
values | repo stringclasses 778
values | repo_dir stringclasses 830
values | file_rel_repo stringlengths 6 222 | file_rel_outdir stringlengths 16 235 | size int64 0 2.36M | mtime int64 1.76B 1.76B | lang stringclasses 10
values | content stringlengths 0 2.36M | updated_at stringdate 2025-09-24 14:46:58 2025-09-24 14:46:58 |
|---|---|---|---|---|---|---|---|---|---|
hoppscotch | hoppscotch | hoppscotch__hoppscotch | README.md | hoppscotch__hoppscotch/README.md | 11,659 | 1,758,620,342 | en | <div align="center">
<a href="https://hoppscotch.io">
<img
src="https://avatars.githubusercontent.com/u/56705483"
alt="Hoppscotch"
height="64"
/>
</a>
<h3>
<b>
Hoppscotch
</b>
</h3>
<b>
Open Source API Development Ecosystem
</b>
<p>
[![contributions welcome](ht... | 2025-09-24T14:46:58.085215 |
Mintplex-Labs | anythingllm-docs | Mintplex-Labs__anythingllm-docs | README.md | Mintplex-Labs__anythingllm-docs/README.md | 1,723 | 1,758,118,064 | la | <a name="readme-top"></a>
<p align="center">
<a href="https://anythingllm.com"><img src="https://github.com/Mintplex-Labs/anything-llm/blob/master/images/wordmark.png?raw=true" alt="AnythingLLM logo"></a>
</p>
## Project Structure
```
├── public/
│ ├── images/
│ │ ├── anythingllm-setup/
│ │ ├── cloud/
│... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | README.md | CherryHQ__cherry-studio/README.md | 21,328 | 1,758,620,022 | en | <div align="right" >
<details>
<summary >🌐 Language</summary>
<div>
<div align="right">
<p><a href="https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=en">English</a></p>
<p><a href="https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/README.zh.md | CherryHQ__cherry-studio/docs/README.zh.md | 16,221 | 1,758,202,168 | en | <div align="right" >
<details>
<summary >🌐 Language</summary>
<div>
<div align="right">
<p><a href="https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang=en">English</a></p>
<p><a href="https://openaitx.github.io/view.html?user=CherryHQ&project=cherry-studio&lang... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/branching-strategy-zh.md | CherryHQ__cherry-studio/docs/branching-strategy-zh.md | 2,362 | 1,758,202,168 | en | # 🌿 分支策略
Cherry Studio 采用结构化的分支策略来维护代码质量并简化开发流程。
## 主要分支
- `main`：主开发分支
- 包含最新的开发代码
- 禁止直接提交 - 所有更改必须通过拉取请求（Pull Request）
- 此分支上的代码可能包含正在开发的功能，不一定完全稳定
- `release/*`：发布分支
- 从 `main` 分支创建
- 包含准备发布的稳定代码
- 只接受文档更新和 bug 修复
- 经过完整测试后可以发布到生产环境
关于测试计划所使用的`testplan`分支，请查阅[测试计划](testplan-zh.md)。
## 贡献分支
在为... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/dev.md | CherryHQ__cherry-studio/docs/dev.md | 893 | 1,758,202,168 | en | # 🖥️ Develop
## IDE Setup
- Editor: [Cursor](https://www.cursor.com/), etc. Any VS Code compatible editor.
- Linter: [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- Formatter: [Biome](https://marketplace.visualstudio.com/items?itemName=biomejs.biome)
## Project Setup
### Inst... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/branching-strategy-en.md | CherryHQ__cherry-studio/docs/branching-strategy-en.md | 2,421 | 1,758,202,168 | en | # 🌿 Branching Strategy
Cherry Studio implements a structured branching strategy to maintain code quality and streamline the development process.
## Main Branches
- `main`: Main development branch
- Contains the latest development code
- Direct commits are not allowed - changes must come through pull requests
... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/testplan-en.md | CherryHQ__cherry-studio/docs/testplan-en.md | 5,872 | 1,758,202,168 | en | # Test Plan
To provide users with a more stable application experience and faster iteration speed, Cherry Studio has launched the "Test Plan".
## User Guide
The Test Plan is divided into the RC channel and the Beta channel, with the following differences:
- **RC (Release Candidate)**: The features are stable, with ... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/testplan-zh.md | CherryHQ__cherry-studio/docs/testplan-zh.md | 4,738 | 1,758,202,168 | en | # 测试计划
为了给用户提供更稳定的应用体验，并提供更快的迭代速度，Cherry Studio推出“测试计划”。
## 用户指南
测试计划分为RC版通道和Beta版通道吗，区别在于：
- **RC版（预览版）**：RC即Release Candidate，功能已经稳定，BUG较少，接近正式版
- **Beta版（测试版）**：功能可能随时变化，BUG较多，可以较早体验未来功能
用户可以在软件的`设置`-`关于`中，开启“测试计划”并选择版本通道。请注意“测试计划”的版本无法保证数据的一致性，请使用前一定要备份数据。
用户在测试过程中发现的BUG，欢迎提交issue或通过其他渠道反馈。用户的反馈对我们非常重要。
## 开... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/CONTRIBUTING.zh.md | CherryHQ__cherry-studio/docs/CONTRIBUTING.zh.md | 4,802 | 1,758,202,168 | en | # Cherry Studio 贡献者指南
[**English**](../CONTRIBUTING.md) | [**中文**](CONTRIBUTING.zh.md)
欢迎来到 Cherry Studio 的贡献者社区！我们致力于将 Cherry Studio 打造成一个长期提供价值的项目，并希望邀请更多的开发者加入我们的行列。无论您是经验丰富的开发者还是刚刚起步的初学者，您的贡献都将帮助我们更好地服务用户，提升软件质量。
## 如何贡献
以下是您可以参与的几种方式：
1. **贡献代码**：帮助我们开发新功能或优化现有代码。请确保您的代码符合我们的编码标准，并通过所有测试。
2. **修复 BUG**：如果您发现... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/sponsor.md | CherryHQ__cherry-studio/docs/sponsor.md | 168 | 1,758,202,168 | en | # Sponsor
<div align="center">
<img src="https://github.com/user-attachments/assets/4665f07f-5ecc-4bd8-8727-ae00f35d6d98" alt="Buy Me a Coffee" width="280"/>
</div>
| 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/features/memory-guide-zh.md | CherryHQ__cherry-studio/docs/features/memory-guide-zh.md | 7,126 | 1,758,202,168 | en | # Cherry Studio 记忆功能指南
## 功能介绍
Cherry Studio 的记忆功能是一个强大的工具，能够帮助 AI 助手记住对话中的重要信息、用户偏好和上下文。通过记忆功能，您的 AI 助手可以：
- 📝 **记住重要信息**：自动从对话中提取并存储关键事实和信息
- 🧠 **个性化响应**：基于存储的记忆提供更加个性化和相关的回答
- 🔍 **智能检索**：在需要时自动搜索相关记忆，增强对话的连贯性
- 👥 **多用户支持**：为不同用户维护独立的记忆上下文
记忆功能特别适用于需要长期保持上下文的场景，例如个人助手、客户服务、教育辅导等。
## 如何启用记忆功能
### 1. 全局配置（首次设... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/code-execution.md | CherryHQ__cherry-studio/docs/technical/code-execution.md | 6,737 | 1,758,202,168 | en | # 代码执行功能
本文档说明了代码块的 Python 代码执行功能。该实现利用 [Pyodide][pyodide-link] 在浏览器环境中直接运行 Python 代码，并将其置于 Web Worker 中，以避免阻塞主 UI 线程。
整个实现分为三个主要部分：UI 层、服务层和 Worker 层。
## 执行流程图
```mermaid
sequenceDiagram
participant 用户
participant CodeBlockView (UI)
participant PyodideService (服务)
participant PyodideWorker (Worker)... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-i18n-zh.md | CherryHQ__cherry-studio/docs/technical/how-to-i18n-zh.md | 4,804 | 1,758,202,168 | en | # 如何优雅地做好 i18n
## 使用i18n ally插件提升开发体验
i18n ally是一个强大的VSCode插件，它能在开发阶段提供实时反馈，帮助开发者更早发现文案缺失和错译问题。
项目中已经配置好了插件设置，直接安装即可。
### 开发时优势
- **实时预览**：翻译文案会直接显示在编辑器中
- **错误检测**：自动追踪标记出缺失的翻译或未使用的key
- **快速跳转**：可通过key直接跳转到定义处（Ctrl/Cmd + click)
- **自动补全**：输入i18n key时提供自动补全建议
### 效果展示
... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-use-logger-zh.md | CherryHQ__cherry-studio/docs/technical/how-to-use-logger-zh.md | 10,841 | 1,758,202,168 | en | # 如何使用日志 LoggerService
这是关于如何使用日志的开发者文档。
CherryStudio使用统一的日志服务来打印和记录日志，**若无特殊原因，请勿使用`console.xxx`来打印日志**。
以下是详细说明。
## 在`main`进程中使用
### 引入
```typescript
import { loggerService } from '@logger'
```
### 设置module信息（规范要求）
在import头之后，设置：
```typescript
const logger = loggerService.withContext('moduleName')
```
- `mo... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/KnowledgeService.md | CherryHQ__cherry-studio/docs/technical/KnowledgeService.md | 6,020 | 1,758,202,168 | en | 我来详细介绍 KnowledgeService 中控制并发处理的项目数量和工作负载的部分。
## 并发控制与工作负载管理机制
KnowledgeService 实现了一个精细的任务队列系统，用于控制并发处理的项目数量和工作负载。这个系统主要通过以下几个关键部分实现：
### 1. 关键变量和限制
```typescript
private workload = 0
private processingItemCount = 0
private knowledgeItemProcessingQueueMappingPromise: Map<LoaderTaskOfSet, () => void> = new Map()
pri... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/db.translate_languages.md | CherryHQ__cherry-studio/docs/technical/db.translate_languages.md | 1,023 | 1,758,202,168 | en | # `translate_languages` 表技术文档
## 📄 概述
`translate_languages` 记录用户自定义的的语言类型（`Language`）。
### 字段说明
| 字段名 | 类型 | 是否主键 | 索引 | 说明 |
| ---------- | ------ | -------- | ---- | ------------------------------------------------------------------------ ... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-use-messageBlock.md | CherryHQ__cherry-studio/docs/technical/how-to-use-messageBlock.md | 6,426 | 1,758,202,168 | en | # messageBlock.ts 使用指南
该文件定义了用于管理应用程序中所有 `MessageBlock` 实体的 Redux Slice。它使用 Redux Toolkit 的 `createSlice` 和 `createEntityAdapter` 来高效地处理规范化的状态，并提供了一系列 actions 和 selectors 用于与消息块数据交互。
## 核心目标
- **状态管理**: 集中管理所有 `MessageBlock` 的状态。`MessageBlock` 代表消息中的不同内容单元（如文本、代码、图片、引用等）。
- **规范化**: 使用 `createEntityAdapter` 将 `Messa... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/Message.md | CherryHQ__cherry-studio/docs/technical/Message.md | 59 | 1,758,202,168 | en | # 消息的生命周期
| 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/CodeBlockView-zh.md | CherryHQ__cherry-studio/docs/technical/CodeBlockView-zh.md | 4,524 | 1,758,202,168 | en | # CodeBlockView 组件结构说明
## 概述
CodeBlockView 是 Cherry Studio 中用于显示和操作代码块的核心组件。它支持多种视图模式和特殊语言的可视化预览，提供丰富的交互工具。
## 组件结构
```mermaid
graph TD
A[CodeBlockView] --> B[CodeToolbar]
A --> C[SourceView]
A --> D[SpecialView]
A --> E[StatusBar]
B --> F[CodeToolButton]
C --> G[CodeEditor / CodeViewer]
... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/CodeBlockView-en.md | CherryHQ__cherry-studio/docs/technical/CodeBlockView-en.md | 4,733 | 1,758,202,168 | en | # CodeBlockView Component Structure
## Overview
CodeBlockView is the core component in Cherry Studio for displaying and manipulating code blocks. It supports multiple view modes and visual previews for special languages, providing rich interactive tools.
## Component Structure
```mermaid
graph TD
A[CodeBlockVie... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-use-useMessageOperations.md | CherryHQ__cherry-studio/docs/technical/how-to-use-useMessageOperations.md | 6,600 | 1,758,202,168 | en | # useMessageOperations.ts 使用指南
该文件定义了一个名为 `useMessageOperations` 的自定义 React Hook。这个 Hook 的主要目的是为 React 组件提供一个便捷的接口，用于执行与特定主题（Topic）相关的各种消息操作。它封装了调用 Redux Thunks (`messageThunk.ts`) 和 Actions (`newMessage.ts`, `messageBlock.ts`) 的逻辑，简化了组件与消息数据交互的代码。
## 核心目标
- **封装**: 将复杂的消息操作逻辑（如删除、重发、重新生成、编辑、翻译等）封装在易于使用的函数中。
- **简化*... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-write-middlewares.md | CherryHQ__cherry-studio/docs/technical/how-to-write-middlewares.md | 13,069 | 1,758,202,168 | en | # 如何为 AI Provider 编写中间件
本文档旨在指导开发者如何为我们的 AI Provider 框架创建和集成自定义中间件。中间件提供了一种强大而灵活的方式来增强、修改或观察 Provider 方法的调用过程，例如日志记录、缓存、请求/响应转换、错误处理等。
## 架构概览
我们的中间件架构借鉴了 Redux 的三段式设计，并结合了 JavaScript Proxy 来动态地将中间件应用于 Provider 的方法。
- **Proxy**: 拦截对 Provider 方法的调用，并将调用引导至中间件链。
- **中间件链**: 一系列按顺序执行的中间件函数。每个中间件都可以处理请求/响应，然后将控制权传递给链中的... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-i18n-en.md | CherryHQ__cherry-studio/docs/technical/how-to-i18n-en.md | 5,398 | 1,758,202,168 | en | # How to Do i18n Gracefully
> [!WARNING]
> This document is machine translated from Chinese. While we strive for accuracy, there may be some imperfections in the translation.
## Enhance Development Experience with the i18n Ally Plugin
i18n Ally is a powerful VSCode extension that provides real-time feedback during d... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-use-logger-en.md | CherryHQ__cherry-studio/docs/technical/how-to-use-logger-en.md | 13,295 | 1,758,202,168 | en | # How to use the LoggerService
This is a developer document on how to use the logger.
CherryStudio uses a unified logging service to print and record logs. **Unless there is a special reason, do not use `console.xxx` to print logs**.
The following are detailed instructions.
## Usage in the `main` process
### Impor... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/db.settings.md | CherryHQ__cherry-studio/docs/technical/db.settings.md | 527 | 1,758,202,168 | en | # 数据库设置字段
此文档包含部分字段的数据类型说明。
## 字段
| 字段名 | 类型 | 说明 |
| ------------------------------ | ------------------------------ | ------------ |
| `translate:target:language` | `LanguageCode` | 翻译目标语言 |
| `translate:source:language` | `LanguageCod... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/ImagePreview-en.md | CherryHQ__cherry-studio/docs/technical/ImagePreview-en.md | 5,564 | 1,758,202,168 | en | # Image Preview Components
## Overview
Image Preview Components are a set of specialized components in Cherry Studio for rendering and displaying various diagram and image formats. They provide a consistent user experience across different preview types with shared functionality for loading states, error handling, an... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/ImagePreview-zh.md | CherryHQ__cherry-studio/docs/technical/ImagePreview-zh.md | 4,849 | 1,758,202,168 | en | # 图像预览组件
## 概述
图像预览组件是 Cherry Studio 中用于渲染和显示各种图表和图像格式的专用组件集合。它们为不同预览类型提供一致的用户体验，具有共享的加载状态、错误处理和交互控制功能。
## 支持格式
- **Mermaid**: 交互式图表和流程图
- **PlantUML**: UML 图表和系统架构
- **SVG**: 可缩放矢量图形
- **Graphviz/DOT**: 图形可视化和网络图表
## 架构
```mermaid
graph TD
A[MermaidPreview] --> D[ImagePreviewLayout]
B[PlantUmlPreview] --... | 2025-09-24T14:46:58.085215 |
CherryHQ | cherry-studio | CherryHQ__cherry-studio | docs/technical/how-to-use-messageThunk.md | CherryHQ__cherry-studio/docs/technical/how-to-use-messageThunk.md | 7,604 | 1,758,202,168 | en | # messageThunk.ts 使用指南
该文件包含用于管理应用程序中消息流、处理助手交互以及同步 Redux 状态与 IndexedDB 数据库的核心 Thunk Action Creators。主要围绕 `Message` 和 `MessageBlock` 对象进行操作。
## 核心功能
1. **发送/接收消息**: 处理用户消息的发送，触发助手响应，并流式处理返回的数据，将其解析为不同的 `MessageBlock`。
2. **状态管理**: 确保 Redux store 中的消息和消息块状态与 IndexedDB 中的持久化数据保持一致。
3. **消息操作**: 提供删除、重发、重新生成、编辑后重发、追... | 2025-09-24T14:46:58.085215 |
End of preview. Expand in Data Studio
No dataset card yet
- Downloads last month
- 56