Skip to content

EXAMPLES.md

Latest commit

 

History

History
397 lines (290 loc) · 8.22 KB

EXAMPLES.md

File metadata and controls

397 lines (290 loc) · 8.22 KB

News4Coder 使用示例

本文档展示了 news4coder 的常用使用场景和工作流。

核心理念: News4Coder 坚持本地优先和数据主权。所有数据存储在本地 SQLite 数据库（~/.news4coder/），无需云端账号，你的数据永远属于你。

目录

快速开始

1. 安装与配置

# 克隆仓库
git clone <repository-url>
cd news4coder

# 编译项目
go build -o news4coder

# 首次运行会自动创建配置目录 ~/.news4coder/
./news4coder --help

2. 配置 LLM（可选但推荐）

编辑 ~/.news4coder/config.json：

{
  "llm": {
    "base_url": "https://api.openai.com/v1",
    "api_key": "sk-your-api-key",
    "model": "gpt-4o-mini",
    "embedding_model": "text-embedding-3-small",
    "enrich_max_tokens": 2000,
    "ask_max_tokens": 4000
  }
}

💡 提示: 支持任何 OpenAI 兼容接口，包括 Ollama 本地服务（http://localhost:11434/v1）。

3. 同步官方源

# 查看可用的官方源
./news4coder sources

# 同步所有官方源到本地数据库
./news4coder sync

输出示例：

⟳ 正在同步 Hacker News ...
  ✓ 新增 30 条，更新 5 条重复
⟳ 正在同步 GitHub Blog ...
  ✓ 新增 5 条，更新 0 条重复
...
✓ 同步完成：新增 60 条，更新 10 条
💡 下一步建议: news4coder enrich  生成 LLM 摘要和标签

4. 查看已同步的文章

# 列出最近的文章
./news4coder list --articles

# 仅查看未读文章
./news4coder list --articles --status unread

# 查看收藏的文章
./news4coder list --articles --status starred

日常使用工作流

场景 1: 早晨资讯同步（5分钟）

# 1. 同步所有官方源
./news4coder sync

# 2. 对新文章进行 LLM 增强（生成摘要、标签、评分）
./news4coder enrich --limit 20

# 3. 查看智能策展的今日必读
./news4coder curate --top 10

场景 2: 深度阅读工作流

# 1. 进入 TUI 收件箱浏览文章
./news4coder inbox

在 TUI 中：

  • j/k 或 ↓/↑ - 浏览文章
  • r - 标记为已读
  • s - 收藏
  • d - 丢弃
  • a - 归档
  • 1/2/3 - 切换视图（全部/未读/收藏）
  • q - 退出
# 2. 为重要文章添加笔记
./news4coder note <article-id> "核心观点记录..."

# 3. 添加自定义标签
./news4coder tag <article-id> "golang,concurrency"

场景 3: 知识库问答

# 基于本地知识库回答问题
./news4coder ask "Go 和 Rust 在并发模型上有什么差异？"

./news4coder ask "最近关于微服务架构有哪些最佳实践？"

输出示例：

⟳ 正在检索知识库并生成回答...

回答：
Go 和 Rust 在并发模型上有以下主要差异...

━━━ 引用来源 ━━━
[1] Go 并发模式详解 (Hacker News)
    https://...
[2] Rust 异步编程指南 (GitHub Blog)
    https://...

💡 提示: 知识库内容越丰富，回答质量越高。建议定期执行 sync + enrich。

场景 4: 全文搜索

# 搜索本地知识库
./news4coder search "kubernetes"

./news4coder search "微服务架构"

场景 5: 导出与备份

# 导出收藏的文章为 Markdown
./news4coder export --status starred --output my-favorites.md

# 导出已读文章
./news4coder export --status read --output read-articles.md

场景 6: 定期维护

# 查看订阅健康度
./news4coder stats

# 归档所有已读文章
./news4coder archive

# 清理过期文章（丢弃超过7天、归档超过30天）
./news4coder cleanup

LLM 配置

使用 OpenAI

{
  "llm": {
    "base_url": "https://api.openai.com/v1",
    "api_key": "sk-xxxxxxxx",
    "model": "gpt-4o-mini",
    "embedding_model": "text-embedding-3-small"
  }
}

使用 Ollama（本地 LLM）

