🚀 5分钟快速开始
本指南帮助你在 5 分钟内完成配置并开始使用 WeRead2Flomo。
💡 说明：如果只使用 GitHub Actions 自动同步，可跳过步骤 1 和步骤 3，直接查看步骤 2。
步骤 1：安装项目（1分钟）
# 克隆项目
git clone https://github.com/blessonism/weread2flomo.git
cd weread2flomo
# 安装依赖
pip install -r requirements.txt
步骤 2：获取必要的配置（2分钟）
2.1 获取 Flomo API
- 访问 Flomo 网页版
- 点击右上角头像 → API
- 复制 API 地址（格式：
https://flomoapp.com/iwh/xxxxx/）
2.2 获取微信读书 Cookie
方式 1：手动 Cookie
- 浏览器访问 微信读书网页版
- 使用微信扫码登录
- 按
F12 打开开发者工具
- 切换到
Application → Cookies → weread.qq.com
- 复制所有 Cookie 值
✨ 推荐：使用 Cookie Cloud 可实现自动更新，查看"Cookie Cloud"标签页了解详情。
步骤 3：配置环境变量（1分钟）
💡 说明：.env 文件仅用于本地测试，不会上传到 GitHub。如只使用 GitHub Actions 自动同步，可跳过此步骤，直接在 GitHub Secrets 中配置。
如需在本地测试，创建 .env 文件：
# Flomo API（必需）
FLOMO_API="https://flomoapp.com/iwh/你的API密钥/"
# 微信读书 Cookie（必需）
WEREAD_COOKIE="你的Cookie"
# 或使用 Cookie Cloud（推荐）
# CC_URL="https://cc.chenge.ink"
# CC_ID="你的UUID"
# CC_PASSWORD="你的密码"
# AI 功能（可选）
# AI_API_KEY="你的AI API Key"
步骤 4：测试运行（1分钟）
# 运行完整同步
python sync.py
步骤 5：查看结果
打开 Flomo，确认读书笔记已成功同步。
🎯 下一步：查看"自动化部署"标签页，设置 GitHub Actions 每天自动同步。
🍪 如何正确获取微信读书 Cookie
方法 1：从 Application 标签获取
- 打开 微信读书网页版
- 按
F12 打开开发者工具
- 切换到
Application 标签（Chrome）或 存储 标签（Firefox）
- 展开左侧的
Cookies 节点，点击 weread.qq.com
- 查看 cookie 获取示例 查看获取示例
⚠️ 注意：微信读书的 Cookie 通常 10 天左右过期。推荐使用 Cookie Cloud 实现自动更新。
☁️ Cookie Cloud 配置指南
Cookie Cloud 可自动同步浏览器 Cookie，无需手动更新。
步骤 2：选择服务器
方案 A：使用公共服务器
https://cc.chenge.ink
或
https://cookiecloud.malinkang.com/
方案 B：自建服务器
docker run -d -p=8088:8088 easychen/cookiecloud:latest
步骤 3：配置浏览器插件
- 点击浏览器中的 Cookie Cloud 插件图标
- 填写配置信息 查看配置步骤：
- 服务器地址：
https://cc.chenge.ink
- 用户 KEY（UUID）：插件自动生成，记录此值
- 端对端加密密码：设置密码并记录
- 在"同步域名关键词"中填入：
weread.qq.com
- 开启 Cookie 保活（可选）：
https://weread.qq.com/|60
- 设置为"上传模式"（从浏览器同步到服务器）
- 点击"保存并同步"
💡 提示：配置完成后，插件会自动同步浏览器的所有 Cookie 到云端服务器，无需手动操作。
步骤 5：配置项目
在 .env 文件或 GitHub Secrets 中添加配置：
# Cookie Cloud 配置
CC_URL="https://cc.chenge.ink"
CC_ID="你的UUID（从插件中复制）"
CC_PASSWORD="你的加密密码"
# Flomo API
FLOMO_API="你的Flomo API"
✨ 优势：自动更新、长期有效、多端同步、安全加密、自动容错。
⚙️ 完整配置指南
配置优先级：环境变量 > config.yaml > 默认值
必填配置
| 配置项 |
环境变量 |
说明 |
| Flomo API |
FLOMO_API |
从 Flomo 网站获取 |
| 微信读书 Cookie |
WEREAD_COOKIE |
手动获取或使用 Cookie Cloud |
| Cookie Cloud URL |
CC_URL |
Cookie Cloud 服务器地址 |
| Cookie Cloud ID |
CC_ID |
Cookie Cloud UUID |
| Cookie Cloud 密码 |
CC_PASSWORD |
Cookie Cloud 加密密码 |
同步配置
| 配置项 |
环境变量 |
默认值 |
说明 |
| 时间限制 |
SYNC_DAYS_LIMIT |
100 |
只同步最近X天的划线，0表示全部 |
| 最大划线数 |
SYNC_MAX_HIGHLIGHTS |
50 |
每次同步的最大划线数 |
| 同步笔记 |
SYNC_REVIEWS |
true |
是否同步笔记（除了划线） |
标签配置
| 配置项 |
环境变量 |
默认值 |
说明 |
| 书名标签 |
ADD_BOOK_TITLE_TAG |
true |
是否添加书名作为标签 |
| 作者标签 |
ADD_AUTHOR_TAG |
false |
是否添加作者作为标签 |
| AI标签 |
ENABLE_AI_TAGS |
false |
是否启用AI自动标签 |
| AI标签数量 |
MAX_AI_TAGS |
3 |
AI标签的最大数量 |
AI 配置
支持所有 OpenAI 兼容格式的 API，包括：
- OpenAI 官方
- Azure OpenAI
- 国内大模型服务（智谱AI、月之暗面、通义千问等）
- 自托管模型（Ollama、LocalAI 等）
# AI 服务提供商
AI_PROVIDER=openai # 可选: openai, local, none
# API Key（必填）
AI_API_KEY=sk-你的API密钥
# API Base URL（可选）
AI_API_BASE=https://api.openai.com/v1
# 模型名称（可选）
AI_MODEL=gpt-3.5-turbo
模板配置
提供简洁/标准/详细三种内置模板：
DEFAULT_TEMPLATE=detailed # 可选: simple, standard, detailed
也支持在 config.yaml 中完全自定义模板。
🤖 GitHub Actions 自动同步指南
配置 GitHub Actions 实现每天自动同步微信读书笔记到 Flomo。
💡 说明：本地 .env 文件仅用于本地测试，不会上传到 GitHub。GitHub Actions 使用 Secrets 配置，两种方式独立，可以只配置 Secrets 而不创建 .env 文件。
前置准备
- 有 GitHub 账号
- Fork 本项目到你的账号
- 有 Flomo API
- 有微信读书 Cookie 或 Cookie Cloud 配置
步骤 1：确认 Workflow 文件
💡 说明：Fork 的项目已包含 .github/workflows/sync.yml 文件，无需重新创建。
文件内容参考：
name: WeRead to Flomo Sync
on:
# 每天 UTC 00:00（北京时间 08:00）运行
schedule:
- cron: '0 0 * * *'
# 允许手动触发
workflow_dispatch:
jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: 📥 检出代码
uses: actions/checkout@v4
- name: 🐍 设置 Python
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'
- name: 📦 安装依赖
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: 🔄 运行同步
env:
CC_URL: ${{ secrets.CC_URL }}
CC_ID: ${{ secrets.CC_ID }}
CC_PASSWORD: ${{ secrets.CC_PASSWORD }}
WEREAD_COOKIE: ${{ secrets.WEREAD_COOKIE }}
FLOMO_API: ${{ secrets.FLOMO_API }}
AI_API_KEY: ${{ secrets.AI_API_KEY }}
run: |
python sync.py
- name: 💾 保存同步记录
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add synced_bookmarks.json
git diff --quiet && git diff --staged --quiet || \
(git commit -m "chore: 更新同步记录 [skip ci]" && git push)
步骤 2：配置 GitHub Secrets
- 进入仓库设置：点击顶部
Settings 标签
- 左侧菜单找到
Secrets and variables → Actions
- 点击
New repository secret 按钮
- 按照下表逐个添加 Secrets 查看配置步骤
| Secret 名称 |
必填 |
说明 |
CC_URL |
推荐 |
Cookie Cloud 服务器地址 |
CC_ID |
推荐 |
Cookie Cloud UUID |
CC_PASSWORD |
推荐 |
Cookie Cloud 密码 |
WEREAD_COOKIE |
备选 |
手动获取微信读书 Cookie |
FLOMO_API |
必需 |
Flomo API 地址 |
AI_API_KEY |
可选 |
AI 服务 API Key |
✨ 推荐：使用 Cookie Cloud 可自动更新 Cookie，无需手动维护。
步骤 3：初始化同步记录
在仓库中创建文件：synced_bookmarks.json
{
"synced_ids": [],
"last_sync": "2025-01-01T00:00:00",
"total_synced": 0
}
步骤 4：启用 GitHub Actions
- 点击仓库顶部的
Actions 标签
- 如看到提示，点击绿色按钮启用 Workflows
- 确认能看到
WeRead to Flomo Sync workflow
步骤 5：手动运行测试
- 在
Actions 页面，点击左侧 WeRead to Flomo Sync
- 右上方点击
Run workflow 下拉按钮
- 选择
Branch: main
- 点击绿色按钮
Run workflow 查看步骤
- 等待运行完成，查看日志确认成功
配置完成
系统将在每天早上 8 点（北京时间）自动同步微信读书笔记到 Flomo。
💡 说明：GitHub Actions 每月有 2000 分钟免费额度，本项目每次运行约 2-3 分钟，完全在免费额度内。
常见问题
Q: Actions 运行失败怎么办？
- 查看错误日志，检查 Secrets 配置是否正确
- 确认 Cookie 是否过期（推荐使用 Cookie Cloud）
- 检查 Flomo API 是否有效
Q: 如何修改运行时间？
编辑 .github/workflows/sync.yml 中的 cron 表达式：
# 每天早上 8 点（北京时间）
- cron: '0 0 * * *'
# 改为每天晚上 10 点（北京时间）
- cron: '0 14 * * *'
# 每 12 小时一次
- cron: '0 */12 * * *'
