Skip to content

Commit 29ae953

Browse files
author
Amram Englander
committed
Add GitHub Pages docs site with VitePress
1 parent 7ae75b3 commit 29ae953

13 files changed

Lines changed: 2513 additions & 62 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
25+
- uses: actions/setup-node@v4
26+
with:
27+
node-version: 22
28+
cache: npm
29+
30+
- run: npm ci
31+
32+
- name: Build docs
33+
run: npx vitepress build docs
34+
35+
- uses: actions/upload-pages-artifact@v3
36+
with:
37+
path: docs/.vitepress/dist
38+
39+
deploy:
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
needs: build
44+
runs-on: ubuntu-latest
45+
steps:
46+
- id: deployment
47+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ browser-profile/
2222
# Environment
2323
.env
2424
.env.local
25+
26+
# VitePress
27+
docs/.vitepress/dist/
28+
docs/.vitepress/cache/

‎docs/.vitepress/config.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
export default defineConfig({
4+
title: 'riseup-cli',
5+
description: 'Unofficial CLI for RiseUp personal finance',
6+
base: '/riseup-cli/',
7+
8+
head: [
9+
['link', { rel: 'icon', href: '/riseup-cli/logo.png' }],
10+
],
11+
12+
themeConfig: {
13+
logo: '/logo.png',
14+
15+
nav: [
16+
{ text: 'Guide', link: '/getting-started' },
17+
{ text: 'Commands', link: '/commands' },
18+
{ text: 'Claude Code Skill', link: '/claude-code-skill' },
19+
],
20+
21+
sidebar: [
22+
{
23+
text: 'Guide',
24+
items: [
25+
{ text: 'Getting Started', link: '/getting-started' },
26+
{ text: 'Commands', link: '/commands' },
27+
{ text: 'Claude Code Skill', link: '/claude-code-skill' },
28+
{ text: 'Contributing', link: '/contributing' },
29+
],
30+
},
31+
],
32+
33+
socialLinks: [
34+
{ icon: 'github', link: 'https://github.com/arsolutioner/riseup-cli' },
35+
],
36+
37+
footer: {
38+
message: 'Released under the MIT License.',
39+
copyright: 'Copyright 2026 Amram Englander',
40+
},
41+
42+
search: {
43+
provider: 'local',
44+
},
45+
},
46+
})

‎docs/.vitepress/theme/index.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import './style.css'
3+
4+
export default DefaultTheme

‎docs/.vitepress/theme/style.css‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:root {
2+
--vp-c-brand-1: #d4a017;
3+
--vp-c-brand-2: #c4950f;
4+
--vp-c-brand-3: #b38a0a;
5+
--vp-c-brand-soft: rgba(212, 160, 23, 0.14);
6+
}
7+
8+
.dark {
9+
--vp-c-brand-1: #e8b931;
10+
--vp-c-brand-2: #d4a017;
11+
--vp-c-brand-3: #c4950f;
12+
--vp-c-brand-soft: rgba(232, 185, 49, 0.16);
13+
}
14+
15+
.VPImage.image-src {
16+
max-height: 180px;
17+
}

