ezBookkeeping API Tools

💰 自托管记账的命令行利器

通过命令行脚本操作自托管记账工具ezBookkeeping,支持记账、查询、汇率获取等功能,需配置API令牌。

收藏
10k
安装
3.3k
版本
1.4.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

ezBookkeeping API Tools 是一套命令行脚本工具,用于与自托管的个人记账应用 ezBookkeeping 进行交互。用户可通过 ebktools.sh(Linux/macOS)或 ebktools.ps1(Windows)执行多种财务操作,包括:记录新交易、查询历史交易、获取账户信息、检索分类与标签、以及获取汇率数据。

使用前需配置两个必要环境变量:EBKTOOL_SERVER_BASEURL(服务器地址)和 EBKTOOL_TOKEN(API 令牌),可通过系统环境变量或用户主目录的 .env 文件设置。

显著优点

1. 自托管隐私保障:数据完全由用户掌控,无需上传至第三方云服务
2. 跨平台支持:提供 Bash 和 PowerShell 双版本脚本,覆盖主流操作系统

3. 功能完整:涵盖记账核心场景(交易记录、查询、分类管理、汇率参考)

4. 命令行高效性:适合自动化脚本、批量操作和开发工作流集成

潜在缺点与局限性

  • 部署门槛:需自行搭建 ezBookkeeping 服务端,对非技术用户有学习成本
  • 令牌安全管理EBKTOOL_TOKEN 相当于账户凭证,泄露将导致财务数据风险
  • 无图形界面:纯命令行交互,不适合偏好可视化操作的用户
  • 网络依赖:所有操作需连接自托管服务器,离线无法使用

适合人群

  • 注重数据隐私的技术用户
  • 已使用或计划部署 ezBookkeeping 的开发者
  • 需要将记账操作集成到自动化工作流的高级用户
  • 偏好命令行效率的极简主义者

常规风险

  • 令牌泄露风险:API 令牌需妥善保管,避免硬编码在共享代码或日志中
  • 服务器安全责任:自托管意味着用户自行承担服务器安全防护(HTTPS、访问控制等)
  • 数据备份义务:无云服务商兜底,需自行建立备份机制

安全解读

核心用法

ezBookkeeping API Tools 是一个 POSIX Shell 编写的命令行工具,用于与自托管个人财务管理应用 ezBookkeeping 进行 API 交互。用户需配置 EBKTOOL_SERVER_BASEURLEBKTOOL_TOKEN 环境变量或 .env 文件,通过 ebktools.shebktools.ps1 脚本执行各类操作。

核心功能模块

  • 账户管理accounts-list 查询账户信息,accounts-add 添加新账户
  • 交易管理transactions-list / transactions-list-all 查询交易,transactions-add 创建新交易
  • 分类标签transaction-categories-list/addtransaction-tags-list/add 管理交易分类体系
  • Token 管理tokens-list 查看会话,tokens-revoke 撤销指定 Token
  • 辅助功能exchangerates-latest 查询汇率,server-version 获取服务器版本

技术特性

  • 依赖标准 Unix 工具链(curl、jq、grep、sed、awk、date)
  • 支持时区配置(--tz-name--tz-offset
  • 双重输出模式:Markdown 表格(默认)或原始 JSON(--raw-response
  • 参数类型验证(整数、布尔值、地理位置)与 URL 编码防护

显著优点

1. 自托管数据主权:用户完全掌控财务数据存储位置,避免 SaaS 服务的隐私风险
2. 轻量无依赖:仅依赖系统标准工具,无需额外运行时或库

3. 安全防护机制:Bearer Token 认证、参数 URL 编码、输入类型验证、环境变量隔离敏感信息

4. 功能完整:覆盖个人财务管理的 CRUD 全场景,支持多币种汇率查询

5. 跨平台支持:提供 POSIX Shell 和 PowerShell 双版本

潜在缺点与局限性

1. 写操作风险高transactions-addaccounts-add 等命令直接修改财务数据,误操作可能导致数据损坏
2. Token 管理双刃剑tokens-revoke 可终止任意会话,存在意外踢出其他客户端的风险

3. Shell 注入隐患:虽经 URL 编码缓解,但 Shell 脚本本质存在命令注入攻击面

4. 证书验证依赖系统:curl 未强制证书验证,依赖系统默认配置

5. 无内置备份机制:写操作前需用户自行确保数据备份

6. 地理位置合规geoLocation 参数涉及敏感个人信息,需用户自行评估 GDPR/CCPA 合规性

适合人群

  • 技术型个人用户:熟悉命令行操作,具备自托管服务器维护能力
  • 隐私敏感用户:不愿将财务数据托管至第三方云服务
  • 开发者/自动化需求:需要将记账流程集成到脚本或 CI/CD 流水线
  • 多币种使用者:需要实时汇率转换支持的国际收支管理

常规风险

| 风险类型 | 具体表现 | 缓解建议 |
|---------|---------|---------|
| 数据完整性风险 | API 调用错误导致财务记录错误 | 写操作前复核参数、定期备份、开启审计日志 |
| 访问控制风险 | Token 泄露或权限过大 | 使用最小权限 Token、90 天轮换、限制 `.env` 文件权限(chmod 600) |
| 会话中断风险 | `tokens-revoke` 误操作 | 确认 Token ID 后再执行、避免自动化清理 |
| 隐私合规风险 | 地理位置数据收集 | 建立 ROPA 记录、获取明确同意、提供数据导出机制 |
| 网络安全风险 | HTTP 传输或证书未验证 | 强制 HTTPS、部署可信证书、定期安全审计 |

ezBookkeeping API Tools 内容

scripts文件夹
手动下载zip · 21.8 kB
ebktools.ps1text/plain
请选择文件