{
  "llm": {
    "base_url": "http://localhost:11434/v1",
    "api_key": "ollama",
    "model": "llama3.2",
    "embedding_model": "nomic-embed-text"
  }
}

使用其他服务商

// DeepSeek
{
  "llm": {
    "base_url": "https://api.deepseek.com/v1",
    "api_key": "sk-xxxxxxxx",
    "model": "deepseek-chat"
  }
}

// 其他兼容 OpenAI API 的服务
{
  "llm": {
    "base_url": "https://your-api-endpoint/v1",
    "api_key": "your-key",
    "model": "your-model"
  }
}

数据管理

数据存储位置

所有数据存储在本地，默认位置：

平台 路径
macOS ~/.news4coder/
Linux ~/.news4coder/
Windows C:\Users\<用户名>\.news4coder\

文件说明

~/.news4coder/
├── config.json          # LLM 配置
├── news4coder.db        # SQLite 数据库（文章、阅读状态、全文索引）
└── subscriptions.json   # 旧订阅配置（已弃用）

备份数据

# 直接备份数据库文件
cp ~/.news4coder/news4coder.db ~/backups/news4coder-$(date +%Y%m%d).db

# 或使用 export 导出 Markdown
./news4coder export --output backup.md

数据可移植性

SQLite 数据库是标准的单文件格式，可以：

  • 在不同设备间复制
  • 使用任何 SQLite 工具查看
  • 导出为 SQL 或 CSV

常见问题

Q: 为什么数据要存储在本地？

A: News4Coder 坚持「本地优先」和「数据主权」理念：

  • ✅ 隐私: 无需账号，数据不上传云端
  • ✅ 永久可用: 不受服务商倒闭影响
  • ✅ 可导出: 随时备份或迁移
  • ✅ 离线使用: 没有网络也能访问已同步内容

Q: 不配置 LLM 能用吗？

A: 可以。不配置 LLM 也能：

  • 同步和阅读文章
  • 管理阅读状态
  • 搜索本地文章
  • 导出文章

但无法使用：

  • enrich - 自动生成摘要和标签
  • curate - 智能策展
  • ask - RAG 问答

Q: 如何添加自定义订阅源？

A: 目前主要支持内置的 8 个官方源。自定义源功能正在开发中。

Q: 数据库会占用多大空间？

A: 取决于同步的文章数量。通常：

  • 1000 篇文章约 10-20 MB
  • 包含全文索引，支持快速搜索

Q: 如何清理空间？

A: 定期执行：

# 清理旧文章
./news4coder cleanup

# 手动删除丢弃的文章
./news4coder list --articles --status discarded
# 然后使用 remove 命令（如支持）或手动删除数据库

Q: 如何查看某个命令的帮助？

A: 使用 --help 参数：

./news4coder --help
./news4coder sync --help
./news4coder enrich --help

高级技巧

组合命令

# 同步后立即增强
./news4coder sync && ./news4coder enrich

# 策展后进入收件箱
./news4coder curate --top 10 && ./news4coder inbox

使用别名

在 ~/.bashrc 或 ~/.zshrc 中添加：

alias n4c='./news4coder'
alias n4c-sync='./news4coder sync'
alias n4c-inbox='./news4coder inbox'
alias n4c-ask='./news4coder ask'

定时自动同步

使用 cron（Linux/macOS）：

# 每天早上 8 点同步
0 8 * * * cd /path/to/news4coder && ./news4coder sync >> ~/.news4coder/sync.log 2>&1

完整命令参考

命令 说明 示例
sync 同步官方源 news4coder sync --source hn
enrich LLM 增强 news4coder enrich --limit 10
curate 智能策展 news4coder curate --top 10
ask RAG 问答 news4coder ask "问题"
inbox TUI 收件箱 news4coder inbox
list 列出文章 news4coder list -a --status unread
read 标记已读 news4coder read 1 2 3
star 收藏 news4coder star 42
discard 丢弃 news4coder discard 5 6
archive 批量归档 news4coder archive
search 全文搜索 news4coder search "golang"
stats 订阅健康度 news4coder stats
note 添加笔记 news4coder note 42 "笔记"
tag 添加标签 news4coder tag 42 "tag1,tag2"
export 导出文章 news4coder export --status starred
cleanup 清理旧文章 news4coder cleanup
sources 查看官方源 news4coder sources

享受你的本地优先技术阅读体验！ 🚀