Monarch Money

用于Monarch Money预算自动化的CLI和TypeScript库。

先决条件

环境变量（必需）

获取您的MFA密钥

Monarch Money要求使用MFA。请生成TOTP密钥：

1. 登录https://app.monarchmoney.com
2. 前往设置 > 安全 > 双重认证
3. 如果MFA已启用：请先禁用，然后重新启用以获取新的密钥
4. 当显示二维码时：点击“无法扫描？查看设置密钥”
5. 复制密钥（base32字符串，例如JBSWY3DPEHPK3PXP）
6. 使用验证器应用在Monarch Money中完成MFA设置
7. 设置密钥：export MONARCH_MFA_SECRET="你的密钥"

快速开始

# Check setup
monarch-money doctor

# Login (uses env vars by default)
monarch-money auth login

# List transactions
monarch-money tx list --limit 10

# List categories
monarch-money cat list

CLI命令

身份验证

# Login with environment variables
monarch-money auth login

# Login with explicit credentials
monarch-money auth login -e email@example.com -p password --mfa-secret SECRET

# Check auth status
monarch-money auth status

# Logout
monarch-money auth logout

交易

# List recent transactions
monarch-money tx list --limit 20

# Search by date
monarch-money tx list --start-date 2026-01-01 --end-date 2026-01-31

# Search by merchant
monarch-money tx list --merchant "Walmart"

# Get transaction by ID
monarch-money tx get <transaction_id>

# Update category
monarch-money tx update <id> --category <category_id>

# Update merchant name
monarch-money tx update <id> --merchant "New Name"

# Add notes
monarch-money tx update <id> --notes "My notes here"

类别

# List all categories
monarch-money cat list

# List with IDs (for updates)
monarch-money cat list --show-ids

账户

# List accounts
monarch-money acc list

# Show account details
monarch-money acc get <account_id>

诊断（Doctor）

# Run diagnostic checks
monarch-money doctor

检查项：

• 环境变量设置
• API连接性
• 会话有效性
• Node.js版本

库使用

直接导入并使用TypeScript库：

import { MonarchClient } from 'monarch-money';

const client = new MonarchClient({ baseURL: 'https://api.monarch.com' });

// Login
await client.login({
  email: process.env.MONARCH_EMAIL,
  password: process.env.MONARCH_PASSWORD,
  mfaSecretKey: process.env.MONARCH_MFA_SECRET
});

// Get transactions
const transactions = await client.transactions.getTransactions({ limit: 10 });

// Get categories
const categories = await client.categories.getCategories();

// Get accounts
const accounts = await client.accounts.getAll();

常见工作流程

查找并更新交易

# 1. Find the transaction
monarch-money tx list --date 2026-01-15 --merchant "Target"

# 2. Get category ID
monarch-money cat list --show-ids

# 3. Update the transaction
monarch-money tx update <transaction_id> --category <category_id>

按日期范围搜索交易记录

monarch-money tx list --start-date 2026-01-01 --end-date 2026-01-31 --limit 100

检查预算状态

monarch-money acc list

错误处理

会话管理

会话会本地缓存于~/.mm/session.json。首次登录后，后续命令会复用已保存的会话以加速执行。

如需清除会话：monarch-money auth logout

参考文献

• API.md- GraphQL API 详情与高级用法
• 故障排除.md- 常见问题及其解决方案