splitwise-cli

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Splitwise CLI

Command-line interface for Splitwise — split bills, track shared expenses, and see who owes whom from the terminal.

Splitwise的命令行界面，可在终端中完成分摊账单、追踪共同开销、查询谁欠谁钱等操作。

Configuration

配置

Credentials from https://secure.splitwise.com/apps (Consumer Key, Consumer Secret, API Key). Set via env vars (

SPLITWISE_CONSUMER_KEY

, etc.) or

.env

所需凭证可从https://secure.splitwise.com/apps 获取（Consumer Key、Consumer Secret、API Key），可通过环境变量（

SPLITWISE_CONSUMER_KEY

等）或者

.env

文件设置。

Installation

安装

bash

undefined

bash

undefined

No Go required

无需安装Go

curl -fsSL https://raw.githubusercontent.com/oristides/splitwisecli/main/install.sh | sh

undefined

curl -fsSL https://raw.githubusercontent.com/oristides/splitwisecli/main/install.sh | sh

undefined

Enviroment variables setting

环境变量设置

Ask th user to execute this or ask the user this values and do it yourself or you can

bash

export SPLITWISE_CONSUMER_KEY=your_consumer_key_here
export SPLITWISE_CONSUMER_SECRET=your_consumer_secret_here
export SPLITWISE_API_KEY=your_api_key_here

可以让用户执行以下命令，或者询问用户对应取值后自行设置：

bash

export SPLITWISE_CONSUMER_KEY=your_consumer_key_here
export SPLITWISE_CONSUMER_SECRET=your_consumer_secret_here
export SPLITWISE_API_KEY=your_api_key_here

Command Reference

命令参考

Command	Purpose
`splitwisecli user me`	Current user
`splitwisecli friend list`	Friends (IDs for expenses)
`splitwisecli group list`	Groups
`splitwisecli group get 123` or `get "Trip to Japan"`	Group by ID or name
`splitwisecli balance`	All friend balances
`splitwisecli balance --friend 456`	Balance with one friend
`splitwisecli balance --group 123`	Balances in group
`splitwisecli expense list`	List expenses
`splitwisecli expense create`	Create expense
`splitwisecli expense update 789`	Update expense
`splitwisecli expense settle`	Record payment
`splitwisecli expense delete 789`	Delete expense

Global:

--json

-j

for JSON output.

命令	用途
`splitwisecli user me`	获取当前用户信息
`splitwisecli friend list`	获取好友列表（含开销所需的好友ID）
`splitwisecli group list`	获取群组列表
`splitwisecli group get 123` 或 `get "Trip to Japan"`	根据ID或名称查询群组信息
`splitwisecli balance`	查看所有好友的余额情况
`splitwisecli balance --friend 456`	查看与单个好友的余额
`splitwisecli balance --group 123`	查看群组内的余额情况
`splitwisecli expense list`	列出开销记录
`splitwisecli expense create`	创建开销记录
`splitwisecli expense update 789`	更新开销记录
`splitwisecli expense settle`	记录付款
`splitwisecli expense delete 789`	删除开销记录

全局参数：添加

--json

或

-j

可输出JSON格式结果。

Creating Expenses

创建开销

Defaults

默认规则

Paid-by: You (omit
```
--paid-by
```
= you paid). Use
```
--paid-by friend
```
or
```
--paid-by 456
```
when they paid.
Split: Equal (50/50) for friend expenses. Use
```
--split
```
for custom.

付款人：默认是你本人（省略
```
--paid-by
```
参数即代表你付的款），如果是他人付款可使用
```
--paid-by friend
```
或者
```
--paid-by 456
```
指定。
分摊规则：好友开销默认均分（50/50），可使用
```
--split
```
参数自定义分摊比例。

Friend expenses

好友间开销

bash

undefined

bash

undefined

You paid $100, split 50/50

你支付了100美元，两人均分

splitwisecli expense create --friend 456 -d "Dinner" -c 100

Custom split: percentages (must sum to 100). Cost $120 → 40%=$48, 60%=$72

自定义分摊：按比例（比例总和需为100）。总金额120美元 → 你承担40%=48美元，对方承担60%=72美元

splitwisecli expense create --friend 456 -d "Restaurant" -c 120 --split 40,60

They owe you full amount

对方全额欠你钱

splitwisecli expense create --friend 456 -d "Groceries" -c 80 --split 0,100

Friend paid — you owe them

好友付的钱 —— 你欠对方