‎docs/claude-code-skill.md‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Claude Code Skill
2+
3+
riseup-cli ships with a [Claude Code](https://claude.com/claude-code) skill so Claude can query your finances directly using natural language.
4+
5+
## Installation
6+
7+
```bash
8+
riseup skill install # Install the skill
9+
riseup skill status # Check if installed
10+
riseup skill uninstall # Remove the skill
11+
riseup skill show # Display skill content
12+
```
13+
14+
Once installed, just ask Claude:
15+
16+
- *"How much did I spend this month?"*
17+
- *"What are my subscriptions?"*
18+
- *"Show my salary for the last 3 months"*
19+
- *"Am I saving money?"*
20+
- *"How much did I spend on groceries?"*
21+
22+
## How It Works
23+
24+
The skill file is installed to `~/.claude/skills/riseup/SKILL.md`. Claude Code reads this file to understand which CLI commands to run for your finance queries. Read-only commands run automatically; `login` and `logout` require your confirmation.
25+
26+
## Common Workflows
27+
28+
### "How much did I spend this month?"
29+
30+
```bash
31+
riseup spending
32+
```
33+
34+
### "What are my subscriptions?"
35+
36+
```bash
37+
riseup transactions --json
38+
```
39+
40+
Then Claude analyzes the JSON output to find recurring merchants across months.
41+
42+
### "How much did I spend on groceries?"
43+
44+
```bash
45+
riseup spending --category "כלכלה"
46+
```
47+
48+
### "Am I saving money?"
49+
50+
```bash
51+
riseup trends 6
52+
```
53+
54+
Shows income vs expenses and net for each month.
55+
56+
### "What's my biggest expense?"
57+
58+
```bash
59+
riseup transactions --expenses --sort amount --json
60+
```
61+
62+
### Multi-month analysis
63+
64+
Fetch multiple months with `--json` and compare:
65+
66+
```bash
67+
riseup transactions 2026-01 --json
68+
riseup transactions 2026-02 --json
69+
riseup transactions current --json
70+
```
71+
72+
## Hebrew Category Reference
73+
74+
RiseUp uses Hebrew category names. Common translations:
75+
76+
| Hebrew | English |
77+
|--------|---------|
78+
| כלכלה | Groceries |
79+
| אוכל בחוץ | Eating Out |
80+
| רכב | Car/Vehicle |
81+
| העברות | Transfers |
82+
| קניות | Shopping |
83+
| כללי | General |
84+
| ביטוח | Insurance |
85+
| ארנונה | Property Tax |
86+
| שיק | Check |
87+
| תרומה | Donations |
88+
| ביגוד והנעלה | Clothing and Shoes |
89+
| תשלומים | Payments |
90+
| חשמל | Electricity |
91+
| פארמה | Pharmacy |
92+
| בריאות | Health |
93+
| דיגיטל | Digital |
94+
| תקשורת | Telecom |
95+
| תחבורה ציבורית | Public Transport |
96+
| פנאי | Leisure |
97+
| עמלות | Fees |
98+
| משכורת | Salary |
99+
| קצבאות | Benefits/Allowances |
100+
| מס הכנסה | Income Tax |
101+
| ביטוח לאומי | National Insurance |
102+
103+
## Error Reference
104+
105+
| Error | Meaning | Action |
106+
|-------|---------|--------|
107+
| "No active session" | Not logged in | Run `riseup login` |
108+
| "Session expired" | Cookies expired | Run `riseup login` |
109+
| "No budget data found" | Month too far back | Try a more recent month |
110+
| Navigation timeout | Site slow/down | Retry `riseup login` |
111+
112+
## Known Limitations
113+
114+
- Data goes back approximately 10 months (RiseUp API limitation)
115+
- Login requires a real Chrome browser (Google OAuth blocks automation)
116+
- Category names are in Hebrew (translate for English-speaking users)
117+
- Budget months may not align with calendar months (depends on cashflow start day)

‎docs/commands.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Commands
2+
3+
## spending
4+
5+
Show spending breakdown for a given month.
6+
7+
```bash
8+
riseup spending # Current month by category
9+
riseup spending prev # Previous month
10+
riseup spending --by merchant --top 10 # Top 10 merchants
11+
riseup spending --by source # By payment source (bank/card)
12+
riseup spending --category "כלכלה" # Filter one category
13+
```
14+
15+
| Flag | Description |
16+
|------|-------------|
17+
| `--by <dimension>` | Group by: `category`, `merchant`, or `source` (default: `category`) |
18+
| `--category <name>` | Filter by category name |
19+
| `--top <n>` | Show top N only |
20+
21+
## income
22+
23+
Show income summary for a given month.
24+
25+
```bash
26+
riseup income # Current month income
27+
riseup income --salary-only # Only salary entries
28+
riseup income prev # Previous month
29+
```
30+
31+
| Flag | Description |
32+
|------|-------------|
33+
| `--salary-only` | Only show salary entries |
34+
35+
## transactions
36+
37+
List all transactions with powerful filtering.
38+
39+
```bash
40+
riseup transactions # List all this month
41+
riseup transactions --search "carrefour" # Search by merchant
42+
riseup transactions --category "רכב" # Filter by category
43+
riseup transactions --expenses --sort amount # Expenses sorted by amount
44+
riseup transactions --min 500 --max 2000 # Amount range
45+
```
46+
47+
| Flag | Description |
48+
|------|-------------|
49+
| `--search <text>` | Filter by merchant name |
50+
| `--category <name>` | Filter by category |
51+
| `--min <amount>` | Minimum amount |
52+
| `--max <amount>` | Maximum amount |
53+
| `--income` | Only income transactions |
54+
| `--expenses` | Only expense transactions |
55+
| `--sort <field>` | Sort by: `date` or `amount` (default: `date`) |
56+
57+
## balance
58+
59+
Show current bank account balances across all connected accounts.
60+
61+
```bash
62+
riseup balance
63+
```
64+
65+
## debt
66+
67+
Show credit card debt at a glance.
68+
69+
```bash
70+
riseup debt
71+
```
72+
73+
## trends
74+
75+
Month-over-month comparison of income vs. expenses.
76+
77+
```bash
78+
riseup trends # 3-month comparison (income vs expenses vs net)
79+
riseup trends 6 # 6-month comparison
80+
riseup trends --by category # Breakdown by category over time
81+
```
82+
83+
| Flag | Description |
84+
|------|-------------|
85+
| `--by <dimension>` | Breakdown level: `total` or `category` (default: `total`) |
86+
87+
## plans
88+
89+
Show savings goals and progress.
90+
91+
```bash
92+
riseup plans
93+
```
94+
95+
## insights
96+
97+
Show AI-generated financial insights from RiseUp.
98+
99+
```bash
100+
riseup insights
101+
```
102+
103+
## account
104+
105+
### account banks
106+
107+
Show connected banks and cards.
108+
109+
```bash
110+
riseup account banks
111+
```
112+
113+
### account subscription
114+
115+
Show subscription details.
116+
117+
```bash
118+
riseup account subscription
119+
```
120+
121+
## login / logout / status
122+
123+
Authentication commands.
124+
125+
```bash
126+
riseup login # Opens Chrome for Google OAuth sign-in
127+
riseup logout # Clear session
128+
riseup status # Show login status and account info
129+
```
130+
131+
See [Getting Started](/getting-started#authentication) for more details on authentication.

0 commit comments

Comments
 (0)