Flatastic CLI

用于管理Flatastic（WG应用）中共享家庭事务的命令行工具。

安装

bash
cd ~/Projects/flatastic-cli
npm install
npm run build
npm link

链接后，flatastic 即可全局使用。

设置

bash
flatastic auth # 使用邮箱/密码登录
flatastic refresh # 从服务器刷新WG数据

令牌 + 用户/WG信息保存至 ~/.config/flatastic/config.json

命令

家务

bash
flatastic chores # 列出所有家务及负责人、积分、截止日期
flatastic done <搜索词> # 标记家务为已完成（部分名称匹配）
flatastic remind <搜索词> # 发送家务提醒通知
flatastic stats # 显示家务统计与排行榜
flatastic history # 显示家务完成历史
flatastic history -l 50 # 显示最近50条记录

购物清单

bash
flatastic shop # 显示待办项目（快捷方式）
flatastic shop -a # 显示所有项目（包括已购买）

flatastic shopping list # 显示待办项目
flatastic shopping add 牛奶 # 添加项目到清单
flatastic shopping done 牛奶 # 标记项目为已购买
flatastic shopping delete 牛奶 # 从清单中删除项目
flatastic shopping clear # 清除所有已购买项目

支出/财务

bash
flatastic expenses # 显示近期支出
flatastic expenses -l 20 # 显示最近20笔支出
flatastic balances # 显示谁欠谁钱
flatastic expense 披萨 24.50 # 添加支出，与所有人分摊
flatastic expense 出租车 15 -s 大卫 # 仅与大卫分摊

WG信息

bash
flatastic wg # 显示WG信息和室友积分

喊话（消息/公告板）

bash
flatastic shouts # 显示最近的喊话
flatastic shout 披萨到了！ # 发布新喊话

使用示例

今天有什么安排？
bash
flatastic chores

把吸尘打勾完成
bash
flatastic done 吸尘

提醒一下倒垃圾的事
bash
flatastic remind 垃圾

谁积分最多？
bash
flatastic stats

我还需要买什么？
bash
flatastic shop

把牛奶加到清单上
bash
flatastic shopping add 牛奶

我买过了
bash
flatastic shopping done 牛奶

谁欠谁钱？
bash
flatastic balances

我付了24欧买披萨
bash
flatastic expense 披萨 24

发现的API端点

家务

• - GET /chores — 列出所有家务
• GET /chores/next?id=&userId=&completedBy= — 标记为已完成
• GET /chores/remind?id= — 发送提醒
• GET /chores/statistics — 获取积分统计
• GET /chores/history — 完成历史
• POST /chores — 创建新家务
• POST /chores/update — 更新家务
• DELETE /chores/id/:id — 删除家务

购物

• - GET /shoppinglist — 列出所有项目
• POST /shoppinglist — 添加项目 {name: ...}
• GET /shoppinglist/toggleitem?id= — 切换购买状态
• DELETE /shoppinglist/item/:id — 删除项目
• POST /shoppinglist/deletebought_items — 清除已购买项目

支出（现金流）

• - GET /cashflow?offset=&limit= — 列出支出
• GET /cashflow/settlement — 谁欠谁钱
• GET /cashflow/statistics — 支出统计
• POST /cashflow — 添加支出
• DELETE /cashflow/id/:id — 删除支出

喊话

• - GET /shouts — 列出喊话
• POST /shouts — 发布喊话 {shout: ...}
• DELETE /shouts/id/:id — 删除喊话

WG

• - GET /wg — WG信息及室友

配置文件

~/.config/flatastic/config.json:
json
{
token: ...,
user: { id: ..., firstName: ..., chorePoints: ... },
wg: {
name: ...,
flatmates: [{ id: ..., firstName: ... }, ...]
}
}

备注

• - 所有命令支持部分名称匹配（不区分大小写）
• 支出金额单位为欧元（例如 24.50 或 24,50）
• 提醒会向指定人员发送推送通知