splitwisecli expense create --friend 456 -d "Dinner" -c 100 --paid-by friend

undefined

splitwisecli expense create --friend 456 -d "Dinner" -c 100 --paid-by friend

undefined

Group expenses

群组开销

Group = ID or name:

--group 123

--group "Trip to Japan"

bash

undefined

群组可指定ID或名称：

--group 123

或

--group "Trip to Japan"

bash

undefined

You paid, split equally

你支付了费用，群组成员均分

splitwisecli expense create --group 123 -d "Movie tickets" -c 60 --equal

Specific member paid

指定群成员支付

splitwisecli expense create --group 123 -d "Dinner" -c 90 --equal --paid-by 789

---

splitwisecli expense create --group 123 -d "Dinner" -c 90 --equal --paid-by 789

---

Settling Up (Recording Payments)

结清账款（记录付款）

bash

undefined

bash

undefined

You pay friend back (default)

你给好友还钱（默认情况）

splitwisecli expense settle --friend 456 --amount 50

Friend pays you back

好友给你还钱

splitwisecli expense settle --friend 456 --amount 50 --paid-by friend

Group: who pays, who receives

群组结清：指定付款方和收款方

splitwisecli expense settle --group "Trip" --amount 100 --paid-by me --to 789

---

splitwisecli expense settle --group "Trip" --amount 100 --paid-by me --to 789

---

Updating Expenses

更新开销

Specify only fields to change:

bash

splitwisecli expense update 789 --description "Dinner at Mario's"
splitwisecli expense update 789 --cost 95
splitwisecli expense update 789 --split 40,60

仅需指定要修改的字段即可：

bash

splitwisecli expense update 789 --description "Dinner at Mario's"
splitwisecli expense update 789 --cost 95
splitwisecli expense update 789 --split 40,60

Key Flags

核心参数

Flag	Values	Notes
`--paid-by`	`me` , `friend` , or user ID	Default: you
`--split`	`myPct,friendPct` (e.g. `40,60` )	Must sum to 100
`--friend`	User ID	Friend's ID from `friend list`
`--group`	ID or name	Resolves by name
`--to`	User ID	Required with `--group` for settle

参数	取值	说明
`--paid-by`	`me` 、 `friend` 或用户ID	默认值：me
`--split`	`我的占比,好友占比` （例如 `40,60` ）	占比总和必须为100
`--friend`	用户ID	可通过 `friend list` 获取好友ID
`--group`	群组ID或名称	支持按名称匹配
`--to`	用户ID	群组结清时必填

Command Structure

命令结构

splitwisecli
├── user          # User operations
│   ├── me        # Get current user
│   └── get       # Get user by ID
├── group         # Group operations
│   ├── list      # List all groups
│   └── get       # Get group by ID or name
├── friend        # Friend operations
│   └── list      # List all friends (with IDs and balances)
├── balance       # Balance operations
│   └── (default) # Show balances (--friend, --group)
├── expense       # Expense operations
│   ├── list      # List expenses
│   ├── get       # Get expense details
│   ├── create    # Create expense (--friend or --group)
│   ├── update    # Update expense (fix mistakes)
│   ├── settle    # Record a payment / settle up
│   └── delete    # Delete expense
├── comment       # Comment operations
│   ├── list      # Get expense comments
│   └── create    # Add comment
├── notification  # Notification operations
│   └── list      # List notifications
└── other         # Utilities
    ├── currencies  # List currencies
    └── categories  # List categories

splitwisecli
├── user          # 用户相关操作
│   ├── me        # 获取当前用户信息
│   └── get       # 根据ID查询用户信息
├── group         # 群组相关操作
│   ├── list      # 列出所有群组
│   └── get       # 根据ID或名称查询群组信息
├── friend        # 好友相关操作
│   └── list      # 列出所有好友（含ID和余额）
├── balance       # 余额相关操作
│   └── (default) # 查看余额（支持--friend、--group过滤）
├── expense       # 开销相关操作
│   ├── list      # 列出开销记录
│   ├── get       # 查询开销详情
│   ├── create    # 创建开销（需指定--friend或--group）
│   ├── update    # 更新开销（修正错误）
│   ├── settle    # 记录付款/结清账款
│   └── delete    # 删除开销
├── comment       # 评论相关操作
│   ├── list      # 获取开销的评论
│   └── create    # 添加评论
├── notification  # 通知相关操作
│   └── list      # 列出通知
└── other         # 工具类功能
    ├── currencies  # 列出支持的货币
    └── categories  # 列出开销分类