EcoPaste 跨平台剪贴板管理工具技术文档

1. 安装指南

Windows 系统安装

1. 访问项目发布页面下载对应架构的安装包（x86/x64/ARM64）
2. 双击下载的.exe文件运行安装程序
3. 按照安装向导提示完成安装
4. 安装完成后可在开始菜单找到EcoPaste应用

MacOS 系统安装

手动安装方式：

1. 根据芯片类型下载Apple Silicon或Intel版本
2. 打开下载的.dmg文件
3. 将应用图标拖拽到Applications文件夹

Homebrew安装方式：

1. 打开终端执行命令：brew install ecopaste
2. 安装完成后可在Launchpad中找到应用

Linux系统安装

Debian/Ubuntu系统：

1. 下载.deb安装包
2. 执行命令：sudo dpkg -i ecopaste_*.deb
3. 如有依赖问题执行：sudo apt-get install -f

AppImage通用安装：

1. 下载AppImage文件
2. 添加执行权限：chmod +x EcoPaste-*.AppImage
3. 直接运行：./EcoPaste-*.AppImage

2. 使用说明

基础功能

1. 剪贴板历史记录：

   • 自动记录所有复制内容
   • 按时间倒序排列显示
   • 点击条目可快速粘贴内容

2. 内容类型支持：

   • 纯文本（支持Markdown预览）
   • 富文本（保留原始格式）
   • HTML内容（可渲染查看）
   • 图片（支持缩略图预览）
   • 文件（显示文件类型图标）

3. 搜索与过滤：

   • 支持关键词搜索
   • 可按内容类型筛选
   • 支持时间范围过滤

高级功能

1. 内容备注：

   • 为剪贴板条目添加描述
   • 支持Markdown格式备注
   • 备注内容可参与搜索

2. 收藏管理：

   • 标记重要内容为收藏
   • 单独查看收藏条目
   • 收藏内容永久保留

3. 数据安全：

   • 所有数据本地存储
   • 支持数据加密选项
   • 可设置自动清理策略

3. API使用文档

核心API接口

1. 监听剪贴板变化：

   window.ecopaste.onClipboardChange((content) => {
     console.log('剪贴板内容变化:', content);
   });
   

2. 写入剪贴板：

   window.ecopaste.writeToClipboard({
     text: '示例文本',
     html: '<b>示例HTML</b>',
     rtf: '{\\rtf1\\ansi\\ansicpg936\\deff0\\deflang1033\\deflangfe2052{\\fonttbl{\\f0\\fnil\\fcharset134 \\\'cb\\\'ce\\\'cc\\\'e5;}}'
   });
   

3. 获取历史记录：

   const history = await window.ecopaste.getHistory({
     limit: 50,
     offset: 0,
     type: 'text'
   });
   

配置API

1. 获取配置：

   const config = await window.ecopaste.getConfig();
   

2. 更新配置：

   await window.ecopaste.updateConfig({
     maxHistoryItems: 200,
     autoCleanDays: 30,
     enableEncryption: true
   });
   

4. 项目安装方式详解

开发环境搭建

1. 前置要求：

   • Node.js v18+
   • Rust 1.70+
   • pnpm 8.x

2. 克隆仓库：

   git clone https://github.com/EcoPasteHub/EcoPaste.git
   cd EcoPaste
   

3. 安装依赖：

   pnpm install
   

4. 开发运行：

   pnpm tauri dev
   

生产构建

1. 构建应用：

   pnpm tauri build
   

2. 构建产物位置：

   • Windows：src-tauri/target/release/bundle/msi/
   • MacOS：src-tauri/target/release/bundle/dmg/
   • Linux：src-tauri/target/release/bundle/appimage/

自定义构建

1. 修改应用图标：

   • 替换public/logo.png文件
   • 运行pnpm tauri icon重新生成图标集

2. 修改应用名称：

   • 编辑src-tauri/tauri.conf.json中的productName字段
   • 重新执行构建命令